openapi-sample.yaml

openapi: 3.0.0
info:
  version: "0.0.1"
  title: |
    Core Vocabularies API
  description: |
    Dictionaries are versioned key-value store that you can
      retrieve via API. For each dictionary you can:
      - get metadata infos
      - retrieve a paged subset
      - get a single entry via an unique key
      - find entries by a given key (which could not be unique)

      Dictionary structure is the following:
      - Dictionary: has a single name and many versions
        - Table: it's a specific version of a dictionary. May
            expire
            - Entry: it's the actual data contained in a table.

    Despite http://zalando.github.io/restful-api-guidelines/index.html#160
        we use pagination as it's more intuitive for this use case.
  termsOfService: 'http://swagger.io/terms/'
  contact:
    email: [email protected]
    name: Roberto Polli
    url: https://twitter.com/ioggstream
  x-audience: |
    Definire qui l'audience delle API
  x-api-id: b9ec7026-5da5-4db6-a959-fce72db5de64
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: admins
    description: Create and update dictionaries
  - name: public
    description: Retrieve dictionaries
servers:
# Added by API Auto Mocking Plugin
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/robipolli/core-vocabularies/0.0.1

paths:
  /dictionaries:
    get:
      summary: Get informations about provided dictionaries.
      description: |
        Shows a list of supported dictionaries.
      operationId: getDictionaries
      tags:
      - public
      responses:
        '200':
          description: |
            A list of Dictionaries.
          headers:
            X-Rate-Limit-Reset:
              $ref: '#/components/headers/X-Limit'
            X-Test:
              $ref: 'https://teamdigitale.github.io/openapi/headers/v3.yaml#X-Rate-Limit-Reset'
          content:
            application/json:
              schema:
                object
components:
  headers:
    X-Limit:
      description: The number of remaining requests in the current period
      schema:
        type: integer
        format: int32