Document x-group extension for tag group names#5274
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Document x-group extension for tag group names#5274mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
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.
Summary
x-groupextension for OpenAPI tag definitions, which lets users set custom display names for navigation groups without changing URL pathsTriggered by mintlify/mint@3a099d71, which shipped support for
x-groupon OpenAPI tags. This extension resolves the display name for navigation group headings by checkingx-groupfirst, then falling back to the tag name.Note
Low Risk
Low risk documentation-only change that adds guidance for a new OpenAPI extension; no runtime or API behavior changes in this repo.
Overview
Adds documentation to
api-playground/openapi-setup.mdxdescribing thex-groupOpenAPI tag extension to customize sidebar/navigation group headings without changing tag names or URL structure, including a JSON example and fallback behavior whenx-groupis omitted.Reviewed by Cursor Bugbot for commit fdc423b. Bugbot is set up for automated code reviews on this repo. Configure here.