OpenAPI

Gatewayen leverer et OpenAPI 3.1-dokument på:

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

Det sammensættes, når gatewayen starter, ud fra de dokumenter, hver tjeneste bidrager med: stier og skemaer flettes, dubletter får et navnerum efter tjeneste, og enhver sti, der er markeret som intern (kun mesh), fjernes. Bidragene tilføjes tjeneste for tjeneste; familier, der endnu ikke har bidraget, vises i endpoint-referencen, men ikke i dokumentet. Indtil dokumentet dækker hele fladen, skal du betragte endpoint-referencen som den autoritative liste over familier og konventionssiden som den autoritative kontrakt.

Hver RolChat-kontrakt, uanset om den er i dokumentet eller ej, følger konventionerne: konvolutten, cursor-paginering, idempotensnøgler, headere for hastighedsgrænser og fejlkoderne.