OpenAPI

Šliuzas pateikia OpenAPI 3.1 dokumentą adresu:

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

Jis sudaromas paleidžiant šliuzą iš dokumentų, kuriuos pateikia kiekviena tarnyba: keliai ir schemos sujungiami, dublikatams suteikiama tarnybos vardų sritis, o bet koks kelias, pažymėtas kaip vidinis (tik tinklui tarp tarnybų), pašalinamas. Indėliai pridedami tarnyba po tarnybos; šeimos, kurios dar nepateikė savo dalies, rodomos galinių taškų žinyne, bet ne dokumente. Kol dokumentas neapima visos sąsajos, galinių taškų žinyną laikykite autoritetingu šeimų sąrašu, o konvencijų puslapį autoritetinga sutartimi.

Kiekviena RolChat sutartis, esanti dokumente ar ne, laikosi konvencijų: apvalkalo, puslapiavimo žymekliu, idempotentiškumo raktų, užklausų limitų antraščių ir klaidų kodų.