Ronan/update openapi docs

api-playground/openapi/setup.mdx

@@ -10,16 +10,9 @@ document in either JSON or YAML format that follows the
 [OpenAPI specification](https://swagger.io/specification/). Your document must
 follow OpenAPI specification 3.0+.
 
-## Autogenerating the API playground
+## Auto-populate API pages
 
-You can either [autogenerate the API playground](/settings/navigation#tabs) or
-create MDX files for the individual OpenAPI endpoints.
-
-### Auto-populate API pages
-
-You can add an `openapi` field to an object in the `tabs` or `anchors` array in
-the `mint.json`. This can either be with OpenAPI documents that are in the docs
-repo (json or yaml) or hosted at a link.
+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.
 
 **Example with Anchors:**
 
@@ -54,20 +47,27 @@ repo (json or yaml) or hosted at a link.
 
 ![](/images/autogeneration-with-tabs.png)
 
-### Create MDX files for OpenAPI endpoints
+When using this option, the metadata for the generated pages will have the following default values:
+
+* `title`: The `summary` field from the OpenAPI operation, if present. Otherwise a title generated from the HTTP method and endpoint.
+
+* `description`: The `description` field from the OpenAPI operation, if present.
+
+* `version`: The `version` value from the anchor or tab, if present.
+
+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 API pages
 
-You can also create MDX files associated with each OpenAPI endpoint if you would
-like to add additional context to specific pages or have more granular control
-over the navigation. Here is
-[the code](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).
+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)
 
-If you want to autogenerate MDX files for every endpoint in your OpenAPI
-document you can use our scraper.
 
-#### 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.
 
 Our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping)
 autogenerates MDX files for your OpenAPI endpoints. Use the relative path to the
@@ -85,8 +85,7 @@ not specified, the files will populate in the working directory.
 npx @mintlify/scraping@latest openapi-file <path-to-openapi-file> -o api-reference
 ```
 
-Learn more about our scraping package
-[here](https://www.npmjs.com/package/@mintlify/scraping).
+Learn more about our scraping package [here](https://www.npmjs.com/package/@mintlify/scraping).
 
 The scraper will output an array of
 [Navigation entries](/settings/global#structure) containing your OpenAPI MDX
@@ -97,38 +96,39 @@ 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
+
+You can always create an MDX page manually, and reference the OpenAPI operation in the page's metadata using the `openapi` field.
 
 <Snippet file="api-playground/openapi.mdx" />
 
 By using the OpenAPI reference, the name, description, parameters, responses,
-and the API playground will be automatically generated using the specifications.
+and the API playground will be automatically generated from the OpenAPI document.
 
-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
+If you have multiple OpenAPI files, include the path to the OpenAPI file to ensure Mintlify finds the correct OpenAPI document. 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: "/path/to/openapi-1.json GET /users"
----
-```
-
-```md Format
----
-title: "title of the page"
-openapi: openapi-file-path method path
----
-```
-
+  ```md Example
+  ---
+  title: "Get users"
+  openapi: "/path/to/openapi-1.json GET /users"
+  ---
+  ```
+
+  ```md Format
+  ---
+  title: "title of the page"
+  openapi: openapi-file-path method path
+  ---
+  ```
 </CodeGroup>
+
 <br />
+
 <Note>
-  The method endpoint must match the endpoint specified in the OpenAPI
-  specifications exactly. If the endpoint doesn't exist in the OpenAPI file,
+  The method and path must match the method and path specified in the OpenAPI
+  document exactly. If the endpoint doesn't exist in the OpenAPI file,
   the page will be empty.
 </Note>
 
@@ -138,17 +138,15 @@ Mintlify also allows you to create individual pages for any OpenAPI schema
 defined in an OpenAPI document's `components.schemas` field:
 
 <CodeGroup>
-
-```md Example
----
-openapi-schema: OrderItem
----
-```
-
-```md Format
----
-openapi-schema: "schema-key"
----
-```
-
-</CodeGroup>
+  ```md Example
+  ---
+  openapi-schema: OrderItem
+  ---
+  ```
+
+  ```md Format
+  ---
+  openapi-schema: "schema-key"
+  ---
+  ```
+</CodeGroup>