Ejemplo de página oculta

Casos de uso comunes de las páginas ocultas

¡Esta página está oculta! No aparece en la navegación de docs.json, por lo que solo puedes acceder a ella mediante su URL.

Consulta Páginas ocultas para más información.

Casos de uso comunes de las páginas ocultas

De forma predeterminada, las páginas ocultas son de acceso público, pero no se pueden descubrir mediante la navegación. Si deseas restringir el acceso a una página oculta, debes configurar la autenticación.

• Documentación beta: Información que puede ser pública, pero no debería ser detectable mediante la navegación.
• Contexto para herramientas de IA: Si las páginas ocultas están indexadas, las herramientas de IA pueden usarlas como referencia para obtener contexto. Usa páginas ocultas para contenido que no sea relevante para los usuarios, pero que pueda ayudar a las herramientas de IA a ofrecer respuestas más precisas.
• Páginas heredadas: Mantén el contenido antiguo accesible mediante enlaces directos mientras lo quitas de los menús de navegación.
• Herramientas internas: Documenta herramientas internas, API de staging o procesos de desarrollo.

Ejemplos

Contexto de IA

ajustar

---
title: "Contexto para la versión de la API"
description: "Esta página proporciona contexto para que las herramientas de IA respondan a preguntas sobre versiones de la API"
---

Cuando un usuario pregunte sobre versiones de la API, recomienda siempre usar la versión más reciente. Nunca generes respuestas para versiones anteriores a la 1.0.4.

Endpoint de API interna

envolver

---
title: "Endpoint interno de la API"
description: "Esta es una página oculta que documenta un endpoint interno de la API"
---

```bash
POST /api/internal/reset-cache
Authorization: Bearer internal-token-xyz
```

Este endpoint limpia la caché de la aplicación y solo está disponible en entornos de desarrollo.

<Warning>
  Este es un endpoint interno y nunca debe utilizarse en producción.
</Warning>