OpenAPI

Pristupnik poslužuje OpenAPI 3.1 dokument na adresi:

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

Sastavlja se pri pokretanju pristupnika iz dokumenata koje doprinosi svaka usluga: putanje i sheme se spajaju, duplikati dobivaju imenski prostor usluge, a svaka putanja označena kao interna (samo unutar mreže usluga) uklanja se. Usluge svoje dijelove dodaju postupno; obitelji koje to još nisu učinile vidljive su u referenci krajnjih točaka, ali ne i u dokumentu. Dok dokument ne pokrije cijeli API, referencu krajnjih točaka smatrajte mjerodavnim popisom obitelji, a stranicu konvencija mjerodavnim ugovorom.

Svaki ugovor RolChata, u dokumentu ili izvan njega, slijedi konvencije: omotnicu odgovora, straničenje kursorom, ključeve idempotentnosti, zaglavlja ograničenja zahtjeva i kodove grešaka.