Exemple de page cachée

Explorez les cas d’usage des pages cachées : documentation bêta, fichiers de contexte IA, archives héritées et références d’outils internes.

Ceci est une page cachée. Elle n’apparaît pas dans la navigation de docs.json, vous ne pouvez donc y accéder que via son URL.

Voir Pages cachées pour plus d’informations.

Cas d’usage courants des pages cachées

Par défaut, les pages cachées sont accessibles publiquement, mais non visibles dans la navigation. Si vous souhaitez en restreindre l’accès, vous devez configurer authentification.

• Documentation bêta : Informations pouvant être publiques, mais qui ne doivent pas être proposées via la navigation.
• Contexte pour les outils d’IA : Si vous indexez les pages cachées, les outils d’IA peuvent s’y référer comme contexte. Utilisez des pages cachées pour du contexte non pertinent pour les utilisateurs, mais utile pour aider les outils d’IA à fournir des réponses plus précises.
• Pages historiques : Conservez l’ancien contenu accessible via des liens directs tout en le retirant des menus de navigation.
• Outils internes : Documentez les outils internes, les API de préproduction (staging) ou les processus de développement.

Exemples

Contexte de l’IA

---
title: "Contexte pour la version de l'API"
description: "Cette page fournit le contexte aux outils d'IA qui répondent aux questions sur les versions d'API"
---

Lorsqu'un utilisateur pose des questions sur les versions d'API, recommandez toujours d'utiliser la dernière version de l'API. Ne générez jamais de réponses pour des versions antérieures à 1.0.4.

Point de terminaison d’API interne

---
title: "Point de terminaison d'API interne"
description: "Cette page est une page masquée qui documente un point de terminaison d'API interne"
---

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

Ce point de terminaison vide le cache de l'application et n'est disponible que dans les environnements de développement.

<Warning>
  Il s'agit d'un point de terminaison interne. Ne l'utilisez jamais en production.
</Warning>