¡Esta página está oculta! No está incluida en la navegación de docs.json, por lo que solo puedes acceder a ella mediante su URL. Consulta Páginas ocultas para obtener más información.

Casos de uso comunes de Páginas ocultas

De forma predeterminada, las páginas ocultas son de acceso público, pero no se pueden descubrir a través de 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 accesible desde la navegación.
  • Contexto para herramientas de IA: Si las páginas ocultas están indexadas, las herramientas de IA pueden referenciarlas como 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, APIs de staging o procesos de desarrollo.

Ejemplos

Contexto de IA

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

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

Endpoint interno de la API

---
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 vacía la caché de la aplicación y solo está disponible en entornos de desarrollo.

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