Pular para o conteúdo principal

GuiasConvenções

Convenções

HTTPS, JSON, /api/v1 no path, UUIDs, timestamps UTC.

RegraDetalhe
ProtocoloHTTPS em produção. JSON UTF-8 no corpo.
VersãoNo path: /api/v1. Não no header.
IDsid de recurso é UUID.
TimestampsISO-8601 UTC (2026-08-20T15:00:00.000Z).
Nullnull explícito = sem valor. Omitir no PATCH = não mudar.
Chaves extrasRejeitadas na escrita (additionalProperties: false).
Chaves desconhecidas na respostaIgnore. Campos aditivos podem aparecer em /api/v1.
MétodosGET lista/get, POST cria, PATCH atualiza. DELETE só em webhooks e em tags/participantes do inbox.