Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recriar rota PATCH para equipamentos (v2/equipments) #78

Open
5 tasks
oxechicao opened this issue Jun 17, 2020 · 0 comments
Open
5 tasks

Recriar rota PATCH para equipamentos (v2/equipments) #78

oxechicao opened this issue Jun 17, 2020 · 0 comments
Labels

Comments

@oxechicao
Copy link
Contributor

oxechicao commented Jun 17, 2020

Objetivo

Eu como pessoa usuária da API
Quero efetuar consultas de equipamentos através da v2
Para que eu possa consultar através das rotas na nova arquitetura

Contexto

O que originou

As rotas dos equipamentos foram feitas em uma forma não convencional criadas de acordo com a necessidade.
Para se alinhar à nova arquitetura, uma refatoração para a v2 da API é necessária.

Solução Proposta

  • Incorporar a atualização de equipamentos na estrutura da arquitetura v2

Fora de Contexto

Criar rotas de POST, PUT, GET, DELETE

Critérios de aceitação

  • Dado que eu quero atualizar determinados campos de documentos a partir do envio de um array, contendo objetos que possuem o campo _id
    Quando efetuar o PATCH na rota /v2/equipments
    Então atualizar com sucesso os campos no banco de dados, receber uma resposta com status 200

  • Dado que envio um documento contendo somente campos não obrigatório
    Quando efetuar o PATCH na rota /v2/equipments
    Então modificar somente o campo enviado

  • Dado que algum campo esteja errado na lista de documentos
    Quando tentar atualizar os documentos
    Então retornar status 400 e um json contendo um dicionário chave:valor onde a chave é o _id do documento que contém o erro e o valor sendo os erros descritos na validação utilizando marshmallow

  • Dado que algum documento na lista contém um _id inválido.
    Quando tentar atualizar os documentos
    Então retornar status 400 e um json contendo um dicionário chave:valor onde a chave é o _id do documento que contém o erro e o valor o texto Código de ID inválido

  • Dado que algum documento na lista contém um _id inexistente na base de dados.
    Quando tentar atualizar os documentos
    Então retornar status 400 e um json contendo um dicionário chave:valor onde a chave é o _id do documento que contém o erro e o valor o texto Nenhum item foi encontrado no banco com o ID informado

Observações

JSON exemplo de modelo do equipamento

{
    "numero_de_serie": "string",
    "nome_equipamento": "string",
    "status": "string",
    "numero_do_patrimonio": "string",
    "tipo": "string",
    "marca": "string",
    "modelo": "string",
    "fabricante": "string",
    "municipio_origem": "string",
    "nome_instituicao_origem": "string",
    "tipo_instituicao_origem": "string",
    "nome_responsavel": "string",
    "contato_responsavel": "string",
    "created_at": "date",
    "updated_at": "date",
    "deleted_at": "date"
}
@oxechicao oxechicao added back v2 Relase 2.x.x labels Jun 17, 2020
@clarapnmaximo clarapnmaximo removed the v2 Relase 2.x.x label Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants