Skip to content

Commit df4a94d

Browse files
committed
Documentation edits made through Mintlify web editor
1 parent 043a53e commit df4a94d

File tree

1 file changed

+20
-27
lines changed

1 file changed

+20
-27
lines changed

api-playground/troubleshooting.mdx

Lines changed: 20 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,36 @@ Here's a list of common issues we've seen customers run into:
1919
1. Visit [this validator](https://editor.swagger.io/)
2020
2. Switch to the "Validate text" tab
2121
3. Paste in your OpenAPI document
22-
4. Click "Validate it!"
22+
4. Click "Validate it\!"
2323

2424
If the text box that appears below has a green border, your document has passed validation.
2525
This is the exact validation package Mintlify uses to validate OpenAPI documents, so if your document
2626
passes validation here, there's a great chance the problem is elsewhere.
2727

2828
Additionally, Mintlify does not support OpenAPI 2.0. If your document uses this version of the specification,
29-
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit > Convert to OpenAPI 3):
29+
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3):
3030

3131
<Frame>
32-
<img src="/images/convert-oas-3.png" />
32+
![](/images/convert-oas-3.png)
3333
</Frame>
34-
3534
</Accordion>
36-
3735
<Accordion title="One of my OpenAPI pages is completely blank">
3836
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure
3937
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
4038

4139
Here's an example of how things might go wrong:
4240

43-
```md get-user.mdx
44-
---
45-
openapi: "GET /users/{id}/"
46-
---
47-
```
41+
```md get-user.mdx
42+
---
43+
openapi: "GET /users/{id}/"
44+
---
45+
```
4846

49-
```yaml openapi.yaml
50-
paths:
51-
"/users/{id}":
52-
get: ...
53-
```
47+
```yaml openapi.yaml
48+
paths:
49+
"/users/{id}":
50+
get: ...
51+
```
5452
5553
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
5654
document does not.
@@ -59,26 +57,21 @@ paths:
5957
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
6058
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:
6159

62-
```md api-reference/v1/users/get-user.mdx
63-
---
64-
openapi: "v1 GET /users/{id}"
65-
---
66-
```
67-
60+
```md api-reference/v1/users/get-user.mdx
61+
---
62+
openapi: "v1 GET /users/{id}"
63+
---
64+
```
6865
</Accordion>
69-
7066
<Accordion title="Requests from the API Playground don't work">
7167
If you have a custom domain configured, this could be an issue with your reverse proxy. By
7268
default, requests made via the API Playground start with a `POST` request to the
7369
`/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`
7470
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
7571
allow `POST` requests to the `/api/request` path.
7672

77-
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure
78-
Mintlify to send requests directly to your backend with the `api.playground.disableProxy`
79-
setting in the `docs.json`, as described [here](/settings/global#api-configurations). This will
73+
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](/settings/global#api-configurations). This will
8074
likely require you to configure CORS on your server, as these requests will now come directly
8175
from your users' browsers.
82-
8376
</Accordion>
84-
</AccordionGroup>
77+
</AccordionGroup>

0 commit comments

Comments
 (0)