Skip to content
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
merged 4 commits into from
Jan 31, 2025
Merged

CBG-4312 improve metrics documentation #7309

merged 4 commits into from
Jan 31, 2025

Conversation

torcolvin
Copy link
Collaborator

@torcolvin torcolvin commented Jan 20, 2025

CBG-4312

  • 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

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.

          application/json:
            schema:
              $ref: metrics_metadata.json

Pre-review checklist

  • Removed debug logging (fmt.Print, log.Print, ...)
  • Logging sensitive data? Make sure it's tagged (e.g. base.UD(docID), base.MD(dbName))
  • Updated relevant information in the API specifications (such as endpoint descriptions, schemas, ...) in docs/api

- 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
Copy link

github-actions bot commented Jan 20, 2025

Redocly previews

@torcolvin torcolvin requested a review from simon-dew January 27, 2025 16:25
Copy link

@simon-dew simon-dew left a 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:

@torcolvin torcolvin merged commit a74dad8 into main Jan 31, 2025
43 checks passed
@torcolvin torcolvin deleted the CBG-4312 branch January 31, 2025 17:59
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.

4 participants