OpenAPI

Yhdyskäytävä tarjoaa OpenAPI 3.1 -dokumentin osoitteessa:

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

Se kootaan yhdyskäytävän käynnistyessä dokumenteista, joita kukin palvelu tuottaa: polut ja skeemat yhdistetään, kaksoiskappaleet nimetään palvelukohtaisiin nimiavaruuksiin, ja kaikki sisäisiksi (vain palveluverkon sisäisiksi) merkityt polut poistetaan. Osuudet lisätään palvelu kerrallaan; perheet, jotka eivät ole vielä tuottaneet osuuttaan, näkyvät päätepisteviitteessä mutta eivät dokumentissa. Kunnes dokumentti kattaa koko rajapinnan, pidä päätepisteviitettä perheiden virallisena luettelona ja käytäntösivua virallisena sopimuksena.

Jokainen RolChatin sopimus, olipa se dokumentissa tai ei, noudattaa käytäntöjä: kirjekuori, kursorisivutus, idempotenssiavaimet, nopeusrajaotsakkeet ja virhekoodit.