Skip to content

Commit 1f5c74a

Browse files
Update OpenAPI troubleshooting for trailing slash tolerance (#5478)
* Update troubleshooting to reflect trailing slash tolerance in OpenAPI path resolution Generated-By: mintlify-agent * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent 6286dae commit 1f5c74a

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

api-playground/troubleshooting.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,18 @@ If your API pages aren't displaying correctly, check these common configuration
3333
</Accordion>
3434
<Accordion title="One of my OpenAPI pages is completely blank">
3535
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure
36-
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
36+
the HTTP method and path match the HTTP method and path in the OpenAPI document.
37+
38+
<Note>
39+
Mintlify automatically resolves trailing slash differences between your `openapi` reference
40+
and the OpenAPI specification. For example, `GET /users/{id}/` matches a specification path of `/users/{id}`.
41+
</Note>
3742

3843
Here's an example of how things might go wrong:
3944

4045
```mdx get-user.mdx
4146
---
42-
openapi: "GET /users/{id}/"
47+
openapi: "GET /user/{id}"
4348
---
4449
```
4550

@@ -49,8 +54,8 @@ If your API pages aren't displaying correctly, check these common configuration
4954
get: ...
5055
```
5156
52-
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
53-
document does not.
57+
Notice that the path in the `openapi` field says `/user/{id}` (singular), whereas the path in the OpenAPI
58+
document is `/users/{id}` (plural).
5459

5560
Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document
5661
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI

0 commit comments

Comments
 (0)