umarley / seteAPI

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

Módulo parametros - GET - Obter todos os parâmetros do município #111

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image Exemplo de requisição: GET https://sete.transportesufg.eng.br/parametros/5201405 Resultado: • Retorno do HTTP está 200 (OK) • O resultado não está definido na documentação da API. • Está usando o seguinte formato { ..., “total”: 0, result: "true" } • Descrição detaçhada está como NULL, verificar se é o correto com o Prof. Marcos e o Umarley

image

nataliasou commented 1 year ago

@umarley

get:
      tags:
      - parametros
      summary: Obter todos os parâmetros do municipio
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código da cidade
        type: integer
        required: true
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
              $ref: '#/definitions/Parametro'
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Model:

 Parametro:
    type: object
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            codigo_parametro:
              type: string
            valor_padrao:
              type: string
            valor: 
              type: string
            descricao_parametro:
              type: string
            descricao_detalhada:
              type: string
      total:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada