Skip to content

Commit 52174e4

Browse files
committed
add improved openapi frontmatter docs
1 parent d96f93f commit 52174e4

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

api-playground/openapi/setup.mdx

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -104,24 +104,23 @@ reorder and add the files to your navigation manually.
104104
By using the OpenAPI reference, the name, description, parameters, responses,
105105
and the API playground will be automatically generated using the specifications.
106106

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

112111
<CodeGroup>
113112

114113
```md Example
115114
---
116115
title: "Get users"
117-
openapi: "openapi-1 GET /users"
116+
openapi: "/path/to/openapi-1.json GET /users"
118117
---
119118
```
120119

121120
```md Format
122121
---
123122
title: "title of the page"
124-
openapi: openapi-file-name method path
123+
openapi: openapi-file-path method path
125124
---
126125
```
127126

0 commit comments

Comments
 (0)