DOC-14186: Public spec for the Sync Gateway REST APIs#963
Merged
Conversation
openapitools config in root
This reverts commit 05c7390.
Contributor
Author
|
@osfameron Another pull request the Sync Gateway REST APIs, because Sync Gateway 3.3 was when we split the documentation into multiple modules. In merging #962 forward to release 3.3, I've rearranged the partials and attachments to fit in with the new module structure. I wanted to get some eyes on this commit to make sure I haven't messed anything up. Hopefully this should be the last PR for LLM readiness. I'm hoping I can merge this forward to 4.0 / 4.1 without needing any more PRs. |
osfameron
approved these changes
Apr 2, 2026
simon-dew
added a commit
that referenced
this pull request
Apr 2, 2026
* Remove legacy OpenAPI specs * Remove unused models * Move overlays to attachments * Move bundles to hidden bld directory * Move overlaid specs to attachments * Add service-desc attributes * Update configuration schema template blocks * Remove adoc yaml parser * Remove links to client app page * Move Prometheus metrics source file to partials dir * Add metrics metadata schema file to attachments * Move generated HTML partials to REST API module * Update redocly theme * Update generate docs script * Update preview config * Rebuild output docs — includes 4.0.1 backport
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 issue: DOC-14186
For LLM readiness, this PR adds service description metadata to the REST API reference pages for Sync Gateway.
Document previews — check the page source for
service-descmetadata:You will need the Docs Team credentials on Confluence.