Manage page visibility

Generated API pages do not need to be all-or-nothing. You can keep some operations public and prominent, hide others from navigation, or remove some from docs generation entirely.

​

Curate pages from navigation

If you attach an OpenAPI file to a navigation group and also provide a pages list, only those operations are published in that section.

{
  "group": "API Reference",
  "openapi": "openapi/docsalot-cli-v1.json",
  "pages": [
    "GET /auth/user",
    "GET /documentations",
    "POST /documentations"
  ]
}

​

Hide a page but keep the URL live

Use x-hidden: true when an operation should exist as a direct link but should not be discoverable from sidebar navigation.

paths:
  /internal/preview:
    post:
      x-hidden: true
      summary: Trigger a preview build

This works well for:

• beta endpoints
• admin-only operations
• pages you only link from workflows or support docs

​

Exclude a page completely

Use x-excluded: true when an operation should not generate a docs page at all.

paths:
  /internal/seed:
    post:
      x-excluded: true
      summary: Seed demo content

​

Avoid duplicate routes

Do not create both a manual MDX page and a generated OpenAPI page for the same operation. Pick one URL and one source of truth for that endpoint.