Skip to content

Document the openapi slug option for operationId-based page URLs - #8398

Draft
brandonmcconnell wants to merge 1 commit into
mainfrom
cursor/openapi-slug-option-920e
Draft

brandonmcconnell wants to merge 1 commit into
mainfrom
cursor/openapi-slug-option-920e

Conversation

@brandonmcconnell

Copy link
Copy Markdown
Contributor

Documentation changes

Documents the new slug field on OpenAPI config entries shipped in mintlify/mint#14686. Hold until that PR merges.

  • api-playground/openapi-setup.mdx: new "Derive page slugs from operation IDs" subsection after the directory note under Dedicated API sections, with a config example, the fallback rule (no operationId → summary), and a warning to add redirects when enabling it on an existing site. Cross-reference added from the x-mint: href section.
  • mint-instructions/api-docs.mdx: agent-facing summary bullet and config example updated to mention slug: "operationId".

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts
  • Content follows the style guide

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful
Open in Web Open in Cursor 

@mintlify

mintlify Bot commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
Mintlify Docs 🟢 Ready View Preview Nov 10, 2026, 11:48 PM

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

This branch was successfully deployed

1 active deployment
staging — 1831b94f Deployed Nov 10, 2026 by mintlify[bot]
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