docs(api): add Usage API reference - #495
Open
sbezludny wants to merge 5 commits into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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.
Affected components
Notes for the reviewer
This PR adds Usage to the API Reference, after Runtimes. It includes pages for terms, summary, and series, plus a short overview of authentication, dates, filters, metrics, and pagination.
The public reference selects usage terms by date and does not expose
usageTermsId.It also adds the Usage mapping to the endpoint generator and updates the checked-in OpenAPI file and sitemap.
Backend PR: https://github.com/checkly/monorepo/pull/4054
Release order
Merge this after the backend PR reaches production. The docs sync reads the production OpenAPI document and will remove these routes if they are not there yet.
Validation
npx mint openapi-check api-reference/openapi.jsonpython3 .github/scripts/check_frontmatter.py, 697 MDX filesDRY_RUN=1 node .github/scripts/detect-new-endpoints.mjs, all 160 spec paths accounted fornpx mint broken-linksnpm run generate-sitemap, 635 URLsI compared the checked-in spec with the base version. Only the Usage routes and schemas changed.
New dependency submission
None.
Screenshots
Not included. This PR adds reference pages and navigation, with no custom UI.