OpenAPI

De gateway biedt een OpenAPI 3.1-document aan op:

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

Het wordt bij het opstarten van de gateway samengesteld uit de documenten die elke service aanlevert: paden en schema’s worden samengevoegd, duplicaten krijgen een namespace per service, en elk pad dat als intern (alleen voor de mesh) is gemarkeerd, wordt verwijderd. Bijdragen worden service voor service toegevoegd; families die nog niets hebben aangeleverd, staan wel in de endpointreferentie maar niet in het document. Zolang het document niet alles dekt, geldt de endpointreferentie als de gezaghebbende lijst van families en de conventiepagina als het gezaghebbende contract.

Elk RolChat-contract, in het document of niet, volgt de conventies: de envelop, cursorpaginering, idempotentiesleutels, headers voor snelheidslimieten en de foutcodes.