-
Notifications
You must be signed in to change notification settings - Fork 138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CBG-4312 improve metrics documentation #7309
Merged
Conversation
This file contains 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
- remove /_metrics endpoint, which does not need public API documentation, as it never should have been implemented - change copy to match public docs for description - add links to upstream files
Redocly previews |
bbrks
reviewed
Jan 20, 2025
simon-dew
requested changes
Jan 27, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like you have incorporated almost all of the changes from couchbase/docs-sync-gateway#839 👍
I have a couple of comments though:
bbrks
approved these changes
Jan 31, 2025
simon-dew
approved these changes
Jan 31, 2025
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.
CBG-4312
This upstreams changes done in https://github.com/couchbase/docs-sync-gateway/pull/839/files
@simon-dew, I did not make the same changes in the files https://github.com/couchbase/sync_gateway/blob/main/docs/api/metric-capella.yaml and https://github.com/couchbase/sync_gateway/blob/main/docs/api/admin-capella.yaml . I am happy to make the corresponding changes in these files or we can wait until you figure out what the appropriate
externalDocs
sections are.Can you verify that I ported all the changes? I did not port the line
/_metrics
because I think it is wrong, we can wait until https://github.com/couchbase/docs-sync-gateway/pull/839/files is resolved.Pre-review checklist
fmt.Print
,log.Print
, ...)base.UD(docID)
,base.MD(dbName)
)docs/api