OpenAPI

Das Gateway stellt ein OpenAPI-3.1-Dokument bereit unter:

GET https://api.rolchat.com/openapi.json

Es wird beim Start des Gateways aus den Dokumenten zusammengesetzt, die jeder Dienst beisteuert: Pfade und Schemas werden zusammengeführt, Duplikate erhalten einen Namensraum pro Dienst, und jeder als intern markierte Pfad (nur im Mesh) wird entfernt. Die Beiträge kommen Dienst für Dienst hinzu; Gruppen, die noch nichts beigesteuert haben, erscheinen in der Endpunktreferenz, aber nicht im Dokument. Solange das Dokument nicht die gesamte Oberfläche abdeckt, gilt die Endpunktreferenz als maßgebliche Liste der Gruppen und die Seite mit den Konventionen als maßgeblicher Vertrag.

Jeder RolChat-Vertrag, ob im Dokument oder nicht, folgt den Konventionen: dem Envelope, der Cursor-Paginierung, den Idempotenzschlüsseln, den Rate-Limit-Headern und den Fehlercodes.