Commit d228556e authored by Miguel Angel Reina Ortega's avatar Miguel Angel Reina Ortega
Browse files

Adding config file for OpenAPI generation

parent 3c503746
Loading
Loading
Loading
Loading
Loading
+98 −0
Original line number Diff line number Diff line
data_model_headings:
  headings1:
    - '^6 Data Model$'
    - '^7 API definition$'

api_def_headings:
  headings1:
    - '^7 API definition$'
    - 'Annex A \(informative\)\:\nComplementary material for API utilization$'
    
servers:
  - url: https://localhost/iot/v1

tags:
- 'reg-dev'
- 'reg-iot-plat'

fake_data_types: false
manual_types:
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          format: uint32
          description: The HTTP status code for this occurrence of the problem
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type: string
          format: uri
          description: A URI reference that identifies the specific occurrence of the problem

    SerializerType:
      x-etsi-ref: 8.1.6.3
      type: string
      enum:
      - JSON
      - XML
      - PROTOBUF3
      x-etsi-mec-extensible: true
      x-etsi-mec-enumeration-table:
      - value: JSON
        description: Javascript object notation [9]
      - value: XML
        description: eXtensible Mark-up Language version 1.1 [10]
      - value: PROTOBUF3
        description: Protocol buffers version 3 [i.3]

info:
  contact:
    url: https://forge.etsi.org/rep/mec/gs033-iot-api
  title: 'ETSI GS MEC 033 IoT API'
  description: >
    ETSI GS MEC 033 IoT API described using OpenAPI.
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'

responses:
  '200':
    description: 'OK'
  '204':
    description: 'No Content'
  '400':
    description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'
    content:
      application/problem+json:
        schema:
          $ref: '#/components/schemas/ProblemDetails'
  '403':
    description: 'Forbidden: operation is not allowed given the current status of the resource.'
    content:
      application/problem+json:
        schema:
          $ref: '#/components/schemas/ProblemDetails'
  '404':
    description: 'Not Found: used when a client provided a URI that cannot be mapped to a valid resource URI.'
    content:
      application/problem+json:
        schema:
          $ref: '#/components/schemas/ProblemDetails'
  '412':
    description:
      'Precondition failed: used when a condition has failed during conditional requests, e.g. when
      using ETags to avoid write conflicts when using PUT'
    content:
      application/problem+json:
        schema:
          $ref: '#/components/schemas/ProblemDetails'
 No newline at end of file