add note about sync behavior family #49
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arjitj2
reviewed
Mar 20, 2024
awesomenix
approved these changes
Mar 20, 2024
arjitj2
reviewed
Mar 22, 2024
basics/developers/gitlink.md
Outdated
| @@ -308,3 +308,4 @@ Please refer to this section on the different parameters and their values a sync | |||
| * `should_send_recovery` - (Type: Boolean) Indicate if you would like an email when the sync recovers from the alert type. | |||
| * `options` - (Type: Object) Properties specific to the alert type. One example below, these will differ by type. | |||
| * `threshold` - (Optional, Type: Integer) The percentage of records that need to fail to send a record failing notification. Possible values are `0` - `100`. | |||
| * `sync_behavior_family` - (Optional, Type: String) The behavior of how the sync treats records. Either `activateEvents` - Take action in the destination when new data is added to the source dataset, or, `mappedRecords` - Replicate changes from the source dataset to the destination | |||
There was a problem hiding this comment.
can you plz add some details as to why it's Optional, and what activateEvents, mappedRecords, or null do differently?
and if it only applies for some kinds of syncs, can you add when it should be specified?
I'm a dev reading this and I don't get it atm :/
There was a problem hiding this comment.
for sure!
There was a problem hiding this comment.
added some more context, let me know if it reads better!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adds sync_behavior_family to the list of gitlink sync attributes