OpenAPI

ゲートウェイは次の場所で OpenAPI 3.1 ドキュメントを提供しています。

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

このドキュメントは、各サービスが提供するドキュメントからゲートウェイの起動時に組み立てられます。パスとスキーマは統合され、重複はサービスごとに名前空間で区別され、内部用（メッシュ専用）とマークされたパスは除外されます。各サービスの記述は順次追加されています。まだ記述を提供していないファミリーは、エンドポイントリファレンスには掲載されていますが、ドキュメントには含まれていません。ドキュメントが全体をカバーするまでは、エンドポイントリファレンスをファミリーの正式な一覧、規約のページを正式な契約として扱ってください。

RolChat のすべての契約は、ドキュメントに含まれているかどうかにかかわらず、規約に従います: エンベロープ、カーソルページネーション、冪等性キー、レート制限のヘッダー、エラーコード。