Skip to content

Checklist ao atualizar a documentação

Use quando o contrato da API mPm+ ou as recomendações de integração mudarem.

Passos

  • [ ] Identificar o que mudou (endpoint, campo JSON, regra de sucesso/erro, associação)
  • [ ] Atualizar as páginas de envio, pedidos, referência ou operação
  • [ ] Atualizar a especificação OpenAPI
  • [ ] Atualizar a coleção de testes (Postman/Bruno) se houver request novo
  • [ ] Registrar entrada no Changelog
  • [ ] Ajustar a versão no rodapé / menu se for release
  • [ ] Revisar se algum texto citou sistema proprietário, caminhos de código ou banco específico — remover

Mapa rápido

MudançaOnde atualizar
Novo /mpm/*Endpoints, OpenAPI, coleção de testes
Campos do pedidoPayload, exemplos
PersistênciaPersistência local
StatusStatus
Erros / retryErros, retentativas
Novo riscoRiscos

Critérios de qualidade

  • Português claro
  • Exemplos com dados fictícios
  • Sem nomes de ERPs proprietários, arquivos de implementação ou tabelas específicas de um banco
  • Sucesso = HTTP ok + status === "success" (+ data[0].id quando couber)

Documentação da API mPm+ para sistemas parceiros. Exemplos com dados fictícios.