Deprecate legacy Swagger spec in API docs#310
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
What changed
https://api.checklyhq.com/openapi.jsonas the current Checkly Public API specification.https://api.checklyhq.com/swagger.jsonas deprecated and no longer updated.descriptionfrontmatter while touching the page.Why
openapi.jsonis the up-to-date public API contract. The legacy Swagger 2.0 specification remains available for now, but should not be used for client generation or latest contract inspection going forward.Validation
git diff --checkjq -e '.navigation.tabs[] | select(.tab == "API Reference")' docs.jsonnpx mint broken-linkscurrently fails on existing repo-wide broken links unrelated to this one-file change; this PR does not add internal links.