Repository navigation
Document the openapi slug option for operationId-based page URLs - #8398
Draft
brandonmcconnell wants to merge 1 commit into
Draft
brandonmcconnell wants to merge 1 commit into
brandonmcconnell wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
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.
Documentation changes
Documents the new
slugfield 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 thedirectorynote under Dedicated API sections, with a config example, the fallback rule (nooperationId→summary), and a warning to add redirects when enabling it on an existing site. Cross-reference added from thex-mint: hrefsection.mint-instructions/api-docs.mdx: agent-facing summary bullet and config example updated to mentionslug: "operationId".Closes
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience