Skip to content

docs: add downloadApiSpec contextual menu option#6024

Merged
ethanpalm merged 7 commits into
mainfrom
docs/download-api-spec-contextual-option
May 29, 2026
Merged

docs: add downloadApiSpec contextual menu option#6024
ethanpalm merged 7 commits into
mainfrom
docs/download-api-spec-contextual-option

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 28, 2026

Summary

Document the new downloadApiSpec contextual menu option that lets users download a deployment's OpenAPI spec (or a zipped bundle when multiple specs exist) directly from the page context menu.

Changes

  • Add a "Download API spec" row to the menu options table in ai/contextual-menu.mdx.
  • Include downloadApiSpec in the example contextual.options array.
  • Update docs.json to use the new downloadApiSpec identifier.

Context

  • mintlify/mint#7960 — adds downloadApiSpec to the page context menu
  • mintlify/mint#7968 — adds downloadApiSpec to the contextual options validation enum
  • mintlify/server#5530 — adds the server-side endpoint that fetches and zips the spec(s)

Note

Low Risk
Documentation-only changes to contextual menu MDX; no runtime or security logic in this diff.

Overview
Documents the new Download API spec contextual menu option so readers can enable downloading a deployment’s OpenAPI spec (or a zip when multiple specs exist) from the page menu.

Updates ai/contextual-menu.mdx with a menu table row and adds download-spec to the sample contextual.options JSON. Spanish and French (es/, fr/) get the same option plus a <Note> on API-reference-only visibility (api / openapi / asyncapi frontmatter) and authenticated-only downloads when auth is enabled; those locales use the identifier downloadApiSpec in examples, which differs from the English download-spec used elsewhere in this repo (e.g. openapi-setup.mdx, docs.json).

Reviewed by Cursor Bugbot for commit b6b4943. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 28, 2026

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

Project Status Preview Updated (UTC)
mintlify 🔴 Failed May 28, 2026, 8:20 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 28, 2026

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

Project Status Preview Updated (UTC)
testsignup415 🔴 Failed May 28, 2026, 8:23 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread ai/contextual-menu.mdx Outdated
Comment thread ai/contextual-menu.mdx Outdated
Comment thread ai/contextual-menu.mdx Outdated
Comment thread docs.json Outdated
@ethanpalm ethanpalm merged commit dac7025 into main May 29, 2026
6 checks passed
@ethanpalm ethanpalm deleted the docs/download-api-spec-contextual-option branch May 29, 2026 17:53
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.

2 participants