Fix Scan API 404 and consolidate endpoint navigation#709
Draft
8bitpal wants to merge 2 commits into
Draft
Conversation
- Add 'common' tag definition to scan.yaml so /readyz, /livez, /status,
/version generate pages at /reference/splice-scan-api/common/{path}
- Remove explicit 71-entry pages list from docs.json Scan API block;
Mintlify now auto-generates nav from spec tags, giving a grouped view
instead of a flat list of individual endpoint entries
- Update description on the Splice APIs card in api-reference.mdx
- Clarify tag structure in splice-scan-openapi.mdx
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.
Summary
Fixes the broken
/reference/splice-scan-api/common/readyzlink and consolidates the Scan API navigation.Changes
openapi/splice/scan/scan.yaml— adds the missingcommontag definition:/readyz,/livez,/status,/versionwere already taggedcommonin the paths, butcommonwas absent from the top-leveltagsarray/reference/splice-scan-api/common/readyzdocs-main/docs.json— removes the 71-entry explicitpageslist from the Scan API nav block:common,external,internal,deprecated,pre-alpha)pagesoverride, Mintlify auto-generates the sidebar from those tags — giving a grouped, browsable view rather than a flat alphabetical listapi-reference.mdx/splice-scan-openapi.mdx— minor description and clarity updates to those two pages.Closes #698