AV-103170: Document Query REST API passthrough operations #386
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
simon-dew
commented
Jul 31, 2025
There was a problem hiding this comment.
This example file was updated but does not appear in the published docs
simon-dew
commented
Jul 31, 2025
There was a problem hiding this comment.
This example file was updated but does not appear in the published docs
simon-dew
commented
Jul 31, 2025
There was a problem hiding this comment.
This partial was updated but does not appear in the published docs
simon-dew
commented
Jul 31, 2025
There was a problem hiding this comment.
This page was updated, but references to the Data API are hidden behind the feature flag. Instead, a note is displayed in the published documentation saying that Couchbase Transactions are not supported via the Data API.
simon-dew
force-pushed
the
AV-103170-query-api
branch
from
1756bb4 to
fbdca84
Compare
simon-dew
force-pushed
the
AV-103170-query-api
branch
from
fbdca84 to
9ea18a1
Compare
rakhi-prathap
approved these changes
Oct 9, 2025
Comment on lines
+363
to
+365
| //// | ||
| use the {console-indexes}[Indexes page in the Capella UI] or | ||
| //// |
There was a problem hiding this comment.
Suggested change
| //// | |
| use the {console-indexes}[Indexes page in the Capella UI] or | |
| //// | |
| // use the {console-indexes}[Indexes page in the Capella UI] or |
The block comment (//// .. ////) seems to be adding extra space in the rendered output.
Can we change it to a line comment (//) instead so the formatting stays intact?
| == Related Links | ||
|
|
||
| * An overview of scopes and collections is provided in {scopes-and-collections}[Scopes and Collections]. | ||
| * An overview of scopes and collections is provided in {scopes-and-collections}[]. |
There was a problem hiding this comment.
Suggested change
| * An overview of scopes and collections is provided in {scopes-and-collections}[]. | |
| * For an overview of scopes and collections, see {scopes-and-collections}[]. |
| * An overview of scopes and collections is provided in {scopes-and-collections}[]. | ||
|
|
||
| * Step-by-step procedures for management are provided in {manage-scopes-and-collections}[Manage Scopes and Collections]. | ||
| * Step-by-step procedures for management are provided in {manage-scopes-and-collections}[]. |
There was a problem hiding this comment.
Suggested change
| * Step-by-step procedures for management are provided in {manage-scopes-and-collections}[]. | |
| * For step-by-step procedures for management, see {manage-scopes-and-collections}[]. |
| * Step-by-step procedures for management are provided in {manage-scopes-and-collections}[]. | ||
|
|
||
| * Refer to {scopes-and-collections-api}[Scopes and Collections API] to manage scopes and collections with the REST API. | ||
| * Refer to {scopes-and-collections-api}[Buckets, Scopes, and Collections] to manage scopes and collections with the Management API. |
There was a problem hiding this comment.
Suggested change
| * Refer to {scopes-and-collections-api}[Buckets, Scopes, and Collections] to manage scopes and collections with the Management API. | |
| * To manage scopes and collections with the Management API, see {scopes-and-collections-api}[Buckets, Scopes, and Collections]. |
| * Refer to {scopes-and-collections-api}[Buckets, Scopes, and Collections] to manage scopes and collections with the Management API. | ||
|
|
||
| * Refer to the reference page for the {couchbase-cli-collection-manage}[collection-manage] command to manage scopes and collections with the CLI. | ||
| * Refer to the {couchbase-cli-collection-manage}[Couchbase Shell Documentation] to manage scopes and collections with the Couchbase Shell. |
There was a problem hiding this comment.
Suggested change
| * Refer to the {couchbase-cli-collection-manage}[Couchbase Shell Documentation] to manage scopes and collections with the Couchbase Shell. | |
| * To manage scopes and collections with the Couchbase Shell, see {couchbase-cli-collection-manage}[Couchbase Shell Documentation]. |
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.
Docs issue: AV-103170
This PR adds Data API references and examples to the Capella Developer docs, in most of the places where the Server Developer docs have Query REST API references and examples.
It does not include Data API references or examples in the "SQL++ Support for Couchbase Transactions" docs. Also, any Query Admin REST API references and examples are still hidden behind feature flags.
Additionally this PR fixes many links in the Capella Developer docs to point to Capella locations rather than Server. That's why there are so many files changed.
Docs preview (major updates only):
Credentials: Preview docs for internal review
This PR must be merged at the same time as: