Skip to content

Commit 285a4cb

Browse files
Add warning about automatic OpenAPI endpoint generation (#1970)
* Update organize/navigation.mdx * move for more info link higher * use note --------- 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 a551b3c commit 285a4cb

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

organize/navigation.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,14 @@ Integrate OpenAPI specifications directly into your navigation structure to auto
399399

400400
Set a default OpenAPI specification at any level of your navigation hierarchy. Child elements will inherit this specification unless they define their own specification.
401401

402+
<Note>
403+
When you add the `openapi` property to a navigation element (such as an anchor, tab, or group) without specifying any pages, Mintlify automatically generates pages for **all endpoints** defined in your OpenAPI specification.
404+
405+
To control which endpoints appear, explicitly list the desired endpoints in a `pages` array.
406+
</Note>
407+
408+
For more information about referencing OpenAPI endpoints in your docs, see the [OpenAPI setup](/api-playground/openapi-setup).
409+
402410
```json
403411
{
404412
"navigation": {
@@ -426,8 +434,6 @@ Set a default OpenAPI specification at any level of your navigation hierarchy. C
426434
}
427435
```
428436

429-
For more information about referencing OpenAPI endpoints in your docs, see the [OpenAPI setup](/api-playground/openapi-setup).
430-
431437
## Versions
432438

433439
Partition your navigation into different versions. Versions are selectable from a dropdown menu.

0 commit comments

Comments
 (0)