umarley / seteAPI

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

Módulo Rotas - POST - Vincular uma ou várias escolas no cadastro da rota #175

Open glcalil-ufg opened 2 years ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

POST https://sete.transportesufg.eng.br/rotas/5201405/73170/escolas

Path:

codigo_cidade: 5201405

id_rota: 73170

Body:

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:

POST https://sete.transportesufg.eng.br/rotas/5201405/73170/escolas

1 - Campo vazio;

2 - Codigo cidade errado;

Resultado do experimento:

  • Retorno do HTTP está 400 (BAD REQUEST)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

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



glcalil-ufg commented 2 years ago

@umarley

 post:
      tags:
      - rotas
      summary: Vincular uma ou várias escolas no cadastro da rota
      operationId: associarEscolaRota
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade da rota a ser atualizada
        required: true
      - in: path
        name: id_rota
        type: integer
        description: ID da rota a ser atualizada
        required: true
      - in: body
        name: body
        description: JSON contendo as escolas que serão vinculados a rota
        required: true
        schema:
          $ref: '#/definitions/VariasEscolas'
      responses:
        201:
          description: Operacão realizada com sucesso
          schema:
            $ref: '#/definitions/CreateResponseArray'
        400:
          description: Parâmetros inválidos
        404:
          description: Não encontrado
      security:
      - api_key: []

Modelo

 CreateResponseArray:
    type: object
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            result:
              type: boolean
            messages:
              type: string
              description: Mensagem de sucesso ou erro
      total: 
        type: integer
      result:
        type: boolean