Skip to content

Update API playground docs #530

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

Merged
merged 2 commits into from
Feb 14, 2025
Merged

Update API playground docs #530

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94ef43a
add playground config per page
lawreka Feb 14, 2025
cdd001e
reword
lawreka Feb 14, 2025
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
10 changes: 10 additions & 0 deletions api-playground/mdx/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,16 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
If you have `server` configured in [docs.json](/settings/global), you can use relative paths like `/v1/endpoint`.

</Note>

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

```md
---
title: 'Create new user'
api: 'POST https://api.mintlify.com/user'
playground: 'none'
```

</Step>

<Step title="Add your endpoints to your docs">
Expand Down