CBG-4776: Fetch by CV REST API #7694
Merged
Conversation
This file contains hidden or 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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enables CV (Current Version) support in the REST API's GET document endpoints, extending the existing capability to fetch documents by both RevTree ID and CV values. The changes ensure that when users request a document with a CV parameter, the response includes appropriate CV-based ETags for optimistic concurrency control.
- Updates GET document handlers to support CV values in the
revquery parameter - Modifies ETag generation to return CV-based ETags when CV is requested
- Updates OpenAPI documentation to reflect CV support in GET endpoints
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| rest/doc_api.go | Core handler changes to support CV in GET requests and generate appropriate ETags |
| rest/utilities_testing_resttester.go | Test utility updates to handle CV in document fetching and cleanup of deprecated methods |
| rest/attachment_test.go | Test fixes to handle CV/RevTree ID differences in revision backup behavior |
| docs/api/paths/public/keyspace-docid.yaml | Updated OpenAPI spec for ETag description to include CV |
| docs/api/components/parameters.yaml | Updated parameter documentation to include CV support |
| db/crud.go | Parameter naming cleanup and documentation update |
torcolvin
previously approved these changes
Aug 21, 2025
1 task
…ter.GetDocVersion for general test coverage.
Redocly previews |
torcolvin
approved these changes
Aug 21, 2025
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.
CBG-4776
This was already implemented, so this is a tiny clean-up exercise and ensuring there's general test coverage of CV in GETs via
RestTester.GetDocVersionThe few test changes that had to be made were small corner-cases that only work in RevTree fetches - we don't take old revision backups in exactly the same way for CV so the test assumptions didn't hold up when using CV instead of RevTreeID.
Dependencies
Integration Tests
GSI=true,xattrs=truehttps://jenkins.sgwdev.com/job/SyncGatewayIntegration/0000/