Contratos da API
Aguardando definição
Nenhum endpoint ou contrato está definido neste quadro. As páginas de API Reference estão preparadas para receber material fornecido ou expressamente aprovado pelos responsáveis.
Como documentar um contrato
O responsável indica as operações, sua versão e a referência do material. Registre método, caminho, parâmetros, autenticação, autorização, entradas, saídas, erros e restrições somente quando definidos. Mantenha o que faltar como pendência.
Não complete contratos por convenção ou inferência de código. Exemplos precisam ser fornecidos ou aprovados. A ausência de uma definição neste portal não comprova ausência de funcionalidade na aplicação.
Revisão e rastreabilidade
Cada página preenchida deve identificar o responsável, o material recebido e seu estado editorial. A aprovação deve ser expressa e registrada. Veja o guia de contribuição.