Skip to content

Blocked: Add Runpod docs API catalog - #790

Draft
danstotts-ops wants to merge 1 commit into
mainfrom
agent/fix-docs-api-catalog
Draft

Blocked: Add Runpod docs API catalog#790
danstotts-ops wants to merge 1 commit into
mainfrom
agent/fix-docs-api-catalog

Conversation

@danstotts-ops

@danstotts-ops danstotts-ops commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Status

Blocked on Mintlify reserved-route behavior. Keep this PR in draft and do not merge.

What changed

  • Added a standards-shaped API Linkset at /api-catalog.json.
  • Added a permanent Mintlify redirect from /.well-known/api-catalog to the supported JSON asset.
  • Added a validator for HTTPS anchors, discovery relations, and the exact redirect.
  • Added the validator to the existing required PR workflow.

Why

docs.runpod.io advertises /.well-known/api-catalog in 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.
  • Mintlify ignores the docs.json redirect for this reserved .well-known path.
  • Mintlify Deployment and repository CI passed, confirming this is a serving-layer limitation rather than a build failure.

Required resolution

Mintlify must provide a supported reserved-route mapping or remove the broken api-catalog relation 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.py
  • node scripts/validate-tooltips.js
  • npx -y mint@4.2.804 validate
  • jq empty docs.json
  • jq empty api-catalog.json
  • git diff --check
  • Hosted preview GET and HEAD checks described above

@mintlify

mintlify Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Aug 14, 2026, 9:52 PM

@danstotts-ops danstotts-ops changed the title Add Runpod docs API catalog Blocked: Add Runpod docs API catalog Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant