OpenAPI

Brána poskytuje dokument OpenAPI 3.1 na adrese:

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

Skládá se při startu brány z dokumentů, které dodávají jednotlivé služby: cesty a schémata se slučují, duplicity dostanou jmenný prostor služby a každá cesta označená jako interní (jen v síti služeb) se odstraní. Služby přidávají své části postupně; rodiny, které to ještě neudělaly, najdete v referenci endpointů, ale ne v dokumentu. Dokud dokument nepokrývá celé API, berte referenci endpointů jako závazný seznam rodin a stránku konvencí jako závazný kontrakt.

Každý kontrakt RolChat, v dokumentu i mimo něj, dodržuje konvence: obálku odpovědi, stránkování kurzorem, klíče idempotence, hlavičky limitů požadavků a chybové kódy.