Skip to content
Merged
Changes from all commits
Commits
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
70 changes: 69 additions & 1 deletion api-playground/mdx-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,75 @@
```
</Step>
<Step title="Add your endpoints to your docs">
Add your endpoint pages to the navigation by updating the `pages` field in your `docs.json`. Learn more about structuring your docs in [Navigation](/organize/navigation).
Add your endpoint pages to the navigation by updating the `pages` field in your `docs.json`:

```json docs.json
"navigation": {
"tabs": [
{
"tab": "API Reference",
"groups": [
{
"group": "Users",
"pages": [
"api-reference/users/create-user",
"api-reference/users/get-user",
"api-reference/users/update-user"
]
},
{
"group": "Orders",
"pages": [
"api-reference/orders/create-order",
"api-reference/orders/list-orders"
]
}
]
}
]
}
```

Each page path corresponds to an MDX file in your docs repository. For example, `api-reference/users/create-user.mdx`. Learn more about structuring your docs in [Navigation](/organize/navigation).

### Using OpenAPI endpoints in navigation

If you have an OpenAPI specification, you can reference endpoints directly in your navigation without creating individual MDX files. Reference specific endpoints by including the OpenAPI file path and the endpoint:

```json docs.json
"navigation": {
"pages": [
"introduction",
"/path/to/users-openapi.json POST /users",
"/path/to/orders-openapi.json GET /orders"
]
}
```

You can also set a default OpenAPI spec for a navigation group and reference endpoints by method and path:

```json docs.json
{
"group": "API reference",
"openapi": "/path/to/openapi-v1.json",
"pages": [
"overview",
"authentication",
"GET /users",
"POST /users",
{
"group": "Orders",
"openapi": "/path/to/openapi-v2.json",
"pages": [
"GET /orders",
"POST /orders"
]
}
]
}
```

For more details on OpenAPI integration, see [OpenAPI setup](/api-playground/openapi-setup).
</Step>
</Steps>

Expand Down Expand Up @@ -175,7 +243,7 @@

### None

To disable authentication on a specific page, set `authMethod` to `none`:

Check warning on line 246 in api-playground/mdx-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx-setup.mdx#L246

Use 'turn off' or 'off' instead of 'disable'.

```mdx Page Metadata
---
Expand Down