Skip to content

CBG-4849: updates to api docs for ISGR#7772

Merged
gregns1 merged 4 commits intomainfrom
CBG-4849
Sep 23, 2025
Merged

CBG-4849: updates to api docs for ISGR#7772
gregns1 merged 4 commits intomainfrom
CBG-4849

Conversation

@gregns1
Copy link
Contributor

@gregns1 gregns1 commented Sep 22, 2025

CBG-4849

  • Details the new default policy
  • Note to remove the _rev and _cv properties for doc merges.

Pre-review checklist

  • Removed debug logging (fmt.Print, log.Print, ...)
  • Logging sensitive data? Make sure it's tagged (e.g. base.UD(docID), base.MD(dbName))
  • Updated relevant information in the API specifications (such as endpoint descriptions, schemas, ...) in docs/api

Dependencies (if applicable)

  • Link upstream PRs
  • Update Go module dependencies when merged

Integration Tests

Copilot AI review requested due to automatic review settings September 22, 2025 15:08
@github-actions
Copy link

github-actions bot commented Sep 22, 2025

Redocly previews

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the API documentation for Inter-Sync Gateway Replication (ISGR) to reflect changes in Sync Gateway 4.x, specifically updating the default conflict resolution policy and adding guidance for document merges.

Key changes:

  • Updates default conflict resolution policy documentation to distinguish between pre-4.x and 4.x+ behavior
  • Adds note about excluding _rev and _cv properties when performing document merges in custom conflict resolvers

gregns1 and others added 2 commits September 22, 2025 16:10
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Collaborator

@torcolvin torcolvin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we ever explain in the public documentation what _rev and _cv are in the custom conflict resolver section? I can see that we don't because it's hard to know how you would use them, but are they visible to users who might want to do something like custom merge if there is a flag, or LWW otherwise?

What happens if you include _rev or _cv? Does ISGR reject this document?

@gregns1 gregns1 merged commit e67f6dc into main Sep 23, 2025
47 checks passed
@gregns1 gregns1 deleted the CBG-4849 branch September 23, 2025 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants