OpenAPI

Шлюзът предоставя документ OpenAPI 3.1 на адрес:

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

Той се сглобява при стартиране на шлюза от документите, които предоставя всяка услуга: пътищата и схемите се обединяват, дубликатите получават пространство от имена на услугата, а всеки път, маркиран като вътрешен (само за mesh), се премахва. Описанията се добавят услуга по услуга; семействата, които още не са добавени, присъстват в справочника на крайните точки, но не и в документа. Докато документът не обхване целия API, смятайте справочника на крайните точки за официалния списък на семействата, а страницата с конвенциите за официалния договор.

Всеки договор на RolChat, в документа или не, следва конвенциите: обвивката на отговора, пагинацията с курсор, ключовете за идемпотентност, заглавките за лимити на заявките и кодовете за грешки.