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
2 changes: 1 addition & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

The playground is automatically generated from your OpenAPI specification or AsyncAPI schema so any updates to your API are automatically reflected in the playground. You can also manually create API reference pages after defining a base URL and authentication method in your `docs.json`.

We recommend generating your API playground from an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L18

Try to avoid using first-person plural like 'We'.

## Getting started

Expand All @@ -25,7 +25,7 @@
Make sure that your OpenAPI specification file is valid using the [Swagger Editor](https://editor.swagger.io/) or [Mint CLI](https://www.npmjs.com/package/mint).
</Info>

```bash {2}
```bash {3}
/your-project
|- docs.json
|- openapi.json
Expand Down Expand Up @@ -79,7 +79,7 @@
<Expandable title="playground" defaultOpen="True">
<ResponseField name="display" type="&quot;interactive&quot; | &quot;simple&quot; | &quot;none&quot;">
The display mode of the API playground.
- `"interactive"`: Display the interactive playground.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L82

': D' should be in lowercase.
- `"simple"`: Display a copyable endpoint with no playground.
- `"none"`: Display nothing.

Expand Down Expand Up @@ -109,19 +109,19 @@

```json
{
"api": {

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L112

Did you really mean 'api'?
"playground": {
"display": "interactive"
},
"examples": {
"languages": ["curl", "python", "javascript"],

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L117

Commas and periods go inside quotation marks.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L117

Commas and periods go inside quotation marks.
"defaults": "required"
}
}
}
```

This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L124

In general, use active voice instead of passive voice ('are shown').

### Custom endpoint pages

Expand All @@ -133,9 +133,9 @@
- Add additional content like examples
- Control playground behavior per page

The `x-mint` extension is recommended so that all of your API documentation is automatically generated from your OpenAPI specification and maintained in one file.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L136

In general, use active voice instead of passive voice ('is recommended').

Individual `MDX` pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L138

In general, use active voice instead of passive voice ('are recommended').

For more information, see [x-mint extension](/api-playground/openapi-setup#x-mint-extension) and [MDX Setup](/api-playground/mdx/configuration).

Expand Down