mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f14cca3b52
* Standardize style: 'Click' to 'Select' for Mintlify UI; split long sentences Generated-By: mintlify-agent * Revert 'select' back to 'click' for UI interactions Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Fix select→click for UI elements across docs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
87 lines
2.7 KiB
Plaintext
87 lines
2.7 KiB
Plaintext
---
|
|
title: "Manage page visibility"
|
|
description: "Control which API endpoints appear in your documentation navigation by hiding, filtering, or organizing autogenerated OpenAPI pages."
|
|
keywords: ["x-hidden", "x-excluded", "hide endpoints", "page visibility", "internal endpoints"]
|
|
---
|
|
|
|
You can control which OpenAPI operations get published as documentation pages and their visibility in navigation. This is useful for internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation.
|
|
|
|
If your pages are autogenerated from an OpenAPI document, manage page visibility with the `x-hidden` and `x-excluded` extensions.
|
|
|
|
## `x-hidden`
|
|
|
|
The `x-hidden` extension creates a page for an endpoint, but hides it from navigation. The page is only accessible by navigating directly to its URL.
|
|
|
|
Common use cases for `x-hidden` are:
|
|
|
|
- Endpoints you want to document, but not promote.
|
|
- Pages that you link to from other content.
|
|
- Endpoints for specific users.
|
|
|
|
## `x-excluded`
|
|
|
|
|
|
The `x-excluded` extension completely excludes an endpoint from your documentation.
|
|
|
|
Common use cases for `x-excluded` are:
|
|
|
|
- Internal-only endpoints.
|
|
- Deprecated endpoints that you don't want to document.
|
|
- Beta features that are not ready for public documentation.
|
|
|
|
## Implementation
|
|
|
|
Add the `x-hidden` or `x-excluded` extension under the HTTP method in your OpenAPI specification.
|
|
|
|
Here are examples of how to use each property in an OpenAPI schema document for an endpoint and a webhook path.
|
|
|
|
```json Endpoint example {11, 19}
|
|
"paths": {
|
|
"/plants": {
|
|
"get": {
|
|
"description": "Returns all plants from the store",
|
|
"parameters": { /*...*/ },
|
|
"responses": { /*...*/ }
|
|
}
|
|
},
|
|
"/hidden_plants": {
|
|
"get": {
|
|
"x-hidden": true,
|
|
"description": "Returns all somewhat secret plants from the store",
|
|
"parameters": { /*...*/ },
|
|
"responses": { /*...*/ }
|
|
}
|
|
},
|
|
"/secret_plants": {
|
|
"get": {
|
|
"x-excluded": true,
|
|
"description": "Returns all top secret plants from the store (do not publish this endpoint!)",
|
|
"parameters": { /*...*/ },
|
|
"responses": { /*...*/ }
|
|
}
|
|
}
|
|
},
|
|
```
|
|
|
|
```json Webhook example {9, 15}
|
|
"webhooks": {
|
|
"/plants_hook": {
|
|
"post": {
|
|
"description": "Webhook for information about a new plant added to the store",
|
|
}
|
|
},
|
|
"/hidden_plants_hook": {
|
|
"post": {
|
|
"x-hidden": true,
|
|
"description": "Webhook for somewhat secret information about a new plant added to the store"
|
|
}
|
|
},
|
|
"/secret_plants_hook": {
|
|
"post": {
|
|
"x-excluded": true,
|
|
"description": "Webhook for top secret information about a new plant added to the store (do not publish this endpoint!)"
|
|
}
|
|
}
|
|
}
|
|
```
|