Pular para o conteúdo principal

Fevereiro

Melhoria na documentação e nas validações do Service Layer

Esta melhoria visa elevar a qualidade da documentação técnica do Service Layer, facilitando a integração de novos parceiros e reduzindo erros de consumo da API.

Principais melhorias na documentação

  • Identificação de campos obrigatórios: implementação de marcações explícitas para campos essenciais, como "Assunto" e "ID do assunto", que anteriormente não eram visíveis como obrigatórios.
  • Enriquecimento de conteúdo:
    • Substituição de textos genéricos por descrições detalhadas.
    • Expansão das explicações na descrição principal da API.
  • Aprimoramento de retornos (totalizadores): revisão dos recursos totalizadores para indicar claramente o retorno do total de registros cadastrados.
  • Códigos de resposta: melhoria nas descrições de cenários de erro e falha (ex.: requisições não autorizadas).

Alterações no Payload e Estrutura

  • Limpeza de Campos: Remoção de campos sem funcionalidade real no payload (ex: campos que eram mapeados, mas não processados pelo sistema).
  • Valores Realistas: Substituição de exemplos de valores genéricos por valores condizentes com a realidade do negócio.