Blocked: Add Runpod docs API catalog - #790
Draft
danstotts-ops wants to merge 1 commit into
Draft
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.
Status
Blocked on Mintlify reserved-route behavior. Keep this PR in draft and do not merge.
What changed
/api-catalog.json./.well-known/api-catalogto the supported JSON asset.Why
docs.runpod.ioadvertises/.well-known/api-catalogin its discovery Link header, but the endpoint currently returns 404. Mintlify ignores repository files placed directly under.well-known, so this PR tested whether an extensionless reserved route could redirect to a supported root JSON asset.Hosted preview result
Preview:
https://runpod-b18f5ded-agent-fix-docs-api-catalog.mintlify.site/api-catalog.json:200 application/json, valid two-entry Linkset./.well-known/api-catalog:404 text/plain, on both GET and HEAD.docs.jsonredirect for this reserved.well-knownpath.Required resolution
Mintlify must provide a supported reserved-route mapping or remove the broken
api-catalogrelation from its generated Link response header. Do not merge this PR until the hosted preview returns a non-404 response at/.well-known/api-catalog.Validation
python3 scripts/validate-api-catalog.pynode scripts/validate-tooltips.jsnpx -y mint@4.2.804 validatejq empty docs.jsonjq empty api-catalog.jsongit diff --check