DOC-14304-Update-XDCR-REST-API-docs-to-return-404#4119
Open
supritha-kumar wants to merge 4 commits into
Open
Conversation
supritha-kumar
changed the title
There was a problem hiding this comment.
Pull request overview
Updates XDCR REST API documentation to reflect 404 Object Not Found responses (instead of 400 Bad Request) when XDCR resources are missing, aligning the documented behavior with DOC-14304.
Changes:
- Update “delete replication” docs to document
404 Object Not Foundfor an invalidreplication_id, including the updated error body format. - Update “advanced settings” docs to document
404 Object Not Foundfor an invalidsettings_URI, including the updated error body format. - Add a
404 Object Not Foundresponse case for deleting a non-existent remote cluster reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| modules/rest-api/pages/rest-xdcr-delete-replication.adoc | Documents 404 Object Not Found (and updated error body) for invalid replication_id on delete replication. |
| modules/rest-api/pages/rest-xdcr-delete-ref.adoc | Adds a documented 404 Object Not Found case when deleting a reference for a non-existent target cluster name. |
| modules/rest-api/pages/rest-xdcr-adv-settings.adoc | Documents 404 Object Not Found (and updated error body) for invalid settings_URI and fixes formatting in “See Also”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| An improperly specified URI returns `405 Method Not Allowed`. | ||
| Failure to authenticate returns `401 Unauthorized`. | ||
| Attempt to delete a reference to a cluster name that doesn't exist returns `404 Object Not Found`. |
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
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.
https://jira.issues.couchbase.com/browse/DOC-14304