Skip to content
Merged
Show file tree
Hide file tree
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
8 changes: 6 additions & 2 deletions api-playground/mdx/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

</Note>

You can override the globally-defined display mode for the API playground per page by adding `playground` at the top of the `MDX` file:
You can override the globally-defined display mode for the API playground for a page by adding `playground` to the frontmatter:

```mdx
---
Expand All @@ -68,7 +68,11 @@
playground: 'none'
---
```


- `playground: 'interactive'` - Display the interactive playground.
- `playground: 'simple'` - Display a copyable endpoint with no playground.
- `playground: 'none'` - Hide the playground.

</Step>

<Step title="Add your endpoints to your docs">
Expand Down Expand Up @@ -160,7 +164,7 @@
```mdx Page Metadata
---
title: "Your page title"
authMethod: "none"

Check warning on line 167 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/mdx/configuration.mdx#L167

Did you really mean 'authMethod'?
---
```
</CodeGroup>
1 change: 1 addition & 0 deletions api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@
</ResponseField>

<ResponseField name="examples" type="object">
Configurations for the autogenerated API examples.

Check warning on line 76 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/overview.mdx#L76

Did you really mean 'autogenerated'?
<Expandable title="examples" defaultOpen="True">
<ResponseField name="languages" type="array of string">
Example languages for the autogenerated API snippets.

Check warning on line 79 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/overview.mdx#L79

Did you really mean 'autogenerated'?

Languages display in the order specified.
</ResponseField>
Expand All @@ -90,7 +90,7 @@

```json
{
"api": {

Check warning on line 93 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/overview.mdx#L93

Did you really mean 'api'?
"playground": {
"display": "interactive"
},
Expand All @@ -112,6 +112,7 @@
- Add additional content like examples
- Hide specific operations
- Reorder pages in your navigation
- Control playground behavior per page

See [MDX Setup](/api-playground/mdx/configuration) for more information on creating individual pages for your API endpoints.

Expand Down