umarley / seteAPI

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

Módulo normas - GET - Obter dados de uma norma específica #113

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/5201405/1 Resultado: • Retorno do HTTP é 200 (OK) • O resultado não está na documentação da API • Está usando o seguinte formato • { ...,result: "true" }

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/5201405/11111111111 Resultado: • Retorno do HTTP é 500 – Internal Server error, quando coloca um id de norma que não existe. • O resultado não está na documentação da API • Não possui um formato padronizado image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/normas/assuntos Resultado: • Retorno do HTTP é 200 (OK) • O resultado não está na documentação da API • Está usando o seguinte formato • { result: false, “messages”: “string” } image

nataliasou commented 2 years ago

@umarley

get:
      tags:
      - normas
      summary: Obter dados de uma norma específica
      operationId: getNormaId
      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
      - in: path
        name: id_norma
        description: ID da norma que se deseja consultar
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
              $ref: '#/definitions/NormaEspecifica'
        500:
          description: Internal Server Error.
      security:
      - api_key: []

Model:

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

API revisada e documentação atualizada