CLAV API

swagger: "2.0"

info:
  description: "Esta é a API do projeto CLAV.  Pode encontrar mais informação sobre o CLAV em [http://clav.dglab.gov.pt](http://clav.dglab.gov.pt)."
  version: "1.0.0"
  title: "CLAV API"
  termsOfService: "http://swagger.io/terms/"
  contact:
    email: "[email protected]"
  license:
    name: "Licença"
    url: "http://clav.dglab.gov.pt"

host: "clav.dglab.gov.pt"
basePath: "/api"
schemes:
- "http"

paths:
  /entidades:
    get:
      summary: "Lista as entidades registadas"
      description: "Lista as entidades registadas com possibilidade de paginação"
      parameters:
       - name: pageSize
         in: query
         description: Número de entidades devolvidas
         type: integer
       - name: pageNumber
         in: query
         description: Número da página
         type: integer
      operationId: "list"
      produces:
      - "application/json"
      responses:
        200:
          description: "Operação bem sucedida"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Entidade"
        400:
          description: "Erro na execução da listagem de entidades"
        500:
          $ref: "#/responses/RespostaErro500"

  /entidades/{id}:
    get:
      summary: Devolve uma entidade
      description: Dado o id de uma entidade devolve toda a sua informação
      parameters:
        - name: id
          in: path
          required: true
          description: O id da entidade
          type: string
      responses:
        200:
          description: Uma entidade
          schema:
            $ref: "#/definitions/Entidade"
        404:
          description: A entidade não existe no repositório.
        500:
          $ref: "#/responses/RespostaErro500"

definitions:
  Entidade:
    type: "object"
    required:
      - "sigla"
      - "designação"
    properties:
      sigla:
        type: "string"
        example: "AP"
      designação:
        type: "string"
        example: "Administração Pública"
  Erro:
    properties:
      cod:
        type: string
      mensagem:
        type: string

responses:
  RespostaErro500:
    description: Ocorreu um erro inesperado.
    schema:
      $ref: "#/definitions/Erro"