Skip to content

add improved openapi frontmatter docs #361

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 1 commit into from
Nov 18, 2024
Merged

add improved openapi frontmatter docs #361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions api-playground/openapi/setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,24 +104,23 @@ reorder and add the files to your navigation manually.
By using the OpenAPI reference, the name, description, parameters, responses,
and the API playground will be automatically generated using the specifications.

If you have multiple OpenAPI files, include the name of the OpenAPI file
(without the file type `.json` or `.yaml`) to correctly map the information.
This is not required if you have only one OpenAPI file - it will automatically
detect your OpenAPI file.
If you have multiple OpenAPI files, include the path to the OpenAPI file to map
the MDX file to the appropriate OpenAPI file. This is not required if you have
only one OpenAPI file - it will automatically detect your OpenAPI file.

<CodeGroup>

```md Example
---
title: "Get users"
openapi: "openapi-1 GET /users"
openapi: "/path/to/openapi-1.json GET /users"
---
```

```md Format
---
title: "title of the page"
openapi: openapi-file-name method path
openapi: openapi-file-path method path
---
```

Expand Down