diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index 93d32f21d..b4201889c 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -33,13 +33,18 @@ If your API pages aren't displaying correctly, check these common configuration This is usually caused by a misspelled `openapi` field in the page metadata. Make sure - the HTTP method and path match the HTTP method and path in the OpenAPI document exactly. + the HTTP method and path match the HTTP method and path in the OpenAPI document. + + + Mintlify automatically resolves trailing slash differences between your `openapi` reference + and the OpenAPI specification. For example, `GET /users/{id}/` matches a specification path of `/users/{id}`. + Here's an example of how things might go wrong: ```mdx get-user.mdx --- - openapi: "GET /users/{id}/" + openapi: "GET /user/{id}" --- ``` @@ -49,8 +54,8 @@ If your API pages aren't displaying correctly, check these common configuration get: ... ``` - Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI - document does not. + Notice that the path in the `openapi` field says `/user/{id}` (singular), whereas the path in the OpenAPI + document is `/users/{id}` (plural). Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI