OpenAPI docs for new sync endpoints #197
Merged
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
Adds OpenAPI docs for the following 4 endpoints: - /bucket/:bucketId/sync - /object/:objectId/sync - /sync/ - /sync/status
Coverage Report
|
jujaga
reviewed
Aug 16, 2023
norrisng-bc
force-pushed
the
openapi-docs
branch
4 times, most recently
from
1275b95 to
c715fad
Compare
jujaga
approved these changes
Aug 17, 2023
Cleanup TODO comments Minor text formatting changes (capitalization and punctuation) Cleanup YAML indentation and line breaks
The following endpoints previously mentioned an internal queue; this mention has been removed: - GET /bucket/:bucketId/sync - GET /object/:objectId/sync - GET /sync/ Instead, mention that how long it takes to eventually sync depends on how many objects are waiting to be synced.
Replace incorrect sync endpoint references to Query-Public with Query-Full, and add description for said parameter
As previously discussed, all mentions of "queue" should be removed for abstraction purposes. This particular mention was accidentally left out.
norrisng-bc
force-pushed
the
openapi-docs
branch
from
c715fad to
af0089c
Compare
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.
Description
This adds OpenAPI documentation for the new sync endpoints:
GET /bucket/:bucketId/syncGET /object/:objectId/syncGET /sync/GET /sync/statusA new section on these endpoints has also been added to the "Endpoint Notes" wiki page. The sync stuff isn't in
masteryet, so I've added "available in COMS v0.7+" to make that clear:https://github.com/bcgov/common-object-management-service/wiki/Endpoint-Notes#sync
Jira ticket:
https://apps.nrs.gov.bc.ca/int/jira/browse/SHOWCASE-3305
Types of changes
Documentation (non-breaking change with enhancements to documentation)
Checklist
Further comments
N/A