umarley / seteAPI

BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Módulo Alunos - POST - incluir uma escola para o aluno #167

Open glcalil-ufg opened 2 years ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

POST https://sete.transportesufg.eng.br/aluno/5201405/263189/escola

Path:

codigo_cidade: 5201405

id_aluno: 263189

Body:

Resultado do experimento:

  • Retorno do HTTP está 201 (CREATED)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ result: "true", messages: {“id”: <>} }


Exemplo de requisição:

POST https://sete.transportesufg.eng.br/aluno/5201405/263189/escola

1 - Campos invalidos;

2 - Aluno já vinculado a uma escola;

3 - Codigo cidade errado;

Resultado do experimento:

  • Retorno do HTTP está 400 (BAD REQUEST) e 403 (FORBIDDEN)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ result: "false", messages : “...” }




glcalil-ufg commented 1 year ago

@umarley

post:
      tags:
      - alunos
      summary: Incluir uma escola para o aluno
      operationId: associarEscolaAluno
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade do aluno a ser atualizado
        required: true
      - in: path
        name: id_aluno
        type: integer
        description: ID do aluno a ser atualizado
        required: true
      - in: body
        name: body
        description: ID da escola a ser associada ao aluno
        required: true
        schema:
          $ref: '#/definitions/associarEscolaAluno'
      responses:
        201:
          description: Operacão realizada com sucessos
          schema: 
            $ref: '#/definitions/CreateResponse'
        400:
          description:  Parâmetros invalidos
        404:
          description: Não encontrado
      security:
      - api_key: []

Modelo Body

associarEscolaAluno:
    required:
     - id_escola
    type: object
    properties:
      id_escola:
        type: integer