Backend > Docs > Atualizar as informações incompletas, incorretas e mal estruturadas do ENDPOINTS.md.

[ManoMax]

OVERVIEW

O escopo pode ser utilizado para uma estrutura inicial, mas o conteúdo encontra-se incompleto, incorreto e mal estruturado.

• Incompleto:

  1. Existem Params que estão sendo utilizados e cobrados em algumas rotas, mas não estão sendo explicitados na documentação.
  2. Apesar de haver descrição do que se trata cada um, os atributos podem ter os seus tipos explicitados. Ex: String, Number, Date, Object, etc.
  3. Para o caso de Object, esse exemplo pode ser utilizado para tornar a informação completa: Object = { attr1: String, attr2: String, attr3: Number, attr4: Date, ... };
  4. Algumas rotas existem no sistema, porém não estão no documento: Ex: GET /ej e GET /ej/:id
  5. Apesar de ser citado que o Authentication (from Middleware) é utilizado para as funções (isLeadership, authorizedUser, etc), não é explicitado que esse Authentication é passado via Header com nome do atributo Authorization;
  6. Nos campos Expected responses, poderia-se expressar, ao invés da descrição do resultados da rota, o objeto de resposta da requisição (ex: member: { name, email, phone, ...}), juntamente com o número de resposta esperada;
  7. Nos campos Possible errors, poderia-se expressar alguns erros comuns em relação a autenticação e autorização, além do Internal error;
  8. Além do tipo dos atributos, poderia-se ser citada a obrigatoriedade desses campos.

• Incorreto:

  1. Algumas rotas foram adicionadas ao documento, porém não existem. Ex: PATCH e DELETE das rotas de EJ;
  2. A documentação exige o Id da EJ em alguns Middlewares, no entanto esse Id não é utilizado no Sistema (apenas o token do membro, passado pelo Authorization via Header, está sendo utilizado no sistema);

• Mal Estruturado:

  1. Como dito anteriormente, alguns campos a mais poderiam ser adicionados nas tabelas, como o tipo e obrigatoriedade dos atributos.
  2. Ao invés de utilizar icones nos títulos de 🛠️ Methods, ⬆ POST, ⬇️ GET, etc, poriamos adicionar ícones somente nos títulos referentes a Middleware, Project, Member, Link, News e EJ, deixando tudo mais clean;
  3. Juntamente com o Method das rotas (GET, POST, PATCH, DELETE, etc), os caminhos das rotas também poderiam ser citadas. Ex: POST /project ; PATCH /project/:id, etc.

TASKS

• Explicitar, na documentação, todos os Params que estão sendo utilizados nas rotas.
• Explicitar os tipos dos atributos, juntamente com a descrição do mesmo. Ex: String, Number, Date, Object, etc.
• ...