Skip to content

docs: add openapi slug option to the agent skill #8400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: add openapi slug option to the agent skill #8400

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55b81d7
docs: add openapi slug option to the agent skill
mintlify[bot] Nov 11, 2026
1c82caa
docs: show slug in a full openapi object example in the agent skill
mintlify[bot] Nov 11, 2026
49fed3e
docs: clarify that slug names the operation field used for endpoint URLs
mintlify[bot] Nov 11, 2026
043ddef
docs: shorten the openapi slug note in the agent skill
mintlify[bot] Nov 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions agent-context/context/skills/mintlify/reference/api-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Add an `openapi` field to a navigation element (tab, group, anchor, and so on) t
```

- The value can be a path, a URL, an array of specs, or an object: `{ "source": "openapi.json", "directory": "api-reference" }`. `directory` sets where generated pages live (default `api-reference`).
- The object form also accepts `slug`: `{ "source": "openapi.json", "directory": "api-reference", "slug": "operationId" }`. `slug` sets which operation field generates endpoint page URLs: `"summary"` (default) or `"operationId"`.
- To mix endpoints with other pages, set `openapi` on the element and list endpoints in `pages` as `METHOD /path`. Child elements inherit the parent's spec unless they set their own.
- To pull an endpoint from a specific spec without a default, use `"/path/to/spec.json POST /users"` as the page entry.
- `api.openapi` in `docs.json` accepts the same values.
Expand Down
Loading