umarley / seteAPI

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

Módulo Escolas - POST - Associa várias rotas a uma escola #145

Open nataliasou opened 2 years ago

nataliasou commented 2 years ago

image Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/rotas
Body: image Resultado do experimento: • Retorno do HTTP está 200 - OK • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... } • Verificar se era para ter retornado algum tipo de erro. image

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/rots
Body: image Resultado do experimento: • Retorno do HTTP está 200 - OK • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... } • Verificar se era para ter retornado algum tipo de erro. image

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/0/rotas
Body: image Resultado do experimento: • Retorno do HTTP está 200 - OK • Não está documentado na API • Verificar se era para ter retornado algum tipo de erro. image

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/0/52278827/rotas
Body: image Resultado do experimento: • Retorno do HTTP está 403 - Forbidden • Não está documentado na API • Está usando o seguinte formato { result: "false", “messages”: ... } image Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/rotas
Body: image Resultado do experimento: • Retorno do HTTP é 200 - OK • Não está documentado na API • Verificar se deveria ter retornado isso mesmo image

nataliasou commented 2 years ago

@umarley

post:
      tags:
      - escolas
      summary: Associa várias rotas a uma escola
      operationId: associarRotaEscola
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade da escola a ser atualizada
        required: true
      - in: path
        name: id_escola
        type: integer
        description: ID da escola que as rotas serão associadas
        required: true
      - in: body
        name: body
        description: JSON contendo os id's das rotas  que serão associadas
        required: true
        schema:
          $ref: '#/definitions/VariasRotas'
      responses:
        201:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/CreateResponseVariasRotas'
        400:
          description: Parâmetros inválidos
        404:
          description: Recurso não encontrado
      security:
      - api_key: []

Response:

CreateResponseVariasRotas:
    type: object
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            id_rota:
              type: string
            result:
              type: boolean
            messages:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
      total:
        type: integer
      result:
        type: boolean