quick fix to improve the OpenAPI pages

dino475 · dino475 · commit e50d603041e8 · 2025-03-05T21:14:49.000-08:00
diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx
@@ -49,6 +49,8 @@ The fastest way to get started with OpenAPI is to add an `openapi` field to a ta
 }
 ```
 
+<Note>The directory field is optional. If not specified, the files will be placed in the **api-reference** folder of the docs repo.</Note>
+
 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.
diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx
@@ -16,7 +16,7 @@ Here's a list of common issues we've seen customers run into:
 
     To verify your OpenAPI document will pass validation:
 
-    1. Visit [this validator](https://apitools.dev/swagger-parser/online/)
+    1. Visit [this validator](https://editor.swagger.io/)
     2. Switch to the "Validate text" tab
     3. Paste in your OpenAPI document
     4. Click "Validate it!"

Original file line number	Diff line number	Diff line change
@@ -49,6 +49,8 @@ The fastest way to get started with OpenAPI is to add an `openapi` field to a ta
`49`	`49`	`}`
`50`	`50`	```
`51`	`51`
	`52`	`+<Note>The directory field is optional. If not specified, the files will be placed in the api-reference folder of the docs repo.</Note>`
	`53`	`+`
`52`	`54`	`When using this option, the metadata for the generated pages will have the following default values:`
`53`	`55`
`54`	`56`	* `title`: The `summary` field from the OpenAPI operation, if present. Otherwise a title generated from the HTTP method and endpoint.