umarley / seteAPI

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

Módulo normas - GET - Obter a lista de normas cadastradas de um município #112

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/5201405 Resultado: • Retorno do HTTP é 200 - Ok • O resultado não está documentado na API. • Está usando o seguinte formato { ..., “total”: 0, result: "true" } • “outro_tipo” e “assuntos” estão nulos, verificar se é o correto com o Prof. Marcos e o Umarley image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/0 Resultado: • Retorno do HTTP é 400 – Bad request • O resultado não está documentado na API. • Está usando o seguinte formato { result: false, “messages”: “string” }

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/1111111 Resultado: • Retorno do HTTP é 404 – Not found • O resultado não está documentado na API. • Está usando o seguinte formato { result: false, “messages”: “string” }

image

nataliasou commented 2 years ago

@umarley

get:
      tags:
      - normas
      summary: Obter a lista de normas cadastradas de um município
      operationId: getNormas
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que a norma pertence.
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
              $ref: '#/definitions/allNormas'
        400:
          description: Parâmetros incorretos.
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Model:

allNormas:
    type: object
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            id:
              type: integer
            titulo:
              type: string
            id_tipo:
              type: integer
            outro_tipo:
              type: integer
            data_norma:
              type: string
              description: Data da norma no formato dd/mm/yyyy
            assuntos:
              type: array
              items:
                type: string
      total:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada