Repository navigation
docs(usage): update public API and MCP guides for v2 - #583
Merged
Merged
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
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.
The public Usage API overview and MCP tool descriptions still teach V1 behavior. Make V2 the primary path and document the current filters, credits, measurements, projections, and pagination.
Add deprecation warnings and replacement links to all three V1 endpoint pages. Put V2 first in navigation and synchronize the usage OpenAPI definitions. Fix internal-link validation to recognize API pages generated from navigation while continuing to reject missing destinations.
Affected Components
Notes for the Reviewer
Companion backend PR: https://github.com/checkly/monorepo/pull/5000.
Publish the OpenAPI copy after the companion backend deprecation metadata is deployed. The scheduled schema refresh reads production and can otherwise propose removing the three V1 flags. The authored warnings remain visible independently of those flags.
Testing
New Dependency Submission
Declare
@mintlify/link-rot3.0.803 directly for the link-check wrapper. This version already exists transitively through the pinned Mintlify CLI; the lockfile adds only the root dependency declaration. The wrapper uses the existing navigation resolver for generated destinations.