OpenAPI

Die poort bedien ’n OpenAPI 3.1-dokument by:

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

Dit word by die opstart van die poort saamgestel uit die dokumente wat elke diens bydra: paaie en skemas word saamgevoeg, duplikate kry ’n naamruimte volgens diens, en enige pad wat as intern (slegs vir die maas) gemerk is, word verwyder. Bydraes word diens vir diens bygevoeg; families wat nog nie bygedra het nie, verskyn in die eindpuntverwysing maar nie in die dokument nie. Totdat die dokument die hele oppervlak dek, behandel die eindpuntverwysing as die gesaghebbende lys van families en die konvensiesbladsy as die gesaghebbende kontrak.

Elke RolChat-kontrak, in die dokument of nie, volg die konvensies: die omslag, wyserpaginering, idempotensiesleutels, tempolimietopskrifte en die foutkodes.