CLAV API(2)

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://localhost:8000"

host: "localhost:8000"
basePath: "/api"
schemes:
- "http"

paths:
  /entidades:
    get:
      summary: "Lista as entidades registadas"
      produces:
      - "application/javascript"
      responses:
        200:
          $ref: "#/responses/RespostaErro200"
        400:
          $ref: "#/responses/RespostaErro400"
        500:
          $ref: "#/responses/RespostaErro500"

  /entidades/{id}:
    get:
      summary: Devolve uma entidade
      description: Dado o id de uma entidade devolve a sua informação base
      produces:
      - "application/javascript"
      parameters:
        - name: id
          in: path
          required: true
          description: O id da entidade
          type: string
      responses:
        200:
          $ref: "#/responses/RespostaErro200"
        404:
          description: A entidade não existe no repositório.
        500:
          $ref: "#/responses/RespostaErro500"
  /entidades/{id}/tipologias:
    get:
      summary: Devolve as tipologias a que uma entidade pertence
      description: Dado o id de uma entidade devolve as tipologias a que pertence
      produces:
      - "application/javascript"
      parameters:
        - name: id
          in: path
          required: true
          description: O id da entidade
          type: string
      responses:
        200:
          $ref: "#/responses/RespostaErro200"
        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:
  RespostaErro200:
    description: Operação bem sucedida.
    schema:
      $ref: "#/definitions/Erro"
  RespostaErro400:
    description: Erro inesperado no cliente.
    schema:
      $ref: "#/definitions/Erro"
  RespostaErro500:
    description: Ocorreu um erro inesperado no servidor.
    schema:
      $ref: "#/definitions/Erro"