OpenAPI

Brána poskytuje dokument OpenAPI 3.1 na adrese:

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

Skladá sa pri štarte brány z dokumentov, ktoré dodávajú jednotlivé služby: cesty a schémy sa zlučujú, duplicity dostanú menný priestor služby a každá cesta označená ako interná (len v sieti služieb) sa odstráni. Služby pridávajú svoje časti postupne; rodiny, ktoré to ešte neurobili, nájdete v referencii endpointov, ale nie v dokumente. Kým dokument nepokrýva celé API, berte referenciu endpointov ako záväzný zoznam rodín a stránku konvencií ako záväzný kontrakt.

Každý kontrakt RolChat, v dokumente aj mimo neho, dodržiava konvencie: obálku odpovede, stránkovanie kurzorom, kľúče idempotencie, hlavičky limitov požiadaviek a chybové kódy.