Skip to content

Commit a90a800

Browse files
committed
remove duplicate API troubleshooting info
1 parent 6e087ef commit a90a800

File tree

2 files changed

+1
-65
lines changed

2 files changed

+1
-65
lines changed

api-playground/troubleshooting.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: "Common issues with API References"
44
icon: "message-square-warning"
55
---
66

7-
API pages are complicated. As a result, there are a lot of things that can go wrong.
8-
Here's a list of common issues we've seen customers run into:
7+
If your API pages aren't displaying correctly, check these common configuration issues:
98

109
<AccordionGroup>
1110
<Accordion title="All of my OpenAPI pages are completely blank">

support.mdx

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -34,69 +34,6 @@ export function openSearch(e) {
3434

3535
<AccordionGroup>
3636

37-
<Accordion title="API page issues" icon="book-open">
38-
API pages are complicated. As a result, there are a lot of things that can go wrong. Here's a list of common issues we've seen customers run into:
39-
40-
<AccordionGroup>
41-
<Accordion title="All of my OpenAPI pages are completely blank">
42-
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document or your OpenAPI document is invalid.
43-
44-
Running `mint dev` locally should reveal some of these issues.
45-
46-
To verify your OpenAPI document will pass validation:
47-
48-
1. Run `mint openapi-check <openapiFilenameOrUrl>` in your CLI.
49-
2. Validate your OpenAPI spec with [Swagger Editor](https://editor.swagger.io/).
50-
51-
Additionally, Mintlify does not support OpenAPI 2.0. If your document uses OpenAPI 2.0, you may encounter this issue. You can convert your document with [Swagger Editor](https://editor.swagger.io/).
52-
53-
<Frame>
54-
!["Convert to OpenAPI 3" menu item highlighted in the Swagger Editor](/images/convert-oas-3.png)
55-
</Frame>
56-
</Accordion>
57-
<Accordion title="One of my OpenAPI pages is completely blank">
58-
This is usually caused by a misspelled `openapi` field in the page metadata. Make sure that the HTTP method and path match the HTTP method and path in the OpenAPI document exactly.
59-
60-
Here's an example of how things might go wrong:
61-
62-
```md get-user.mdx
63-
---
64-
openapi: "GET /users/{id}/"
65-
---
66-
```
67-
68-
```yaml openapi.yaml
69-
paths:
70-
"/users/{id}":
71-
get: ...
72-
```
73-
Notice that the path in the `openapi` field has a trailing slash, whereas the path in the OpenAPI
74-
document does not.
75-
76-
Another common issue is a misspelled filename. If you are specifying a particular OpenAPI document
77-
in the `openapi` field, ensure the filename is correct. For example, if you have two OpenAPI
78-
documents `openapi/v1.json` and `openapi/v2.json`, your metadata might look like this:
79-
80-
```md api-reference/v1/users/get-user.mdx
81-
---
82-
openapi: "v1 GET /users/{id}"
83-
---
84-
```
85-
</Accordion>
86-
<Accordion title="Requests from the API Playground don't work">
87-
If you have a custom domain configured, this could be an issue with your reverse proxy. By
88-
default, requests made via the API Playground start with a `POST` request to the
89-
`/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`
90-
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
91-
allow `POST` requests to the `/api/request` path.
92-
93-
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`. See the [configurations for the API playground](/settings#param-proxy) for more information. This will
94-
likely require you to configure CORS on your server, as these requests will now come directly
95-
from your users' browsers.
96-
</Accordion>
97-
</AccordionGroup>
98-
</Accordion>
99-
10037
<Accordion title="Docs page won't load (error 404)" icon="ban" iconType="regular">
10138
Check to see if you have `/api` in the URL. This is a reserved folder in production environments, which produces a 404 error.
10239
</Accordion>

0 commit comments

Comments
 (0)