diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index ddac9b9..2fb6685 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -101,10 +101,10 @@ 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. +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. @@ -126,8 +126,8 @@ only one OpenAPI file - it will automatically detect your OpenAPI file.
- 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.