umarley / seteAPI

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

Módulo Rotas - GET - Obter todos os alunos associados a rota #132

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73430/alunos

Resultado do experimento:

  • Retorno do HTTP está 200 (OK)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ ..., total: <valor>, result: "true" }


Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73170/alunos

Resultado do experimento:

  • Retorno do HTTP está 404 (NOT FOUND)

  • O resultado está diferente do esperado na API

  • Resultado encontrado para rotas não existentes ou sem alunos

  • Está usando o seguinte formato 

{ ..., total: <valor>, result: "false" }


Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/52014099995/73170/alunos

Resultado do experimento:

  • Retorno do HTTP está 404 (NOT FOUND)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

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





glcalil-ufg commented 1 year ago

@umarley

  get:
      tags:
      - rotas
      summary: Obter todos os alunos associados a rota
      description: Retornar os alunos associados a rota
      operationId: getAlunosRota
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade que a rota pertence
        required: true
      - name: id_rota
        in: path
        description: ID da rota que se deseja obter os alunos vinculados
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/RotaAlunos'
        400:
          description: Parâmetros inválidos
        404:
          description: Alunos não encontrados
      security:
      - api_key: []

Modelo

RotaAlunos:
    type: object
    properties:
      data: 
        type: array
        items:
          id_rota: 
            type: integer
          id_aluno:
            type: integer
          codigo_cidade:
            type: integer
          nome:
            type: string
          cpf:
            type: string
          loc_latitude:
            type: string
          loc_longitude: 
            type: string
          nivel: 
            type: integer
          turno:
            type: integer
      total:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada...