OpenAPI

Lüüs serveerib OpenAPI 3.1 dokumenti aadressil:

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

See pannakse lüüsi käivitamisel kokku dokumentidest, mille iga teenus panustab: teed ja skeemid liidetakse, duplikaatidele lisatakse teenuse nimeruum ning kõik sisemiseks (ainult mesh) märgitud teed eemaldatakse. Panused lisatakse teenuse kaupa; perekonnad, mis pole veel panustanud, ilmuvad lõpp-punktide viites, kuid mitte dokumendis. Kuni dokument ei kata kogu pinda, käsitle lõpp-punktide viidet perekondade autoriteetse loendina ja kokkulepete lehte autoriteetse lepinguna.

Iga RolChati leping, olgu see dokumendis või mitte, järgib kokkuleppeid: ümbris, kursoripõhine lehekülgedeks jaotamine, idempotentsusvõtmed, kasutuspiirangute päised ja veakoodid.