Skip to content

Commit

Permalink
Documentation edits made through Mintlify web editor
Browse files Browse the repository at this point in the history
  • Loading branch information
rpmccarter committed Nov 21, 2024
1 parent 7628e63 commit ad54106
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions api-playground/openapi/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ document in either JSON or YAML format that follows the
[OpenAPI specification](https://swagger.io/specification/). Your document must
follow OpenAPI specification 3.0+.

### Auto-populate API pages
## Auto-populate API pages

The fastest way to get started with OpenAPI is to add an `openapi` field to a tab or anchor in the `mint.json`. This field can contain either the path to an OpenAPI document in your docs repo, or the URL of a hosted OpenAPI document. Mintlify will automatically generate a page for each OpenAPI operation and place them in the tab/anchor.

Expand Down Expand Up @@ -58,14 +58,14 @@ When using this option, the metadata for the generated pages will have the follo
There are some scenarios in which the default behavior isn't sufficient. If you need more customizability, you can create an MDX page for your OpenAPI operation, and modify it just like any other MDX page.


### Create MDX files for OpenAPI endpoints
## Create MDX files for OpenAPI endpoints

If you want to customize the page metadata, add additional content, omit certain OpenAPI operations, or reorder OpenAPI pages in your navigation, you'll need an MDX page for each operation. Here is [an example MDX OpenAPI page](https://github.com/elevenlabs/elevenlabs-docs/blob/e5e267c97b8d1e4c21db1dcdb8b005eb1dfed7da/api-reference/speech-to-speech.mdx?plain=1#L2) from [Elevenlabs](https://elevenlabs.io/docs/api-reference/speech-to-speech). 

![](/images/elevenlabs-mdx-autogeneration-example.png)


#### Autogenerate files
### Autogenerate files

For large OpenAPI documents, creating one MDX page for each OpenAPI operation can be a lot of work. To make it easier, we created a local OpenAPI page scraper.

Expand Down Expand Up @@ -96,7 +96,7 @@ reorder and add the files to your navigation manually.
If your OpenAPI document is invalid, the files will not autogenerate.
</Note>

#### Manually specify files
### Manually specify files

<Snippet file="api-playground/openapi.mdx" />

Expand Down

0 comments on commit ad54106

Please sign in to comment.