Skip to content

Commit b7266bc

Browse files
committed
add section to autogeneration docs
1 parent 0cfdd56 commit b7266bc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

api-playground/openapi/setup.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,12 @@ only one OpenAPI file - it will automatically detect your OpenAPI file.
109109
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.
110110

111111
Our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping)
112-
autogenerates MDX files for your OpenAPI endpoints. Use the relative path to the
113-
OpenAPI document in your codebase.
112+
autogenerates MDX files for your OpenAPI endpoints.
113+
114+
Each generated page will correspond to an OpenAPI operation under the "paths" section of the OpenAPI schema.
115+
If your OpenAPI document is version 3.1+, the scraper will also generate pages for webhooks under the "webhooks" section of the OpenAPI schema.
116+
117+
Use the relative path to the OpenAPI document in your codebase.
114118

115119
```bash
116120
npx @mintlify/scraping@latest openapi-file <path-to-openapi-file>

0 commit comments

Comments
 (0)