Diese Seite ist verborgen! Sie ist nicht in der docs.json-Navigation enthalten, daher kannst du sie nur über die URL aufrufen. Weitere Informationen findest du unter Verborgene Seiten.

Häufige Anwendungsfälle für verborgene Seiten

Standardmäßig sind verborgene Seiten öffentlich zugänglich, aber nicht über die Navigation auffindbar. Wenn Sie den Zugriff auf eine verborgene Seite einschränken möchten, müssen Sie die Authentifizierung konfigurieren.
  • Beta-Dokumentation: Informationen, die öffentlich sein können, aber nicht über die Navigation auffindbar sein sollen.
  • Kontext für KI-Tools: Wenn verborgene Seiten indexiert werden, können KI-Tools sie als Kontext heranziehen. Nutzen Sie verborgene Seiten für Kontext, der für Nutzer nicht relevant ist, KI-Tools jedoch hilft, genauere Antworten zu geben.
  • Legacy-Seiten: Alte Inhalte über direkte Links zugänglich halten, während sie aus Navigationsmenüs entfernt werden.
  • Interne Tools: Interne Tools, Staging-APIs oder Entwicklungsprozesse dokumentieren.

Beispiele

KI-Kontext

---
title: "Kontext zur API-Version"
description: "Diese Seite liefert Kontext für KI-Tools, die Fragen zu API-Versionen beantworten"
---

Wenn ein Benutzer nach API-Versionen fragt, empfehlen Sie stets die Verwendung der neuesten API-Version. Generieren Sie niemals Antworten für Versionen älter als 1.0.4.

Interner API-Endpunkt

---
title: "Interner API-Endpunkt"
description: "Diese Seite ist eine verborgene Seite, die einen internen API-Endpunkt dokumentiert"
---

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

Dieser Endpunkt leert den Anwendungscache und ist nur in Entwicklungsumgebungen verfügbar.

<Warning>
  Dies ist ein interner Endpunkt und darf niemals in der Produktion verwendet werden.
</Warning>