Correct diagnostic API routes leading underscore #7988
Merged
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
Redocly previews |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the diagnostic API route paths to include a leading underscore, aligning them with Sync Gateway's API design conventions and the actual implementation.
Changes:
- Updated three diagnostic API endpoint paths to include leading underscores
- Improved documentation descriptions for the sync function and import filter endpoints
- Minor formatting corrections in markdown tables
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/api/diagnostic.yaml | Updated three diagnostic endpoint paths to include leading underscores: /_sync, /_import_filter, and /_all_channels |
| docs/api/paths/diagnostic/keyspace-sync.yaml | Improved summary and description for the sync function dry-run endpoint |
| docs/api/paths/diagnostic/keyspace-import_filter.yaml | Improved summary and description for the import filter dry-run endpoint, plus table formatting fix |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
6 tasks
RIT3shSapata
pushed a commit
that referenced
this pull request
Jan 21, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
RIT3shSapata
pushed a commit
that referenced
this pull request
Jan 21, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Ensures the diagnostic paths have a leading underscore (matching the implementation and general SG API design)
Integration Tests