API Reference · Atendimento
O responsável deve fornecer ou aprovar expressamente os contratos a documentar. Nenhum endpoint ou schema foi definido neste quadro.
Perguntas para orientar o preenchimento
- Quais operações e contratos devem ser publicados?
- Quais entradas, saídas, erros e condições de acesso foram definidos?
- Quais regras de negócio e casos de uso justificam cada operação?
- Qual documento aprovado descreve o contrato e sua versão?
Quadro de definição
| Campo | Definição |
|---|---|
| Identificação da operação | A definir pelo responsável. |
| Método e caminho | A definir pelo responsável. |
| Finalidade | A definir pelo responsável. |
| Autenticação e autorização | A definir pelo responsável. |
| Parâmetros e cabeçalhos | A definir pelo responsável. |
| Contrato de entrada | A definir pelo responsável. |
| Contrato de saída | A definir pelo responsável. |
| Códigos e contratos de erro | A definir pelo responsável. |
| Restrições expressamente definidas | A definir pelo responsável. |
| Exemplos fornecidos pelo responsável | A definir pelo responsável. |
| Versão e referência do contrato | A definir pelo responsável. |
| Casos de uso e regras relacionados | A definir pelo responsável. |
Pendências
Aguardando conteúdo e decisões dos responsáveis. Ausência de definição não significa ausência de funcionalidade, relacionamento, contrato ou regra.
Rastreabilidade
Registre autoria e referência do material fornecido ao iniciar um rascunho. A aprovação deve corresponder a uma decisão humana registrada. Consulte o guia de contribuição.
Camadas do domínio
Overview do domínio · Entidades e relacionamentos · Histórias do usuário · Casos de uso · Sitemap · API Reference · Regras de negócio