OpenAPI

Az átjáró egy OpenAPI 3.1 dokumentumot szolgál ki a következő címen:

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

A dokumentum az átjáró indulásakor áll össze az egyes szolgáltatások által biztosított dokumentumokból: az útvonalak és sémák egyesülnek, a duplikátumok szolgáltatás szerinti névteret kapnak, a belsőnek (csak a belső hálón elérhetőnek) jelölt útvonalak pedig eltávolításra kerülnek. A hozzájárulások szolgáltatásonként kerülnek be; azok a családok, amelyek még nem járultak hozzá, szerepelnek a végpontreferenciában, de a dokumentumban nem. Amíg a dokumentum nem fedi le a teljes felületet, a végpontreferenciát tekintsd a családok hiteles listájának, a konvenciók oldalát pedig a hiteles szerződésnek.

Minden RolChat-szerződés, akár szerepel a dokumentumban, akár nem, a konvenciókat követi: a borítékot, a kurzoros lapozást, az idempotenciakulcsokat, a sebességkorlát-fejléceket és a hibakódokat.