Especificação OpenAPI

Outcome: Complete the task with Especificação OpenAPI (OpenAPI Specification). User context: Uma API parceira descreve `POST /claims` e seu cabeçalho de idempotência exigido. Também lista o escopo OAuth, regras do JSON Schema, respostas 201 e de problema, e exemplos com dados falsos. CI bloqueia uma resposta que quebra a compatibilidade e que não estava documentada. Clientes gerados ainda são revisados em vez de confiados sem verificações. Technical concept or control: Especificação OpenAPI (OpenAPI Specification). Why it fits: Use-o como um contrato que as pessoas possam revisar para documentação, verificações, servidores simulados, geração de cliente e testes de compatibilidade. Do not use it when: Documentos gerados não substituem exemplos reais, testes de autorização, verificações em tempo de execução ou comportamento claro de produção. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Um documento formal ainda pode ser rascunho, release candidate ou versão final. Cheque o status e o suporte no navegador ou plataforma. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.