Skip to content

Commit 8b89333

Browse files
Document x-group extension and MCP skill resources (#5299)
* Document x-group extension and MCP skill resources Generated-By: mintlify-agent * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent 3a0dfd6 commit 8b89333

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

api-playground/openapi-setup.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,34 @@ Set the URL of the autogenerated endpoint page using `x-mint: href`. When `x-min
259259
}
260260
```
261261

262+
### Group display names
263+
264+
Set a custom display name for a tag's navigation group using the `x-group` extension on a tag object. By default, Mintlify uses the tag `name` as both the navigation group label and the URL path segment. The `x-group` extension overrides the group label while keeping the tag name for the URL.
265+
266+
This is useful when you want a human-readable group name that differs from the tag used in your API paths.
267+
268+
```json {4-9}
269+
{
270+
"tags": [
271+
{
272+
"name": "user-management",
273+
"description": "Endpoints for managing users",
274+
"x-group": "User Management"
275+
}
276+
],
277+
"paths": {
278+
"/users": {
279+
"get": {
280+
"tags": ["user-management"],
281+
"summary": "List users"
282+
}
283+
}
284+
}
285+
}
286+
```
287+
288+
In this example, the navigation group displays as "User Management" but the generated page URL still uses the `user-management` tag name as its path segment.
289+
262290
## Auto-populate API pages
263291

264292
Add an `openapi` field to any navigation element in your `docs.json` to automatically generate pages for OpenAPI endpoints. You can control where these pages appear in your navigation structure, as dedicated API sections or with other pages.

0 commit comments

Comments
 (0)