OpenAPI

Naghahatid ang gateway ng OpenAPI 3.1 document sa:

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

Binubuo ito sa pag-start ng gateway mula sa mga document na iniaambag ng bawat serbisyo: pinagsasama ang mga path at schema, binibigyan ng namespace ayon sa serbisyo ang mga duplicate, at inaalis ang anumang path na minarkahang internal (mesh-only). Idinaragdag ang mga ambag nang serbisyo kada serbisyo; lumalabas sa reference ng endpoint ang mga pamilyang hindi pa nakakapag-ambag pero wala pa sa document. Hangga’t hindi pa saklaw ng document ang buong API, ituring ang reference ng endpoint bilang awtoritatibong listahan ng mga pamilya at ang pahina ng mga kumbensyon bilang awtoritatibong kontrata.

Sinusunod ng bawat kontrata ng RolChat, nasa document man o wala, ang mga kumbensyon: ang envelope, cursor pagination, mga idempotency key, mga header ng rate limit at ang mga error code.