DOC-13299: Migrate Query REST APIs to dev repo#174
Merged
Conversation
simon-dew
added a commit
that referenced
this pull request
Aug 19, 2025
* Add support for extended descriptions * Add support for additional property names * Update Query specs with extended descriptions * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
simon-dew
added a commit
that referenced
this pull request
Aug 19, 2025
* Add support for extended descriptions * Add support for additional property names * Update Query specs with extended descriptions * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
simon-dew
added a commit
that referenced
this pull request
Sep 10, 2025
* Add support for extended descriptions * Add support for additional property names * Update Query specs with extended descriptions * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
dgnicholson
pushed a commit
that referenced
this pull request
Oct 21, 2025
* Add support for extended descriptions * Add support for additional property names * Update Query specs with extended descriptions * Build output documentation --------- Co-authored-by: tech-comm-team-couchbase <tech-comm-team@couchbase.com>
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
2 participants
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.
Docs ticket: DOC-13299
Fix OpenAPI spec issues before migrating to https://github.com/couchbase/query
The main purpose of this PR is to deal with the descriptions of query parameters which have equivalent settings at request-level, node-level, or cluster-level. Node-level and cluster-level parameters are not currently available via the Management REST API and should currently remain undocumented for the Data API. I've therefore moved any descriptions of or links to equivalent settings at other levels out of the
descriptionfield and into thex-desc-morevendor extension. This means Redocly won't see it, and it won't be published in the Data API docs.This PR also configures OpenAPI generator so that it can see the
x-desc-morevendor extension, and add it to the parameter description. So the parameter descriptions in the static Server docs will see descriptions of and links to equivalent settings at node-level and cluster-level.