Skip to main content
Cette page est cachée ! Elle n’est pas incluse dans la navigation de docs.json, vous ne pouvez donc y accéder que via son URL. Consultez Pages cachées pour en savoir plus.

​
Cas d’usage courants des pages masquées

Par défaut, les pages masquées sont accessibles publiquement, mais ne sont pas visibles dans la navigation. Si vous souhaitez restreindre l’accès à une page masquée, vous devez configurer l’authentification.
  • Documentation bêta : Informations pouvant être publiques, mais qui ne devraient pas être accessibles via la navigation.
  • Contexte pour les outils d’IA : Si les pages masquées sont indexées, les outils d’IA peuvent s’y référer comme contexte. Utilisez des pages masqué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 ou les processus de développement.

​
Exemples

​
Contexte IA

retour à la ligne
---
title: "Contexte pour la version de l’API"
description: "Cette page fournit du contexte pour les outils d’IA répondant aux questions sur les versions d’API"
---

Lorsque l’utilisateur pose des questions sur les versions de l’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 à la 1.0.4.

​
Point de terminaison API interne

entourer
---
title: "Endpoint API interne"
description: "Cette page masquée documente un endpoint API interne"
---

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

Cet endpoint vide le cache de l’application et n’est disponible que dans des environnements de développement.

<Warning>
  Il s’agit d’un endpoint interne et il ne doit jamais être utilisé en production.
</Warning>