Adding config file for OpenAPI generation

---

data_model_headings:

  headings1:

    - '6[ ]*Data model$'

    - '7[ ]*API definitions$'

api_def_headings:

  headings1:

    - '7[ ]*API definitions$'

    - 'Annex A \(informative\)\:\nMapping of permissions for RESTful API and topic based alternative transport$'

servers:

  - url: https://localhost/fai/v1

tags:

- 'queries'

- 'subscriptions'

- 'cable_line_info'

- 'optical_network_info'

fake_data_types: False

manual_types:

  LinkType:

    description: >-

      'This data type represents a type of link'

    type: object

    required:

      - href

    properties:

      href:

        $ref: '#/components/schemas/Href'

  Href:

    description: >-

      The URI referring to the subscription.

    type: string

    format: uri

  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

info:

  contact:

    url: https://forge.etsi.org/rep/mec/gs029-fai-api

  title: 'ETSI GS MEC 029 Fixed Access Information API'

  description: The ETSI MEC ISG Fixed Access Information 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'

  '401':

    description: 'Unauthorized: used when the client did not submit credentials.'

    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'

  '406':

    description: 'Not Acceptable: used to indicate that the server cannot provide the any of the content formats supported by the client.'

    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'

  '415':

    description: 'Unsupported Media Type: used to indicate that the server or the client does not support the content type of the entity body.'

    content:

      application/problem+json:

        schema:

          $ref: '#/components/schemas/ProblemDetails'

  '422':

    description:

      'Unprocessable Entity: used to indicate that the server understands the content type of the request entity and that the

      syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an

      JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This

      error condition can also occur if the capabilities required by the request are not supported.'

    content:

      application/problem+json:

        schema:

          $ref: '#/components/schemas/ProblemDetails'

  '429':

    description: 'Too Many Requests: used when a rate limiter has triggered.'

    content:

      application/problem+json:

        schema:

          $ref: '#/components/schemas/ProblemDetails'

 No newline at end of file