OpenAPI

Brama udostępnia dokument OpenAPI 3.1 pod adresem:

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

Jest składany przy starcie bramy z dokumentów dostarczanych przez poszczególne usługi: ścieżki i schematy są scalane, duplikaty otrzymują przestrzeń nazw usługi, a każda ścieżka oznaczona jako wewnętrzna (tylko w sieci usług) jest usuwana. Kolejne usługi dodają swoje części stopniowo; rodziny, które jeszcze tego nie zrobiły, widać w dokumentacji endpointów, ale nie w dokumencie. Dopóki dokument nie obejmuje całego API, traktuj dokumentację endpointów jako wiążącą listę rodzin, a stronę konwencji jako wiążący kontrakt.

Każdy kontrakt RolChat, w dokumencie lub poza nim, stosuje konwencje: kopertę odpowiedzi, paginację kursorową, klucze idempotentności, nagłówki limitów żądań i kody błędów.