You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If the text box that appears below has a green border, your document has passed validation.
25
25
This is the exact validation package Mintlify uses to validate OpenAPI documents, so if your document
26
26
passes validation here, there's a great chance the problem is elsewhere.
27
27
28
28
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):
30
30
31
31
<Frame>
32
-
<imgsrc="/images/convert-oas-3.png" />
32
+

33
33
</Frame>
34
-
35
34
</Accordion>
36
-
37
35
<Accordiontitle="One of my OpenAPI pages is completely blank">
38
36
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure
39
37
the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
40
38
41
39
Here's an example of how things might go wrong:
42
40
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
+
```
48
46
49
-
```yaml openapi.yaml
50
-
paths:
51
-
"/users/{id}":
52
-
get: ...
53
-
```
47
+
```yaml openapi.yaml
48
+
paths:
49
+
"/users/{id}":
50
+
get: ...
51
+
```
54
52
55
53
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
56
54
document does not.
@@ -59,26 +57,21 @@ paths:
59
57
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
60
58
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:
61
59
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
+
```
68
65
</Accordion>
69
-
70
66
<Accordion title="Requests from the API Playground don't work">
71
67
If you have a custom domain configured, this could be an issue with your reverse proxy. By
72
68
default, requests made via the API Playground start with a `POST` request to the
73
69
`/api/request`path on the docs site. If your reverse proxy is configured to only allow `GET`
74
70
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
75
71
allow `POST` requests to the `/api/request` path.
76
72
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
80
74
likely require you to configure CORS on your server, as these requests will now come directly
0 commit comments