Skip to content

Conversation

@simon-dew
Copy link
Contributor

@simon-dew simon-dew commented May 7, 2024

Docs issue: DOC-10865

In the Server docs, the descriptions of the request-level settings are taken automatically from the Query Service REST API reference. I am assuming that, ultimately, the descriptions of request-level settings for Capella will be automatically generated from the Data API reference. However, the Data API is still in development.

As a temporary measure, this PR adds a cut-down version of the Query Service REST API to the (hitherto unused) capella branch of the cb-swagger docs, purely so that it can be used to generate descriptions of request-level settings for Capella.

⚠️ This change must be merged at the same time as the following related PRs:

Copy link
Collaborator

@osfameron osfameron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine. Please can you also add to -staging if not already there?

@simon-dew simon-dew merged commit 686160f into couchbase:master May 8, 2024
@simon-dew simon-dew deleted the DOC-10865-main branch May 8, 2024 12:14
simon-dew added a commit to simon-dew/docs-site that referenced this pull request May 8, 2024
@simon-dew
Copy link
Contributor Author

This looks fine. Please can you also add to -staging if not already there?

It's taken me this long to realise that the staging playbook is now in this branch! Looks like the staging playbook already includes the capella branch for the cb-swagger repo.

@osfameron
Copy link
Collaborator

Fab, thanks!

simon-dew added a commit to simon-dew/docs-site that referenced this pull request Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants