OpenAPI

O gateway serve um documento OpenAPI 3.1 em:

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

Ele é montado na inicialização do gateway a partir dos documentos que cada serviço fornece: caminhos e schemas são mesclados, duplicados recebem um namespace por serviço, e qualquer caminho marcado como interno (apenas para a malha de serviços) é removido. As contribuições são adicionadas serviço por serviço; as famílias que ainda não contribuíram aparecem na referência de endpoints, mas não no documento. Até que o documento cubra toda a superfície, trate a referência de endpoints como a lista oficial de famílias e a página de convenções como o contrato oficial.

Todo contrato do RolChat, esteja ou não no documento, segue as convenções: o envelope, a paginação por cursor, as chaves de idempotência, os cabeçalhos de limite de requisições e os códigos de erro.