ApplicationPattern.yaml

openapi: 3.0.0
info:
  title: ApplicationName
  version: 1.0.0

paths:
########################################################################################################################
#   Service Layer - Individual Part - Following paths can be taken as a base for individualization
########################################################################################################################
  /v1/bequeath-your-data-and-die:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: bequeathYourDataAndDie
      summary: 'Initiates process of embedding a new release'
      tags:
        - IndividualServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - new-application-name
                - new-application-release
                - new-application-address
                - new-application-port
              properties:
                new-application-name:
                  type: string
                  description: >
                    'Name of application that shall be target of the handover process
                    find or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-nr-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                new-application-release:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that shall be target of the handover process
                    find or update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-nr-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                new-application-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of application that shall be target of the handover process
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of application that shall be target of the handover process
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                new-application-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of application that shall be target of the handover process
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                new-application-name: 'NewApplicationName'
                new-application-release: '2.0.0'
                new-application-address:
                  ip-address:
                    ipv-4-address: '1.1.3.8'
                new-application-port: 3008
      responses:
        '204':
          description: 'Process of embedding a new release initiated'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-im-000/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:

        # individual callbacks to be added here 

        PromptForBequeathingDataCausesRequestForBroadcastingInfoAboutServerReplacement:
          https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - old-application-release-number
                        - new-application-release-number
                        - new-application-address
                        - new-application-port
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        old-application-release-number:
                          type: string
                          description: >
                            'Old release number = current release number of the application requested to bequeath its data and die
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        new-application-release-number:
                          type: string
                          description: >
                            'Future release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-nr-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                        new-application-address:
                          type: object
                          minProperties: 1
                          maxProperties: 1
                          additionalProperties: false
                          properties:
                            ip-address:
                              type: object
                              minProperties: 1
                              additionalProperties: false
                              properties:
                                ipv-4-address:
                                  type: string
                                  description: >
                                    'Future IPv4 address
                                    from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                            domain-name:
                              type: string
                              description: >
                                'Future domain name
                                from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                        new-application-port:
                          type: integer
                          description: >
                            'Future port
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-nr-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
                      example:
                        application-name: 'RegistryOffice'
                        old-application-release-number: '1.0.0'
                        new-application-release-number: '2.0.0'
                        new-application-address:
                          ip-address:
                            ipv-4-address: '1.1.3.8'
                        new-application-port: 3008
              responses:
                '204':
                  description: 'Will broadcast server replacement'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        PromptForBequeathingDataCausesRequestForDeregisteringOfOldRelease:
          https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - application-release-number
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        application-release-number:
                          type: string
                          description: >
                            'Own release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                      example:
                        application-name: 'BadApplication'
                        application-release-number: '1.0.0'
              responses:
                '204':
                  description: 'Application deregistered'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        PromptingNewReleaseForUpdatingServerCausesRequestForBroadcastingInfoAboutBackwardCompatibleUpdateOfOperation:
          https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-003/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - application-release-number
                        - old-operation-name
                        - new-operation-name
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        application-release-number:
                          type: string
                          description: >
                            'Own release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        old-operation-name:
                          type: string
                          description: >
                            'Name of the deprecated operation
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-*/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
                        new-operation-name:
                          type: string
                          description: >
                            'Name of the replacing operation
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-*/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
                      example:
                        application-name: 'RegistryOffice'
                        application-release-number: '2.0.0'
                        old-operation-name: '/v1/register-application'
                        new-operation-name: '/v2/register-application'
              responses:
                '204':
                  description: 'Will broadcast operation update'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'

  /v1/start-application-in-generic-representation:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: startApplicationInGenericRepresentation
      summary: 'Starts application in generic representation'
      tags:
        - IndividualServices
      security:
        - apiKeyAuth: []
      responses:
        '200':
          description: 'Start mask provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - response-value-list
                  - consequent-action-list
                properties:
                  response-value-list:
                    type: array
                    minItems: 1
                    maxItems: 1
                    items:
                      type: object
                      required:
                        - field-name
                        - value
                        - datatype
                      properties:
                        field-name:
                          type: string
                          enum:
                            - 'applicationName'
                        value:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        datatype:
                          type: string
                          enum:
                            - 'string'
                    example:
                      - field-name: 'applicationName'
                        value: 'OwnApplicationName'
                        datatype: 'string'
                  consequent-action-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                        - label
                        - request
                        - display-in-new-browser-window
                      properties:
                        label:
                          type: string
                          description: >
                            'Label that shall be presented on the button
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/label]'
                        request:
                          type: string
                          description: >
                            'Request that shall be called, when button gets pressed
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-configuration/request]'
                        input-value-list:
                          type: array
                          uniqueItems: true
                          items:
                            type: object
                            required:
                              - field-name
                            properties:
                              field-name:
                                type: string
                                description: >
                                  'Name of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/name]'
                              unit:
                                type: string
                                description: >
                                  'Unit of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/unit]'
                        display-in-new-browser-window:
                          type: boolean
                          description: >
                            'True in case Request shall be represented in a new browser window
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/display-in-new-browser-window]'
                    example:
                      - label: 'Inform about Application'
                        request: 'https://1.1.4.1:4001/v1/inform-about-application-in-generic-representation'
                        display-in-new-browser-window: false
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-is-000/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'

########################################################################################################################
#   Service Layer - Basic Part - Following paths must be copied into every application
########################################################################################################################
  /v1/register-yourself:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: registerYourself
      summary: 'Initiates registering at the currently active RegistryOffice'
      description: 'Shall also automatically execute without receiving any request every time the application starts'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              required:
                - registry-office-application
                - registry-office-application-release-number
                - registration-operation
                - registry-office-address
                - registry-office-port
              properties:
                registry-office-application:
                  type: string
                  description: >
                    'If body provided, name of RegistryOffice application
                    find or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-ro-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                registry-office-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'If body provided, release of RegistryOffice application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-ro-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                registration-operation:
                  type: string
                  minLength: 6
                  description: >
                    'If body provided, operation for registering
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                registry-office-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'If body provided, IPv4 address of RegistryOffice application
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'If body provided, domain name of RegistryOffice application
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                registry-office-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'If body provided, port of RegistryOffice application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
                own-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'If provided, own IPv4 address, which has to be documented in the TcpServer (but not be directly used for formulating the callback)
                            update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'If provided, own domain name, which has to be documented in the TcpServer (but not be directly used for formulating the callback)
                        update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]'
                own-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'If provided, own TCP port, which has to be documented in the TcpServer (but not be directly used for formulating the callback)
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]'
              example:
                registry-office-application: 'RegistryOffice'
                registry-office-application-release-number: '2.0.0'
                registration-operation: '/v1/register-application'
                registry-office-address:
                  ip-address:
                    ipv-4-address: '1.1.3.8'
                registry-office-port: 3008
                own-address:
                  ip-address:
                    ipv-4-address: '1.1.4.1'
                own-port: 4001
      responses:
        '204':
          description: 'Will register at the RegistryOffice'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-000/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        PromptForRegisteringCausesRegistrationRequest:
          https://{$request.body#registry-office-address/ip-address/ipv-4-address or $request.body#registry-office-address/domain-name}:{$request.body#registry-office-port}{$request.body#registration-operation}:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - application-release-number
                        - embedding-operation
                        - client-update-operation
                        - application-address
                        - application-port
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        application-release-number:
                          type: string
                          description: >
                            'Own release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        embedding-operation:
                          type: string
                          description: >
                            'Name of service for initiating embedding process
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-001/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
                        client-update-operation:
                          type: string
                          description: >
                            'Name of service for broadcasting server changes
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-007/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
                        application-address:
                          type: object
                          minProperties: 1
                          maxProperties: 1
                          additionalProperties: false
                          properties:
                            ip-address:
                              type: object
                              minProperties: 1
                              additionalProperties: false
                              properties:
                                ipv-4-address:
                                  type: string
                                  description: >
                                    'Own IPv4 address (shall be taken (if available) from the stored data, but not from the initiating request body, because attribute is not mandatory in the request body definition)
                                    from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]'
                            domain-name:
                              type: string
                              description: >
                                'Own domain name (shall be taken (if available) from the stored data, but not from the initiating request body, because attribute is not mandatory in the request body definition)
                                from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]'
                        application-port:
                          type: integer
                          description: >
                            'Own TCP port (shall be taken from the stored data, but not from the initiating request body, because attribute is not mandatory in the request body definition)
                            from[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]'
                      example:
                        application-name: 'OwnApplicationName'
                        application-release-number: '1.0.0'
                        embedding-operation: '/v1/embed-yourself'
                        client-update-operation: '/v1/update-client'
                        application-address:
                          ip-address:
                            ipv-4-address: '1.1.4.1'
                        application-port: 4001
              responses:
                '204':
                  description: 'Application registered'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/embed-yourself:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: embedYourself
      summary: 'Embed yourself into the MBH SDN application layer'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - registry-office-application
                - registry-office-application-release-number
                - relay-server-replacement-operation
                - relay-operation-update-operation
                - deregistration-operation
                - registry-office-address
                - registry-office-port
                - old-release-address
                - old-release-port
              properties:
                registry-office-application:
                  type: string
                  description: >
                    'Name of RegistryOffice application
                    find or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-ro-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                registry-office-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of RegistryOffice application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-ro-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                relay-server-replacement-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for requesting for broadcasting a new server address
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                relay-operation-update-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for requesting for broadcasting a backward compatible replacement of an operation
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-003/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                deregistration-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for deregistering from the application layer
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-ro-2-0-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                registry-office-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of RegistryOffice application
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of RegistryOffice application
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                registry-office-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of RegistryOffice application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
                old-release-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of currently running old release of the same application
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of currently running old release of the same application
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                old-release-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of currently running old release of the same application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                registry-office-application: 'RegistryOffice'
                registry-office-application-release-number: '2.0.0'
                relay-server-replacement-operation: '/v1/relay-server-replacement'
                relay-operation-update-operation: '/v1/relay-operation-update'
                deregistration-operation: '/v1/deregister-application'
                registry-office-address:
                  ip-address:
                    ipv-4-address: '1.1.3.8'
                registry-office-port: 3008
                old-release-address:
                  ip-address:
                    ipv-4-address: '1.1.3.1'
                old-release-port: 3001
      responses:
        '204':
          description: 'Will embed into the MBH SDN application layer'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-001/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        PromptForEmbeddingCausesRequestForBequeathingData:
          https://[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name or /core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]:[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port][/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-or-1-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - new-application-name
                        - new-application-release
                        - new-application-address
                        - new-application-port
                      properties:
                        new-application-name:
                          type: string
                          description: >
                            'Own application name
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        new-application-release:
                          type: string
                          description: >
                            'Own release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        new-application-address:
                          type: object
                          minProperties: 1
                          maxProperties: 1
                          additionalProperties: false
                          properties:
                            ip-address:
                              type: object
                              minProperties: 1
                              additionalProperties: false
                              properties:
                                ipv-4-address:
                                  type: string
                                  description: >
                                    'Own IPv4 address
                                    from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]'
                            domain-name:
                              type: string
                              description: >
                                'Own domain-name
                                from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]'
                        new-application-port:
                          type: integer
                          description: >
                            'Own TCP port
                            from[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]'
                      example:
                        new-application-name: 'OwnApplicationName'
                        new-application-release: '2.0.0'
                        new-application-address:
                          ip-address:
                            ipv-4-address: '1.1.4.1'
                        new-application-port: 4001
              responses:
                '204':
                  description: 'Process of embedding a new release initiated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: >
                          'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/redirect-service-request-information:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: redirectServiceRequestInformation
      summary: 'Offers configuring the client side for sending service request information'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - service-log-application
                - service-log-application-release-number
                - service-log-operation
                - service-log-address
                - service-log-port
              properties:
                service-log-application:
                  type: string
                  description: >
                    'Name of application that shall record the service requests
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-eatl-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                service-log-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that shall record the service requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-eatl-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                service-log-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for recording the service requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-eatl-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                service-log-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of application that shall record the service requests
                            update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-eatl-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of application that shall record the service requests
                        update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-eatl-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                service-log-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of application that shall record the service requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-eatl-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                service-log-application: 'ExecutionAndTraceLog'
                service-log-application-release-number: '2.0.0'
                service-log-operation: '/v1/record-service-request'
                service-log-address:
                  ip-address:
                    ipv-4-address: '1.1.3.10'
                service-log-port: 3010
      responses:
        '204':
          description: 'Information about service requests will be send to the new target'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        ServiceRequestCausesLoggingRequest:
          https://{$request.body#service-log-address/ip-address/ipv-4-address or $request.body#service-log-address/domain-name}:{$request.body#service-log-port}{$request.body#service-log-operation}:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - x-correlator
                        - trace-indicator
                        - user
                        - originator
                        - application-name
                        - release-number
                        - operation-name
                        - response-code
                      properties:
                        x-correlator:
                          type: string
                          description: 'UUID for the service execution flow that allows to correlate requests and responses; as defined in all service headers [x-correlator]'
                        trace-indicator:
                          type: string
                          description: 'From [parameters/trace-indicator]; Empty string sent by external applications to be replaced by 1'
                        user:
                          type: string
                          description: 'User identifier from the system starting the service call; as defined in all service headers [user]'
                        originator:
                          type: string
                          description: 'ApplicationName on the client side; as defined in all service headers [originator]'
                        application-name:
                          type: string
                          description: '[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        release-number:
                          type: string
                          description: '[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        operation-name:
                          type: string
                          description: '[/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-*/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
                        response-code:
                          type: integer
                          description: 'Response code sent to [originator] after invoking [operation-name] at [application-name]'
                        timestamp:
                          type: string
                          description: 'Date and time when [application-name] sent response to [originator]; only to be provided, if [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-eatl-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/detailed-logging-is-on] == true'
                        stringified-body:
                          type: string
                          description: 'Stringified body of the request addressed from [originator] to [application-name]; only to be provided, if [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-eatl-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/detailed-logging-is-on] == true'
                        stringified-response:
                          type: string
                          description: 'Stringified response sent from [application-name] to [originator]; only to be provided, if [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-eatl-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/detailed-logging-is-on] == true'
                      example:
                        x-correlator: '550e8400-e29b-11d4-a716-446655440000'
                        trace-indicator: '1.1'
                        user: 'User Name'
                        originator: 'RegistryOffice'
                        application-name: 'OwnApplicationName'
                        release-number: '1.0.0'
                        operation-name: '/v1/embed-yourself'
                        response-code: 500
                        timestamp: '2010-11-20T14:00:00+01:00'
                        stringified-body: ''
                        stringified-response: ''
              responses:
                '204':
                  description: 'Request recorded'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/redirect-oam-request-information:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: redirectOamRequestInformation
      summary: 'Offers configuring the client side for sending OaM request information'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - oam-log-application
                - oam-log-application-release-number
                - oam-log-operation
                - oam-log-address
                - oam-log-port
              properties:
                oam-log-application:
                  type: string
                  description: >
                    'Name of application that shall record the OaM requests
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-ol-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                oam-log-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that shall record the OaM request
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-ol-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                oam-log-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for recording the OaM requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-ol-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                oam-log-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of application that shall record the OaM requests
                            update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-ol-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of application that shall record the OaM requests
                        update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-ol-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                oam-log-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of application that shall record the OaM requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-ol-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                oam-log-application: 'OamLog'
                oam-log-application-release-number: '2.0.0'
                oam-log-operation: '/v1/record-oam-request'
                oam-log-address:
                  ip-address:
                    ipv-4-address: '1.1.3.11'
                oam-log-port: 3011
      responses:
        '204':
          description: 'Information about OaM requests will be send to the new target'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-003/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        OamRequestCausesLoggingRequest:
          https://{$request.body#oam-log-address/ip-address/ipv-4-address or $request.body#oam-log-address/domain-name}:{$request.body#oam-log-port}{$request.body#oam-log-operation}:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - release-number
                        - method
                        - resource
                        - stringified-body
                        - response-code
                        - user-name
                        - timestamp
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name 
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        release-number:
                          type: string
                          description: >
                            'Own release number
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        method:
                          type: string
                          description: 'Method applied in the OaM request, which is to be recorded'
                        resource:
                          type: string
                          description: 'Resource addressed by the OaM request, which is to be recorded'
                        stringified-body:
                          type: string
                          description: 'Stringified body of the OaM request, which is to be recorded'
                        response-code:
                          type: integer
                          description: 'Response code answered to the OaM request, which is to be recorded'
                        user-name:
                          type: string
                          description: 'user header of the OaM request, which is to be recorded'
                        timestamp:
                          type: string
                          description: 'Date and time when the response to the OaM request, which is to be recorded, has been sent'
                      example:
                        application-name: 'OwnApplicationName'
                        release-number: '1.0.0'
                        method: 'PUT'
                        resource: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port'
                        stringified-body: '{"tcp-server-interface-1-0:local-port":"1000"}'
                        response-code: 204
                        user-name: 'Max Mustermann'
                        timestamp: '2010-11-20T14:00:00+01:02'
              responses:
                '204':
                  description: 'OaM request recorded'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/end-subscription:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: endSubscription
      summary: 'Stops sending notifications of a specific subscription'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - subscriber-application
                - subscriber-release-number
                - subscription
              properties:
                subscriber-application:
                  type: string
                  description: >
                    'Name of application that no longer wants to receive notifications
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                subscriber-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that no longer wants to receive notifications
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                subscription:
                  type: string
                  minLength: 6
                  description: >
                    'Name of operation that had been addressed for starting getting notifications
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-*/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]'
              example:
                subscriber-application: 'AlreadySubscribingApplication'
                subscriber-release-number: '1.0.0'
                subscription: '/v1/subscription-to-be-stopped'
      responses:
        '204':
          description: 'Stopped sending notifications of a specific subscription'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-004/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/inquire-oam-request-approvals:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: inquireOamRequestApprovals
      summary: 'Receives information about where to ask for approval of OaM requests'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - oam-approval-application
                - oam-approval-application-release-number
                - oam-approval-operation
                - oam-approval-address
                - oam-approval-port
              properties:
                oam-approval-application:
                  type: string
                  description: >
                    'Name of application that shall approve the OaM requests
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-aa-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                oam-approval-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that shall approve the OaM requests
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bs-aa-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                oam-approval-operation:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for approving the OaM requests
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bs-aa-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                oam-approval-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of application that shall approve the OaM requests
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-aa-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of application that shall approve the OaM requests
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-aa-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                oam-approval-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of application that shall approve the OaM requests
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bs-aa-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                oam-approval-application: 'AdministratorAdministration'
                oam-approval-application-release-number: '2.0.0'
                oam-approval-operation: '/v1/approve-oam-request'
                oam-approval-address:
                  ip-address:
                    ipv-4-address: '1.1.3.12'
                oam-approval-port: 3012
      responses:
        '204':
          description: 'Informed about where to inquire for approval of OaM requests'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-005/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        OamRequestCausesInquiryForAuthentication:
          https://{$request.body#oam-approval-address/ip-address/ipv-4-address or $request.body#oam-approval-address/domain-name}:{$request.body#oam-approval-port}{$request.body#oam-approval-operation}:
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - application-name
                        - release-number
                        - Authorization
                        - method
                      properties:
                        application-name:
                          type: string
                          description: >
                            'Own application name for the AdministratorAdministration to check, whether this application is part of the SDN at all
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                        release-number:
                          type: string
                          description: >
                            'Own application release number for the AdministratorAdministration to check, whether this application is part of the SDN at all
                            from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                        Authorization:
                          type: string
                          description: > 
                            'Authorization code of the administrator addressing the OaM request to this application from [parameters::Authorization]'
                        method:
                          type: string
                          enum:
                            - 'CONNECT'
                            - 'DELETE'
                            - 'GET'
                            - 'HEAD'
                            - 'OPTIONS'
                            - 'PATCH'
                            - 'POST'
                            - 'PUT'
                            - 'TRACE'
                          description: 'Method applied in the OaM request, which is to be recorded'
                      example:
                        application-name: 'OwnApplicationName'
                        release-number: '1.0.0'
                        Authorization: 'Basic PEJhc2ljIEF1dGggVXNlcm5hbWU+OjxCYHduEdBBdXRoIFBhc3N3b3JkPg=='
                        method: 'PUT'
              responses:
                '200':
                  description: 'Response on inquiry for approval of an OaM request provided'
                  content:
                    application/json:
                      schema:
                        type: object
                        required:
                        - oam-request-is-approved
                        properties:
                          oam-request-is-approved:
                            type: boolean
                          reason-of-objection:
                            type: string
                            enum:
                              - 'APPLICATION_NAME_UNKNOWN'
                              - 'RELEASE_NUMBER_UNKNOWN'
                              - 'AUTHORIZATION_CODE_UNKNOWN'
                              - 'METHOD_NOT_ALLOWED'
                              - 'UNKNOWN'
                            description: >
                              'This attribute to be represented, if request::response::oam-request-is-approved==false.
                              Reasons to be checked and indicated according to the sequence defined in the enumeration.'
                      examples:
                        True:
                          value:
                            oam-request-is-approved: true
                        False:
                          value:
                            oam-request-is-approved: false
                            reason-of-objection: 'AUTHORIZATION_CODE_UNKNOWN'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/update-client:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: updateClient
      summary: 'Allows updating connection data of a serving application'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - application-name
                - old-application-release-number
                - new-application-release-number
                - new-application-address
                - new-application-port
              properties:
                application-name:
                  type: string
                  description: >
                    'Name of the application that has updated connection data
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                old-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Currently addressed release of the application that has updated connection data
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                new-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Future release number of the application that has updated connection data
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                new-application-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'Future IPv4 address of the application that has updated connection data
                            update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Future domain name of the application that has updated connection data
                        update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                new-application-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Future port of the application that has updated connection data
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                application-name: 'RegistryOffice'
                old-application-release-number: '1.0.0'
                new-application-release-number: '2.0.0'
                new-application-address:
                  ip-address:
                    ipv-4-address: '1.1.3.8'
                new-application-port: 3008
      responses:
        '204':
          description: 'Will update connection information'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-007/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/list-ltps-and-fcs:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: listLtpsAndFcs
      summary: 'Allows retrieving all interface and internal connection data'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      responses:
        '200':
          description: 'All interface and internal connection data provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - core-model-1-4:control-construct
                properties:
                  core-model-1-4:control-construct:
                    type: object
                    required:
                      - uuid
                      - logical-termination-point
                      - forwarding-domain
                    properties:
                      uuid:
                        type: string
                      logical-termination-point:
                        type: array
                        uniqueItems: true
                        items:
                          type: object
                          required:
                            - uuid
                            - ltp-direction
                            - client-ltp
                            - server-ltp
                            - layer-protocol
                          properties:
                            uuid:
                              type: string
                            ltp-direction:
                              type: string
                            client-ltp:
                              type: array
                              uniqueItems: true
                              items:
                                type: string
                            server-ltp:
                              type: array
                              uniqueItems: true
                              items:
                                type: string
                            layer-protocol:
                              type: array
                              minItems: 1
                              maxItems: 1
                              items:
                                oneOf:
                                  - description: 'operation server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - operation-server-interface-1-0:operation-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      operation-server-interface-1-0:operation-server-interface-pac:
                                        type: object
                                        required:
                                          - operation-server-interface-capability
                                          - operation-server-interface-configuration
                                        properties:
                                          operation-server-interface-capability:
                                            type: object
                                            required:
                                              - operation-name
                                            properties:
                                              operation-name:
                                                type: string
                                          operation-server-interface-configuration:
                                            type: object
                                            required:
                                              - life-cycle-state
                                            properties:
                                              life-cycle-state:
                                                type: string
                                  - description: 'http server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - http-server-interface-1-0:http-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      http-server-interface-1-0:http-server-interface-pac:
                                        type: object
                                        required:
                                          - http-server-interface-capability
                                        properties:
                                          http-server-interface-capability:
                                            type: object
                                            required:
                                              - application-name
                                              - release-number
                                              - data-update-period
                                            properties:
                                              application-name:
                                                type: string
                                              release-number:
                                                type: string
                                              data-update-period:
                                                type: string
                                  - description: 'tcp server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - tcp-server-interface-1-0:tcp-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      tcp-server-interface-1-0:tcp-server-interface-pac:
                                        type: object
                                        required:
                                          - tcp-server-interface-configuration
                                        properties:
                                          tcp-server-interface-configuration:
                                            type: object
                                            required:
                                              - local-address
                                              - local-port
                                            properties:
                                              local-address:
                                                type: object
                                                minProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ipv-4-address:
                                                    type: string
                                                  domain-name:
                                                    type: string
                                              local-port:
                                                type: integer
                                  - description: 'operation client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - operation-client-interface-1-0:operation-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      operation-client-interface-1-0:operation-client-interface-pac:
                                        type: object
                                        required:
                                          - operation-client-interface-configuration
                                          - operation-client-interface-status
                                        properties:
                                          operation-client-interface-configuration:
                                            type: object
                                            required:
                                              - operation-name
                                            properties:
                                              operation-name:
                                                type: string
                                          operation-client-interface-status:
                                            type: object
                                            required:
                                              - operational-state
                                              - life-cycle-state
                                            properties:
                                              operational-state:
                                                type: string
                                              life-cycle-state:
                                                type: string
                                  - description: 'elasticsearch client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac:
                                        type: object
                                        required:
                                          - elasticsearch-client-interface-configuration
                                          - elasticsearch-client-interface-status
                                        properties:
                                          elasticsearch-client-interface-configuration:
                                            type: object
                                            required:
                                              - index-alias
                                            properties:
                                              index-alias:
                                                type: string
                                          elasticsearch-client-interface-status:
                                            type: object
                                            required:
                                              - operational-state
                                              - life-cycle-state
                                            properties:
                                              operational-state:
                                                type: string
                                              life-cycle-state:
                                                type: string
                                  - description: 'http client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - http-client-interface-1-0:http-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      http-client-interface-1-0:http-client-interface-pac:
                                        type: object
                                        required:
                                          - http-client-interface-configuration
                                        properties:
                                          http-client-interface-configuration:
                                            type: object
                                            required:
                                              - application-name
                                              - release-number
                                            properties:
                                              application-name:
                                                type: string
                                              release-number:
                                                type: string
                                  - description: 'tcp client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - tcp-client-interface-1-0:tcp-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                      tcp-client-interface-1-0:tcp-client-interface-pac:
                                        type: object
                                        required:
                                          - tcp-client-interface-configuration
                                        properties:
                                          tcp-client-interface-configuration:
                                            type: object
                                            required:
                                              - remote-address
                                              - remote-port
                                            properties:
                                              remote-address:
                                                type: object
                                                minProperties: 1
                                                maxProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ip-address:
                                                    type: object
                                                    minProperties: 1
                                                    additionalProperties: false
                                                    properties:
                                                      ipv-4-address:
                                                        type: string
                                                  domain-name:
                                                    type: string
                                              remote-port:
                                                type: integer
                        example:
                          - uuid: 'ro-2-0-0-op-s-bm-000'
                            ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                            client-ltp: []
                            server-ltp: ['ro-2-0-0-http-s-bm-000']
                            layer-protocol:
                              - local-id: '0'
                                layer-protocol-name: 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                operation-server-interface-1-0:operation-server-interface-pac:
                                  operation-server-interface-capability:
                                    operation-name: '/v1/register-yourself'
                                  operation-server-interface-configuration:
                                    life-cycle-state: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                          - uuid: 'ro-2-0-0-http-s-bm-000'
                            ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                            client-ltp: ['ro-2-0-0-op-s-bm-000']
                            server-ltp: []
                            layer-protocol:
                              - local-id: '0'
                                layer-protocol-name: 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                http-server-interface-1-0:http-server-interface-pac:
                                  http-server-interface-capability:
                                    application-name: 'RegistryOffice'
                                    release-number: '2.0.0'
                                    data-update-period: 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_REAL_TIME'
                      forwarding-domain:
                        type: array
                        minItems: 1
                        maxItems: 1
                        items:
                          type: object
                          required:
                            - uuid
                            - forwarding-construct
                          properties:
                            uuid:
                              type: string
                            forwarding-construct:
                              type: array
                              items:
                                type: object
                                required:
                                  - uuid
                                  - name
                                  - fc-port
                                properties:
                                  uuid:
                                    type: string
                                  name:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - value-name
                                        - value
                                      properties:
                                        value-name:
                                          type: string
                                        value:
                                          type: string
                                  fc-port:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - local-id
                                        - port-direction
                                        - logical-termination-point
                                      properties:
                                        local-id:
                                          type: string
                                        port-direction:
                                          type: string
                                        logical-termination-point:
                                          type: string
                        example:
                          - uuid: 'ro-2-0-0-op-fd-000'
                            forwarding-construct:
                              - uuid: 'ro-2-0-0-op-fc-bm-000'
                                name:
                                  - value-name: 'ForwardingKind'
                                    value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                  - value-name: 'ForwardingName'
                                    value: 'PromptForRegisteringCausesRegistrationRequest'
                                fc-port:
                                  - local-id: '000'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                    logical-termination-point: 'ro-2-0-0-op-s-bm-000'
                                  - local-id: '100'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                    logical-termination-point: 'ro-2-0-0-op-s-bm-000'
                              - uuid: 'ro-2-0-0-op-fc-bm-001'
                                name:
                                  - value-name: 'ForwardingKind'
                                    value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                  - value-name: 'ForwardingName'
                                    value: 'PromptForEmbeddingCausesRequestForBequeathingData'
                                fc-port:
                                  - local-id: '100'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                    logical-termination-point: 'ro-2-0-0-op-s-bm-001'
                                  - local-id: '200'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                                    logical-termination-point: 'ro-2-0-0-op-c-bm-ro-2-0-0-000'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-008/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/redirect-topology-change-information:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: redirectTopologyChangeInformation
      summary: 'Offers configuring client side for sending information about topology changes'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - topology-application
                - topology-application-release-number
                - topology-operation-application-update
                - topology-operation-ltp-update
                - topology-operation-ltp-deletion
                - topology-operation-fc-update
                - topology-operation-fc-port-update
                - topology-operation-fc-port-deletion
                - topology-application-address
                - topology-application-port
              properties:
                topology-application:
                  type: string
                  description: >
                    'Name of application that shall document the application layer topology
                    find or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-alt-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                topology-application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release of application that shall document the application layer topology
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-bm-alt-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                topology-operation-application-update:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for updating the entire information about an application
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-operation-ltp-update:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for updating an LTP
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-operation-ltp-deletion:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for deleting an LTP
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-operation-fc-update:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for updating an FC port
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-003/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-operation-fc-port-update:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for updating an FC port
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-004/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-operation-fc-port-deletion:
                  type: string
                  minLength: 6
                  description: >
                    'Operation for deleting an FC port
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-bm-alt-2-0-0-005/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                topology-application-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          description: >
                            'IPv4 address of application that shall document the application layer topology
                            update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/ip-address/ipv-4-address]'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      description: >
                        'Domain name of application that shall document the application layer topology
                        update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]'
                topology-application-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  description: >
                    'Port of application that shall document the application layer topology
                    update or create [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-tcp-c-bm-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]'
              example:
                topology-application: 'ApplicationLayerTopology'
                topology-application-release-number: '2.0.0'
                topology-operation-application-update: '/v1/update-all-ltps-and-fcs'
                topology-operation-ltp-update: '/v1/update-ltp'
                topology-operation-ltp-deletion: '/v1/delete-ltp-and-dependents'
                topology-operation-fc-update: '/v1/update-fc'
                topology-operation-fc-port-update: '/v1/update-fc-port'
                topology-operation-fc-port-deletion: '/v1/delete-fc-port'
                topology-application-address:
                  ip-address:
                    ipv-4-address: '1.1.3.13'
                topology-application-port: 3013
      responses:
        '204':
          description: 'Client side for sending information about topology changes has been updated'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-009/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
      callbacks:
        PromptForRedirectingTopologyInformationCausesSendingAnInitialStateToALT:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-application-update}:
            description: 'Informing about a potentially new ALT results in sending all interfaces and internal conntections to that ALT'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - core-model-1-4:control-construct
                      properties:
                        core-model-1-4:control-construct:
                          type: object
                          required:
                            - uuid
                            - logical-termination-point
                            - forwarding-domain
                          properties:
                            uuid:
                              type: string
                            logical-termination-point:
                              type: array
                              uniqueItems: true
                              items:
                                type: object
                                required:
                                  - uuid
                                  - ltp-direction
                                  - client-ltp
                                  - server-ltp
                                  - layer-protocol
                                properties:
                                  uuid:
                                    type: string
                                  ltp-direction:
                                    type: string
                                  client-ltp:
                                    type: array
                                    uniqueItems: true
                                    items:
                                      type: string
                                  server-ltp:
                                    type: array
                                    uniqueItems: true
                                    items:
                                      type: string
                                  layer-protocol:
                                    type: array
                                    minItems: 1
                                    maxItems: 1
                                    items:
                                      oneOf:
                                        - description: 'operation server'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - operation-server-interface-1-0:operation-server-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            operation-server-interface-1-0:operation-server-interface-pac:
                                              type: object
                                              required:
                                                - operation-server-interface-capability
                                                - operation-server-interface-configuration
                                              properties:
                                                operation-server-interface-capability:
                                                  type: object
                                                  required:
                                                    - operation-name
                                                  properties:
                                                    operation-name:
                                                      type: string
                                                operation-server-interface-configuration:
                                                  type: object
                                                  required:
                                                    - life-cycle-state
                                                  properties:
                                                    life-cycle-state:
                                                      type: string
                                        - description: 'http server'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - http-server-interface-1-0:http-server-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            http-server-interface-1-0:http-server-interface-pac:
                                              type: object
                                              required:
                                                - http-server-interface-capability
                                              properties:
                                                http-server-interface-capability:
                                                  type: object
                                                  required:
                                                    - application-name
                                                    - release-number
                                                    - data-update-period
                                                  properties:
                                                    application-name:
                                                      type: string
                                                    release-number:
                                                      type: string
                                                    data-update-period:
                                                      type: string
                                        - description: 'tcp server'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - tcp-server-interface-1-0:tcp-server-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            tcp-server-interface-1-0:tcp-server-interface-pac:
                                              type: object
                                              required:
                                                - tcp-server-interface-configuration
                                              properties:
                                                tcp-server-interface-configuration:
                                                  type: object
                                                  required:
                                                    - local-address
                                                    - local-port
                                                  properties:
                                                    local-address:
                                                      type: object
                                                      minProperties: 1
                                                      additionalProperties: false
                                                      properties:
                                                        ipv-4-address:
                                                          type: string
                                                        domain-name:
                                                          type: string
                                                    local-port:
                                                      type: integer
                                        - description: 'operation client'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - operation-client-interface-1-0:operation-client-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            operation-client-interface-1-0:operation-client-interface-pac:
                                              type: object
                                              required:
                                                - operation-client-interface-configuration
                                                - operation-client-interface-status
                                              properties:
                                                operation-client-interface-configuration:
                                                  type: object
                                                  required:
                                                    - operation-name
                                                  properties:
                                                    operation-name:
                                                      type: string
                                                operation-client-interface-status:
                                                  type: object
                                                  required:
                                                    - operational-state
                                                    - life-cycle-state
                                                  properties:
                                                    operational-state:
                                                      type: string
                                                    life-cycle-state:
                                                      type: string
                                        - description: 'http client'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - http-client-interface-1-0:http-client-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            http-client-interface-1-0:http-client-interface-pac:
                                              type: object
                                              required:
                                                - http-client-interface-configuration
                                              properties:
                                                http-client-interface-configuration:
                                                  type: object
                                                  required:
                                                    - application-name
                                                    - release-number
                                                  properties:
                                                    application-name:
                                                      type: string
                                                    release-number:
                                                      type: string
                                        - description: 'tcp client'
                                          type: object
                                          required:
                                            - local-id
                                            - layer-protocol-name
                                            - tcp-client-interface-1-0:tcp-client-interface-pac
                                          properties:
                                            local-id:
                                              type: string
                                            layer-protocol-name:
                                              type: string
                                            tcp-client-interface-1-0:tcp-client-interface-pac:
                                              type: object
                                              required:
                                                - tcp-client-interface-configuration
                                              properties:
                                                tcp-client-interface-configuration:
                                                  type: object
                                                  required:
                                                    - remote-address
                                                    - remote-port
                                                  properties:
                                                    remote-address:
                                                      type: object
                                                      minProperties: 1
                                                      maxProperties: 1
                                                      additionalProperties: false
                                                      properties:
                                                        ip-address:
                                                          type: object
                                                          minProperties: 1
                                                          additionalProperties: false
                                                          properties:
                                                            ipv-4-address:
                                                              type: string
                                                        domain-name:
                                                          type: string
                                                    remote-port:
                                                      type: integer
                              example:
                                - uuid: 'ro-2-0-0-op-s-bm-000'
                                  ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                                  client-ltp: []
                                  server-ltp: ['ro-2-0-0-http-s-bm-000']
                                  layer-protocol:
                                    - local-id: '0'
                                      layer-protocol-name: 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                      operation-server-interface-1-0:operation-server-interface-pac:
                                        operation-server-interface-capability:
                                          operation-name: '/v1/register-yourself'
                                        operation-server-interface-configuration:
                                          life-cycle-state: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                                - uuid: 'ro-2-0-0-http-s-bm-000'
                                  ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                                  client-ltp: ['ro-2-0-0-op-s-bm-000']
                                  server-ltp: []
                                  layer-protocol:
                                    - local-id: '0'
                                      layer-protocol-name: 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                      http-server-interface-1-0:http-server-interface-pac:
                                        http-server-interface-capability:
                                          application-name: 'RegistryOffice'
                                          release-number: '2.0.0'
                                          data-update-period: 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_REAL_TIME'
                            forwarding-domain:
                              type: array
                              minItems: 1
                              maxItems: 1
                              items:
                                type: object
                                required:
                                  - uuid
                                  - forwarding-construct
                                properties:
                                  uuid:
                                    type: string
                                  forwarding-construct:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - uuid
                                        - name
                                        - fc-port
                                      properties:
                                        uuid:
                                          type: string
                                        name:
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - value-name
                                              - value
                                            properties:
                                              value-name:
                                                type: string
                                              value:
                                                type: string
                                        fc-port:
                                          type: array
                                          items:
                                            type: object
                                            required:
                                              - local-id
                                              - port-direction
                                              - logical-termination-point
                                            properties:
                                              local-id:
                                                type: string
                                              port-direction:
                                                type: string
                                              logical-termination-point:
                                                type: string
                              example:
                                - uuid: 'ro-2-0-0-op-fd-000'
                                  forwarding-construct:
                                    - uuid: 'ro-2-0-0-op-fc-bm-000'
                                      name:
                                        - value-name: 'ForwardingKind'
                                          value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                        - value-name: 'ForwardingName'
                                          value: 'PromptForRegisteringCausesRegistrationRequest'
                                      fc-port:
                                        - local-id: '000'
                                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                          logical-termination-point: 'ro-2-0-0-op-s-bm-000'
                                        - local-id: '100'
                                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                          logical-termination-point: 'ro-2-0-0-op-s-bm-000'
                                    - uuid: 'ro-2-0-0-op-fc-bm-001'
                                      name:
                                        - value-name: 'ForwardingKind'
                                          value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                        - value-name: 'ForwardingName'
                                          value: 'PromptForEmbeddingCausesRequestForBequeathingData'
                                      fc-port:
                                        - local-id: '100'
                                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                          logical-termination-point: 'ro-2-0-0-op-s-bm-001'
                                        - local-id: '200'
                                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                                          logical-termination-point: 'ro-2-0-0-op-c-bm-ro-2-0-0-000'
              responses:
                '204':
                  description: 'LTPs and FD will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        ServiceRequestCausesLtpUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-ltp-update}:
            description: 'To be activated whenever a service request causes the creation or change of an LTP'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                        - ltp-direction
                        - client-ltp
                        - server-ltp
                        - layer-protocol
                      properties:
                        uuid:
                          type: string
                        ltp-direction:
                          type: string
                        client-ltp:
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                        server-ltp:
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                        layer-protocol:
                          type: array
                          minItems: 1
                          maxItems: 1
                          items:
                            oneOf:
                              - description: 'operation server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - operation-server-interface-1-0:operation-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  operation-server-interface-1-0:operation-server-interface-pac:
                                    type: object
                                    required:
                                      - operation-server-interface-capability
                                      - operation-server-interface-configuration
                                    properties:
                                      operation-server-interface-capability:
                                        type: object
                                        required:
                                          - operation-name
                                        properties:
                                          operation-name:
                                            type: string
                                      operation-server-interface-configuration:
                                        type: object
                                        required:
                                          - life-cycle-state
                                        properties:
                                          life-cycle-state:
                                            type: string
                              - description: 'http server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - http-server-interface-1-0:http-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  http-server-interface-1-0:http-server-interface-pac:
                                    type: object
                                    required:
                                      - http-server-interface-capability
                                    properties:
                                      http-server-interface-capability:
                                        type: object
                                        required:
                                          - application-name
                                          - release-number
                                          - data-update-period
                                        properties:
                                          application-name:
                                            type: string
                                          release-number:
                                            type: string
                                          data-update-period:
                                            type: string
                              - description: 'tcp server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - tcp-server-interface-1-0:tcp-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  tcp-server-interface-1-0:tcp-server-interface-pac:
                                    type: object
                                    required:
                                      - tcp-server-interface-configuration
                                    properties:
                                      tcp-server-interface-configuration:
                                        type: object
                                        required:
                                          - local-address
                                          - local-port
                                        properties:
                                          local-address:
                                            type: object
                                            minProperties: 1
                                            additionalProperties: false
                                            properties:
                                              ipv-4-address:
                                                type: string
                                              domain-name:
                                                type: string
                                          local-port:
                                            type: integer
                              - description: 'operation client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - operation-client-interface-1-0:operation-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  operation-client-interface-1-0:operation-client-interface-pac:
                                    type: object
                                    required:
                                      - operation-client-interface-configuration
                                      - operation-client-interface-status
                                    properties:
                                      operation-client-interface-configuration:
                                        type: object
                                        required:
                                          - operation-name
                                        properties:
                                          operation-name:
                                            type: string
                                      operation-client-interface-status:
                                        type: object
                                        required:
                                          - operational-state
                                          - life-cycle-state
                                        properties:
                                          operational-state:
                                            type: string
                                          life-cycle-state:
                                            type: string
                              - description: 'http client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - http-client-interface-1-0:http-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  http-client-interface-1-0:http-client-interface-pac:
                                    type: object
                                    required:
                                      - http-client-interface-configuration
                                    properties:
                                      http-client-interface-configuration:
                                        type: object
                                        required:
                                          - application-name
                                          - release-number
                                        properties:
                                          application-name:
                                            type: string
                                          release-number:
                                            type: string
                              - description: 'tcp client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - tcp-client-interface-1-0:tcp-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  tcp-client-interface-1-0:tcp-client-interface-pac:
                                    type: object
                                    required:
                                      - tcp-client-interface-configuration
                                    properties:
                                      tcp-client-interface-configuration:
                                        type: object
                                        required:
                                          - remote-address
                                          - remote-port
                                        properties:
                                          remote-address:
                                            type: object
                                            minProperties: 1
                                            maxProperties: 1
                                            additionalProperties: false
                                            properties:
                                              ip-address:
                                                type: object
                                                minProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ipv-4-address:
                                                    type: string
                                              domain-name:
                                                type: string
                                          remote-port:
                                            type: integer
                      example:
                        uuid: 'ro-2-0-0-op-s-bm-002'
                        ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                        client-ltp: []
                        server-ltp: ['ro-2-0-0-http-s-bm-000']
                        layer-protocol:
                          - local-id: '0'
                            layer-protocol-name: 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                            operation-server-interface-1-0:operation-server-interface-pac:
                              operation-server-interface-capability:
                                operation-name: '/v1/redirect-service-request-information'
                              operation-server-interface-configuration:
                                life-cycle-state: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
              responses:
                '204':
                  description: 'LTP will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        ServiceRequestCausesLtpDeletionRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-ltp-deletion}:
            description: 'To be activated whenever a service request causes an LTP being deleted'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                      properties:
                        uuid:
                          type: string
                      example:
                        uuid: 'ro-2-0-0-op-s-bm-002'
              responses:
                '204':
                  description: 'LTP will be deleted'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        ServiceRequestCausesFcUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-update}:
            description: 'To be activated whenever a service request causes the creation or change of an FC port'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                        - name
                        - fc-port
                      properties:
                        uuid:
                          type: string
                        name:
                          type: array
                          items:
                            type: object
                            required:
                              - value-name
                              - value
                            properties:
                              value-name:
                                type: string
                              value:
                                type: string
                        fc-port:
                          type: array
                          items:
                            type: object
                            required:
                              - local-id
                              - port-direction
                              - logical-termination-point
                            properties:
                              local-id:
                                type: string
                              port-direction:
                                type: string
                              logical-termination-point:
                                type: string
                      example:
                        uuid: 'ro-2-0-0-op-fc-bm-003'
                        name:
                          - value-name: 'ForwardingKind'
                            value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                          - value-name: 'ForwardingName'
                            value: 'OamRequestCausesLoggingRequest'
                        fc-port:
                          - local-id: '000'
                            port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                            logical-termination-point: 'ro-2-0-0-op-s-bm-003'
                          - local-id: '200'
                            port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                            logical-termination-point: 'ro-2-0-0-op-c-bs-ol-2-0-0-000'
              responses:
                '204':
                  description: 'FC will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        ServiceRequestCausesFcPortUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-port-update}:
            description: 'To be activated whenever a service request causes an FC port being updated'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - fc-uuid
                        - fc-port
                      properties:
                        fc-uuid:
                          type: string
                        fc-port:
                          type: object
                          required:
                            - local-id
                            - port-direction
                            - logical-termination-point
                          properties:
                            local-id:
                              type: string
                            port-direction:
                              type: string
                              enum:
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                            logical-termination-point:
                              type: string
                      example:
                        fc-uuid: 'ro-2-0-0-op-fc-bm-003'
                        fc-port:
                          local-id: '000'
                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                          logical-termination-point: 'ro-2-0-0-op-s-bm-003'
              responses:
                '204':
                  description: 'FC port will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        ServiceRequestCausesFcPortDeletionRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-port-deletion}:
            description: 'To be activated whenever a service request causes an FC port being deleted'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - fc-uuid
                        - fc-port-local-id
                      properties:
                        fc-uuid:
                          type: string
                        fc-port-local-id:
                          type: string
                      example:
                        fc-uuid: 'ro-2-0-0-op-fc-bm-003000'
                        fc-port-local-id: '202'
              responses:
                '204':
                  description: 'FC port will be deleted'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        OamRequestCausesLtpUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-ltp-update}:
            description: 'To be activated whenever an OaM request causes the creation or change of an LTP'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                        - ltp-direction
                        - client-ltp
                        - server-ltp
                        - layer-protocol
                      properties:
                        uuid:
                          type: string
                        ltp-direction:
                          type: string
                        client-ltp:
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                        server-ltp:
                          type: array
                          uniqueItems: true
                          items:
                            type: string
                        layer-protocol:
                          type: array
                          minItems: 1
                          maxItems: 1
                          items:
                            oneOf:
                              - description: 'operation server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - operation-server-interface-1-0:operation-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  operation-server-interface-1-0:operation-server-interface-pac:
                                    type: object
                                    required:
                                      - operation-server-interface-capability
                                      - operation-server-interface-configuration
                                    properties:
                                      operation-server-interface-capability:
                                        type: object
                                        required:
                                          - operation-name
                                        properties:
                                          operation-name:
                                            type: string
                                      operation-server-interface-configuration:
                                        type: object
                                        required:
                                          - life-cycle-state
                                        properties:
                                          life-cycle-state:
                                            type: string
                              - description: 'http server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - http-server-interface-1-0:http-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  http-server-interface-1-0:http-server-interface-pac:
                                    type: object
                                    required:
                                      - http-server-interface-capability
                                    properties:
                                      http-server-interface-capability:
                                        type: object
                                        required:
                                          - application-name
                                          - release-number
                                          - data-update-period
                                        properties:
                                          application-name:
                                            type: string
                                          release-number:
                                            type: string
                                          data-update-period:
                                            type: string
                              - description: 'tcp server'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - tcp-server-interface-1-0:tcp-server-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  tcp-server-interface-1-0:tcp-server-interface-pac:
                                    type: object
                                    required:
                                      - tcp-server-interface-configuration
                                    properties:
                                      tcp-server-interface-configuration:
                                        type: object
                                        required:
                                          - local-address
                                          - local-port
                                        properties:
                                          local-address:
                                            type: object
                                            minProperties: 1
                                            additionalProperties: false
                                            properties:
                                              ipv-4-address:
                                                type: string
                                              domain-name:
                                                type: string
                                          local-port:
                                            type: integer
                              - description: 'operation client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - operation-client-interface-1-0:operation-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  operation-client-interface-1-0:operation-client-interface-pac:
                                    type: object
                                    required:
                                      - operation-client-interface-configuration
                                      - operation-client-interface-status
                                    properties:
                                      operation-client-interface-configuration:
                                        type: object
                                        required:
                                          - operation-name
                                        properties:
                                          operation-name:
                                            type: string
                                      operation-client-interface-status:
                                        type: object
                                        required:
                                          - operational-state
                                          - life-cycle-state
                                        properties:
                                          operational-state:
                                            type: string
                                          life-cycle-state:
                                            type: string
                              - description: 'http client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - http-client-interface-1-0:http-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  http-client-interface-1-0:http-client-interface-pac:
                                    type: object
                                    required:
                                      - http-client-interface-configuration
                                    properties:
                                      http-client-interface-configuration:
                                        type: object
                                        required:
                                          - application-name
                                          - release-number
                                        properties:
                                          application-name:
                                            type: string
                                          release-number:
                                            type: string
                              - description: 'tcp client'
                                type: object
                                required:
                                  - local-id
                                  - layer-protocol-name
                                  - tcp-client-interface-1-0:tcp-client-interface-pac
                                properties:
                                  local-id:
                                    type: string
                                  layer-protocol-name:
                                    type: string
                                  tcp-client-interface-1-0:tcp-client-interface-pac:
                                    type: object
                                    required:
                                      - tcp-client-interface-configuration
                                    properties:
                                      tcp-client-interface-configuration:
                                        type: object
                                        required:
                                          - remote-address
                                          - remote-port
                                        properties:
                                          remote-address:
                                            type: object
                                            minProperties: 1
                                            maxProperties: 1
                                            additionalProperties: false
                                            properties:
                                              ip-address:
                                                type: object
                                                minProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ipv-4-address:
                                                    type: string
                                              domain-name:
                                                type: string
                                          remote-port:
                                            type: integer
                      example:
                        uuid: 'ro-2-0-0-op-s-bm-002'
                        ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                        client-ltp: []
                        server-ltp: ['ro-2-0-0-http-s-bm-000']
                        layer-protocol:
                          - local-id: '0'
                            layer-protocol-name: 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                            operation-server-interface-1-0:operation-server-interface-pac:
                              operation-server-interface-capability:
                                operation-name: '/v1/redirect-service-request-information'
                              operation-server-interface-configuration:
                                life-cycle-state: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
              responses:
                '204':
                  description: 'LTP will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        OamRequestCausesLtpDeletionRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-ltp-deletion}:
            description: 'To be activated whenever an OaM request causes an LTP being deleted'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                      properties:
                        uuid:
                          type: string
                      example:
                        uuid: 'ro-2-0-0-op-s-bm-002'
              responses:
                '204':
                  description: 'LTP will be deleted'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        OamRequestCausesFcUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-update}:
            description: 'To be activated whenever an OaM request causes the creation or change of an FC port'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - uuid
                        - name
                        - fc-port
                      properties:
                        uuid:
                          type: string
                        name:
                          type: array
                          items:
                            type: object
                            required:
                              - value-name
                              - value
                            properties:
                              value-name:
                                type: string
                              value:
                                type: string
                        fc-port:
                          type: array
                          items:
                            type: object
                            required:
                              - local-id
                              - port-direction
                              - logical-termination-point
                            properties:
                              local-id:
                                type: string
                              port-direction:
                                type: string
                              logical-termination-point:
                                type: string
                      example:
                        uuid: 'ro-2-0-0-op-fc-bm-003'
                        name:
                          - value-name: 'ForwardingKind'
                            value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                          - value-name: 'ForwardingName'
                            value: 'OamRequestCausesLoggingRequest'
                        fc-port:
                          - local-id: '000'
                            port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                            logical-termination-point: 'ro-2-0-0-op-s-bm-003'
                          - local-id: '200'
                            port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                            logical-termination-point: 'ro-2-0-0-op-c-bs-ol-2-0-0-000'
              responses:
                '204':
                  description: 'FC port will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        OamRequestCausesFcPortUpdateRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-port-update}:
            description: 'To be activated whenever an OaM request causes an FC port being updated'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - fc-uuid
                        - fc-port
                      properties:
                        fc-uuid:
                          type: string
                        fc-port:
                          type: object
                          required:
                            - local-id
                            - port-direction
                            - logical-termination-point
                          properties:
                            local-id:
                              type: string
                            port-direction:
                              type: string
                              enum:
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                - 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                            logical-termination-point:
                              type: string
                      example:
                        fc-uuid: 'ro-2-0-0-op-fc-bm-003'
                        fc-port:
                          local-id: '000'
                          port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                          logical-termination-point: 'ro-2-0-0-op-s-bm-003'
              responses:
                '204':
                  description: 'FC port will be updated'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
        OamRequestCausesFcPortDeletionRequest:
          https://{$request.body#topology-application-address/ip-address/ipv-4-address or $request.body#topology-application-address/domain-name}:{$request.body#topology-application-port}{$request.body#topology-operation-fc-port-deletion}:
            description: 'To be activated whenever an OaM request causes an FC port being deleted'
            parameters:
              - $ref: '#/components/parameters/user'
              - $ref: '#/components/parameters/originator'
              - $ref: '#/components/parameters/x-correlator'
              - $ref: '#/components/parameters/trace-indicator'
              - $ref: '#/components/parameters/customer-journey'
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      required:
                        - fc-uuid
                        - fc-port-local-id
                      properties:
                        fc-uuid:
                          type: string
                        fc-port-local-id:
                          type: string
                      example:
                        fc-uuid: 'ro-2-0-0-op-fc-is-000'
                        fc-port-local-id: '202'
              responses:
                '204':
                  description: 'FC port will be deleted'
                  headers:
                    x-correlator:
                      schema: 
                        type: string
                        example: '550e8400-e29b-11d4-a716-446655440000'
                      description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
                    exec-time:
                      schema:
                        type: integer
                        example: 1100
                      description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
                    backend-time:
                      schema:
                        type: integer
                        example: 850
                      description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
                    life-cycle-state:
                      schema:
                        type: string
                        enum:
                          - 'EXPERIMENTAL'
                          - 'OPERATIONAL'
                          - 'DEPRECATED'
                          - 'OBSOLETE'
                          - 'UNKNOWN'
                          - 'NOT_YET_DEFINED'
                        example: 'EXPERIMENTAL'
                      description: 'Life cycle state of the consumed service'
                '400':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '401':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '403':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '404':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                '500':
                  $ref: '#/components/responses/responseForErroredServiceRequests'
                default:
                  $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/update-operation-key:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: updateOperationKey
      summary: 'Allows updating operation key at a server or client'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-uuid
                - new-operation-key
              properties:
                operation-uuid:
                  type: string
                  pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-([sc])-([bi][ms])((-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})){0,1})-([0-9]{3})$'
                  description: >
                    'UUID of LTP that is target of the updating of the operation key
                    find [/core-model-1-4:control-construct/logical-termination-point=uuid]'
                new-operation-key:
                  type: string
                  minLength: 5
                  description: >
                    'Future operation key
                    update [/core-model-1-4:control-construct/logical-termination-point={operation-uuid}/layer-protocol=0/operation-*-interface-1-0:operation-*-interface-pac/operation-*-interface-configuration/operation-key]'
              example:
                operation-uuid: 'ro-2-0-0-op-s-is-003'
                new-operation-key: 'Operation key not yet provided.'
      responses:
        '204':
          description: 'Operation key has been updated'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-010/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/update-operation-client:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: updateOperationClient
      summary: 'Allows updating operation clients to redirect to backward compatible services'
      tags:
        - BasicServices
      security:
        - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - application-name
                - application-release-number
                - old-operation-name
                - new-operation-name
              properties:
                application-name:
                  type: string
                  description: >
                    'Name of the application that has an updated operation
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
                application-release-number:
                  type: string
                  pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                  description: >
                    'Release number of the application that has an updated operation
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]'
                old-operation-name:
                  type: string
                  minLength: 6
                  description: >
                    'Name of the deprecated operation
                    find [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-*/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
                new-operation-name:
                  type: string
                  minLength: 6
                  description: >
                    'Name of the replacing operation
                    update [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-c-*/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]'
              example:
                application-name: 'RegistryOffice'
                application-release-number: '2.0.0'
                old-operation-name: '/v1/register-application'
                new-operation-name: '/v2/register-application'
      responses:
        '204':
          description: 'Operation clients will be updated, if existing'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bm-011/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '401':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '403':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'

  /v1/inform-about-application:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: informAboutApplication
      summary: 'Returns administrative information'
      tags:
        - BasicServices
      responses:
        '200':
          description: 'Administrative information provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - application-name
                  - application-release-number
                  - application-purpose
                  - data-update-period
                  - owner-name
                  - owner-email-address
                properties:
                  application-name:
                    type: string
                    description: >
                      'Own application name
                      from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]'
                  application-release-number:
                    type: string
                    description: >
                      'Own release number
                      from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]'
                  application-purpose:
                    type: string
                    description: >
                      'Own application purpose
                      from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose]'
                  data-update-period:
                    type: string
                    enum:
                      - 'real-time'
                      - '1h-period'
                      - '24h-period'
                      - 'manual'
                    description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period]'
                  owner-name:
                    type: string
                    description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name]'
                  owner-email-address:
                    type: string
                    description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address]'
                example:
                  application-name: 'OwnApplicationName'
                  application-release-number: '1.0.0'
                  application-purpose: 'Brief description of the purpose of the application.'
                  data-update-period: 'real-time'
                  owner-name: 'Thorsten Heinze'
                  owner-email-address: 'Thorsten.Heinze@telefonica.com'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-001/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/inform-about-application-in-generic-representation:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: informAboutApplicationInGenericRepresentation
      summary: 'Returns administrative information for generic representation'
      tags:
        - BasicServices
      responses:
        '200':
          description: 'Administrative information provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - response-value-list
                  - consequent-action-list
                properties:
                  response-value-list:
                    type: array
                    uniqueItems: true
                    minItems: 6
                    maxItems: 6
                    items:
                      type: object
                      required:
                        - field-name
                        - value
                        - datatype
                      properties:
                        field-name:
                          type: string
                          enum:
                            - applicationName
                            - releaseNumber
                            - applicationPurpose
                            - dataUpdatePeriod
                            - ownerName
                            - ownerEmailAddress
                        value:
                          type: string
                          description: >
                            'from either
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]
                            or
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]
                            or
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose]
                            or
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period]
                            or
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name]
                            or
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address]'
                        datatype:
                          type: string
                          enum:
                            - 'string'
                    example:
                      - field-name: 'applicationName'
                        value: 'OwnApplicationName'
                        datatype: 'string'
                      - field-name: 'releaseNumber'
                        value: '1.0.0'
                        datatype: 'string'
                      - field-name: 'applicationPurpose'
                        value: 'Brief description of the purpose of the application.'
                        datatype: 'string'
                      - field-name: 'dataUpdatePeriod'
                        value: 'real-time'
                        datatype: 'string'
                      - field-name: 'ownerName'
                        value: 'Thorsten Heinze'
                        datatype: 'string'
                      - field-name: 'ownerEmailAddress'
                        value: 'Thorsten.Heinze@telefonica.com'
                        datatype: 'string'
                  consequent-action-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                        - label
                        - request
                        - display-in-new-browser-window
                      properties:
                        label:
                          type: string
                          description: >
                            'Label that shall be presented on the button
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/label]'
                        request:
                          type: string
                          description: >
                            'Request that shall be called, when button gets pressed
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-configuration/request]'
                        input-value-list:
                          type: array
                          uniqueItems: true
                          items:
                            type: object
                            required:
                              - field-name
                            properties:
                              field-name:
                                type: string
                                description: >
                                  'Name of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/name]'
                              unit:
                                type: string
                                description: >
                                  'Unit of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/unit]'
                        display-in-new-browser-window:
                          type: boolean
                          description: >
                            'True in case Request shall be represented in a new browser window
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/display-in-new-browser-window]'
                    example:
                      - label: 'Release History'
                        request: 'https://1.1.4.1:4001/v1/inform-about-release-history-in-generic-representation'
                        display-in-new-browser-window: false
                      - label: 'API Documentation'
                        request: 'https://1.1.4.1:4001/docs'
                        display-in-new-browser-window: true
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/inform-about-release-history:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: informAboutReleaseHistory
      summary: 'Returns release history'
      tags:
        - BasicServices
      responses:
        '200':
          description: 'Release history provided'
          content:
            application/json:
              schema:
                type: array
                uniqueItems: true
                items:
                  type: object
                  required:
                    - release-number
                    - release-date
                    - changes
                  properties:
                    release-number:
                      type: string
                      description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/release-number]'
                    release-date:
                      type: string
                      description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/release-date]'
                    changes:
                      type: string
                      description: 'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/changes]'
                example:
                  - release-number: '1.0.0'
                    release-date: '20.11.2010'
                    changes: 'Initial version.'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-003/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'
  /v1/inform-about-release-history-in-generic-representation:
    parameters:
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/originator'
      - $ref: '#/components/parameters/x-correlator'
      - $ref: '#/components/parameters/trace-indicator'
      - $ref: '#/components/parameters/customer-journey'
    post:
      operationId: informAboutReleaseHistoryInGenericRepresentation
      summary: 'Returns release history for generic representation'
      tags:
        - BasicServices
      responses:
        '200':
          description: 'Release history provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - response-value-list
                  - consequent-action-list
                properties:
                  response-value-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                        - field-name
                        - value
                        - datatype
                      properties:
                        field-name:
                          type: string
                          description: >
                            'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/release-number]'
                        value:
                          type: string
                          description: >
                            'from [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/release-date]
                             - 
                            [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=*/changes]'
                        datatype:
                          type: string
                          enum:
                            - 'string'
                    example:
                      - field-name: '1.0.0'
                        value: '20.11.2010 - Initial version.'
                        datatype: 'string'
                  consequent-action-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                        - label
                        - request
                        - display-in-new-browser-window
                      properties:
                        label:
                          type: string
                          description: >
                            'Label that shall be presented on the button
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/label]'
                        request:
                          type: string
                          description: >
                            'Request that shall be called, when button gets pressed
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-configuration/request]'
                        input-value-list:
                          type: array
                          uniqueItems: true
                          items:
                            type: object
                            required:
                              - field-name
                            properties:
                              field-name:
                                type: string
                                description: >
                                  'Name of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/name]'
                              unit:
                                type: string
                                description: >
                                  'Unit of an input value required for executing the Request
                                  from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list=*/unit]'
                        display-in-new-browser-window:
                          type: boolean
                          description: >
                            'True in case Request shall be represented in a new browser window
                            from [/core-model-1-4:control-construct/profile-collection/profile=*-1-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-capability/display-in-new-browser-window]'
          headers:
            x-correlator:
              schema: 
                type: string
                example: '550e8400-e29b-11d4-a716-446655440000'
              description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
            exec-time:
              schema:
                type: integer
                example: 1100
              description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
            backend-time:
              schema:
                type: integer
                example: 850
              description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
            life-cycle-state:
              schema:
                type: string
                enum:
                  - 'EXPERIMENTAL'
                  - 'OPERATIONAL'
                  - 'DEPRECATED'
                  - 'OBSOLETE'
                  - 'UNKNOWN'
                  - 'NOT_YET_DEFINED'
                example: 'EXPERIMENTAL'
              description: >
                  'Life cycle state of the consumed service
                  find in [/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-004/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state]'
        '400':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '404':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        '500':
          $ref: '#/components/responses/responseForErroredServiceRequests'
        default:
          $ref: '#/components/responses/responseForErroredServiceRequests'

########################################################################################################################
#   OAM Layer - Individual Part - Following paths can be taken as a base for individualization
########################################################################################################################
  /core-model-1-4:control-construct:
    get:
      operationId: getControlConstruct
      summary: 'Returns entire data tree'
      tags:
        - Core
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'ControlConstruct provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - core-model-1-4:control-construct
                properties:
                  core-model-1-4:control-construct:
                    type: object
                    required:
                      - uuid
                      - profile-collection
                      - logical-termination-point
                      - forwarding-domain
                    properties:
                      uuid:
                        type: string
                        pattern: '^([a-z]{2,6})-([0-9]+)-([0-9]+)-([0-9]+)$'
                        example: 'ro-1-0-0'
                      profile-collection:
                        type: object
                        required:
                          - profile
                        properties:
                          profile:
                            type: array
                            uniqueItems: true
                            items:
                              anyOf:
                                - description: 'action profile'
                                  type: object
                                  required:
                                    - uuid
                                    - profile-name
                                    # Bug in the postman mock server
                                    # original code is:
                                    # - action-profile-1-0:action-profile-pac
                                    # workaround code is:
                                    # - empty line -
                                  properties:
                                    uuid:
                                      type: string
                                    profile-name:
                                      type: string
                                      enum:
                                        - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                                        - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                                        - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                                        - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                                    action-profile-1-0:action-profile-pac:
                                      type: object
                                      required:
                                        - action-profile-capability
                                        - action-profile-configuration
                                      properties:
                                        action-profile-capability:
                                          type: object
                                          required:
                                            - operation-name
                                            - label
                                            - display-in-new-browser-window
                                          properties:
                                            operation-name:
                                              type: string
                                            label:
                                              type: string
                                            input-value-list:
                                              type: array
                                              items:
                                                type: object
                                                required:
                                                  - field-name
                                                properties:
                                                  field-name:
                                                    type: string
                                                  unit:
                                                    type: string
                                            display-in-new-browser-window:
                                              type: boolean
                                        action-profile-configuration:
                                          type: object
                                          required:
                                            - request
                                          properties:
                                            request:
                                              type: string
                                - description: 'file profile'
                                  type: object
                                  required:
                                    - uuid
                                    - profile-name
                                    - file-profile-1-0:file-profile-pac
                                  properties:
                                    uuid:
                                      type: string
                                    profile-name:
                                      type: string
                                      enum:
                                        - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                                        - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                                        - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                                        - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                                    file-profile-1-0:file-profile-pac:
                                      type: object
                                      required:
                                        - file-profile-capability
                                        - file-profile-configuration
                                      properties:
                                        file-profile-capability:
                                          type: object
                                          required:
                                            - file-identifier
                                            - file-description
                                          properties:
                                            file-identifier:
                                              type: string
                                            file-description:
                                              type: string
                                        file-profile-configuration:
                                          type: object
                                          required:
                                            - file-path
                                          properties:
                                            file-path:
                                              type: string
                                            user-name:
                                              type: string
                                            password:
                                              type: string
                                            operation:
                                              type: string
                                              enum:
                                              - 'file-profile-1-0:OPERATION_TYPE_READ_ONLY'
                                              - 'file-profile-1-0:OPERATION_TYPE_READ_WRITE'
                                              - 'file-profile-1-0:OPERATION_TYPE_OFF'
                                              - 'file-profile-1-0:OPERATION_TYPE_NOT_YET_DEFINED'
                                - description: 'integer profile'
                                  type: object
                                  required:
                                    - uuid
                                    - profile-name
                                    - integer-profile-1-0:integer-profile-pac
                                  properties:
                                    uuid:
                                      type: string
                                    profile-name:
                                      type: string
                                      enum:
                                        - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                                        - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                                        - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                                        - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                                    integer-profile-1-0:integer-profile-pac:
                                      type: object
                                      required:
                                        - integer-profile-capability
                                        - integer-profile-configuration
                                      properties:
                                        integer-profile-capability:
                                          type: object
                                          required:
                                            - integer-name
                                          properties:
                                            integer-name:
                                              type: string
                                            unit:
                                              type: string
                                            minimum:
                                              type: integer
                                            maximum:
                                              type: integer
                                        integer-profile-configuration:
                                          type: object
                                          required:
                                            - integer-value
                                          properties:
                                            integer-value:
                                              type: integer
                                - description: 'string profile'
                                  type: object
                                  required:
                                    - uuid
                                    - profile-name
                                    - string-profile-1-0:string-profile-pac
                                  properties:
                                    uuid:
                                      type: string
                                    profile-name:
                                      type: string
                                      enum:
                                        - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                                        - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                                        - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                                        - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                                    string-profile-1-0:string-profile-pac:
                                      type: object
                                      required:
                                        - string-profile-capability
                                        - string-profile-configuration
                                      properties:
                                        string-profile-capability:
                                          type: object
                                          required:
                                            - string-name
                                          properties:
                                            string-name:
                                              type: string
                                        string-profile-configuration:
                                          type: object
                                          required:
                                            - string-value
                                          properties:
                                            string-value:
                                              type: string
                            example:
                              - uuid: 'ro-2-0-0-integer-p-000'
                                profile-name: 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                                integer-profile-1-0:integer-profile-pac:
                                  integer-profile-capability:
                                    integer-name: 'maximumNumberOfEntries'
                                    unit: 'records'
                                    minimum: 0
                                    maximum: 1000000
                                  integer-profile-configuration:
                                    integer-value: 1000000
                      logical-termination-point:
                        type: array
                        uniqueItems: true
                        items:
                          type: object
                          required:
                            - uuid
                            - ltp-direction
                            - client-ltp
                            - server-ltp
                            - layer-protocol
                          properties:
                            uuid:
                              type: string
                            ltp-direction:
                              type: string
                              enum:
                                - 'core-model-1-4:TERMINATION_DIRECTION_BIDIRECTIONAL'
                                - 'core-model-1-4:TERMINATION_DIRECTION_SINK'
                                - 'core-model-1-4:TERMINATION_DIRECTION_SOURCE'
                                - 'core-model-1-4:TERMINATION_DIRECTION_UNDEFINED_OR_UNKNOWN'
                            client-ltp:
                              type: array
                              uniqueItems: true
                              items:
                                type: string
                            server-ltp:
                              type: array
                              uniqueItems: true
                              items:
                                type: string
                            layer-protocol:
                              type: array
                              minItems: 1
                              maxItems: 1
                              items:
                                oneOf:
                                  - description: 'operation server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - operation-server-interface-1-0:operation-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      operation-server-interface-1-0:operation-server-interface-pac:
                                        type: object
                                        required:
                                          - operation-server-interface-capability
                                          - operation-server-interface-configuration
                                        properties:
                                          operation-server-interface-capability:
                                            type: object
                                            required:
                                              - operation-name
                                            properties:
                                              operation-name:
                                                type: string
                                          operation-server-interface-configuration:
                                            type: object
                                            required:
                                              - life-cycle-state
                                              - operation-key
                                            properties:
                                              life-cycle-state:
                                                type: string
                                                enum:
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                                                  - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                                              operation-key:
                                                type: string
                                  - description: 'http server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - http-server-interface-1-0:http-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      http-server-interface-1-0:http-server-interface-pac:
                                        type: object
                                        required:
                                          - http-server-interface-capability
                                        properties:
                                          http-server-interface-capability:
                                            type: object
                                            required:
                                              - application-name
                                              - release-number
                                              - application-purpose
                                              - data-update-period
                                              - owner-name
                                              - owner-email-address
                                              - release-list
                                            properties:
                                              application-name:
                                                type: string
                                              release-number:
                                                type: string
                                              application-purpose:
                                                type: string
                                              data-update-period:
                                                type: string
                                                enum:
                                                  - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_REAL_TIME'
                                                  - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_1H_PERIOD'
                                                  - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_24H_PERIOD'
                                                  - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_MANUAL'
                                              owner-name:
                                                type: string
                                              owner-email-address:
                                                type: string
                                              release-list:
                                                type: array
                                                uniqueItems: true
                                                items:
                                                  type: object
                                                  required:
                                                  - release-number
                                                  - release-date
                                                  - changes
                                                  properties:
                                                    release-number:
                                                      type: string
                                                    release-date:
                                                      type: string
                                                    changes:
                                                      type: string
                                  - description: 'tcp server'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - tcp-server-interface-1-0:tcp-server-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      tcp-server-interface-1-0:tcp-server-interface-pac:
                                        type: object
                                        required:
                                          - tcp-server-interface-configuration
                                        properties:
                                          tcp-server-interface-configuration:
                                            type: object
                                            required:
                                              - local-address
                                              - local-port
                                            properties:
                                              local-address:
                                                type: object
                                                minProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ipv-4-address:
                                                    type: string
                                                  domain-name:
                                                    type: string
                                              local-port:
                                                type: integer
                                  - description: 'operation client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - operation-client-interface-1-0:operation-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      operation-client-interface-1-0:operation-client-interface-pac:
                                        type: object
                                        required:
                                          - operation-client-interface-configuration
                                          - operation-client-interface-status
                                        properties:
                                          operation-client-interface-configuration:
                                            type: object
                                            required:
                                              - operation-name
                                              - operation-key
                                            properties:
                                              operation-name:
                                                type: string
                                              operation-key:
                                                type: string
                                              detailed-logging-is-on:
                                                type: boolean
                                          operation-client-interface-status:
                                            type: object
                                            required:
                                              - operational-state
                                              - life-cycle-state
                                            properties:
                                              operational-state:
                                                type: string
                                                enum:
                                                  - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_AVAILABLE'
                                                  - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_UNAVAILABLE'
                                                  - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
                                              life-cycle-state:
                                                type: string
                                                enum:
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                                                  - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                                  - description: 'elasticsearch client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac:
                                        type: object
                                        required:
                                          - elasticsearch-client-interface-configuration
                                          - elasticsearch-client-interface-status
                                        properties:
                                          elasticsearch-client-interface-configuration:
                                            type: object
                                            required:
                                              - auth
                                              - index-alias
                                            properties:
                                              auth:
                                                type: object
                                                minProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  api-key:
                                                    type: string
                                                    description: 'base64EncodedKey'
                                              index-alias:
                                                type: string
                                              service-records-policy:
                                                type: object
                                                required:
                                                  - service-records-policy-name
                                                  - phases
                                                properties:
                                                  service-records-policy-name:
                                                    type: string
                                                  master-timeout:
                                                    type: string
                                                  timeout:
                                                    type: string
                                                  description:
                                                    type: string
                                                  project:
                                                    type: object
                                                    properties:
                                                      name:
                                                        type: string
                                                      department:
                                                        type: string
                                                  phases:
                                                    type: object
                                                    properties:
                                                      hot:
                                                        type: object
                                                        properties:
                                                          min-age:
                                                            type: string
                                                          actions:
                                                            type: object
                                                            properties:
                                                              forcemerge:
                                                                type: object
                                                                required:
                                                                  - max-num-segments
                                                                properties:
                                                                  max-num-segments:
                                                                    type: integer
                                                                  index-codec:
                                                                    type: string
                                                              readonly:
                                                                type: object
                                                              rollover:
                                                                type: object
                                                                minProperties: 1
                                                                additionalProperties: false
                                                                properties:
                                                                  max-age:
                                                                    type: string
                                                                  max-docs:
                                                                    type: integer
                                                                  max-size:
                                                                    type: string
                                                                  max-primary-shard-size:
                                                                    type: string
                                                                  max-primary-shard-docs:
                                                                    type: integer
                                                                  min-age:
                                                                    type: string
                                                                  min-docs:
                                                                    type: integer
                                                                  min-size:
                                                                    type: string
                                                                  min-primary-shard-size:
                                                                    type: string
                                                                  min-primary-shard-docs:
                                                                    type: integer
                                                              searchable-snapshot:
                                                                type: object
                                                                required:
                                                                  - snapshot-repository
                                                                properties:
                                                                  snapshot-repository:
                                                                    type: string
                                                                  force-merge-index:
                                                                    type: boolean
                                                              set-priority:
                                                                type: object
                                                                required:
                                                                  - priority
                                                                properties:
                                                                  priority:
                                                                    type: integer
                                                              shrink:
                                                                type: object
                                                                properties:
                                                                  number-of-shards:
                                                                    type: integer
                                                                  max-primary-shard-size:
                                                                    type: string
                                                              unfollow:
                                                                type: object
                                                      warm:
                                                        type: object
                                                        properties:
                                                          min-age:
                                                            type: string
                                                          actions:
                                                            type: object
                                                            properties:
                                                              allocate:
                                                                type: object
                                                                minProperties: 1
                                                                additionalProperties: false
                                                                properties:
                                                                  number-of-replicas:
                                                                    type: integer
                                                                  total-shards-per-node:
                                                                    type: integer
                                                                  include:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                  exclude:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                  require:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                      storage:
                                                                        type: string
                                                                        enum:
                                                                          - 'high'
                                                              forcemerge:
                                                                type: object
                                                                required:
                                                                  - max-num-segments
                                                                properties:
                                                                  max-num-segments:
                                                                    type: integer
                                                                  index-codec:
                                                                    type: string
                                                              migrate:
                                                                type: object
                                                                properties:
                                                                  enabled:
                                                                    type: boolean
                                                              readonly:
                                                                type: object
                                                              set-priority:
                                                                type: object
                                                                required:
                                                                  - priority
                                                                properties:
                                                                  priority:
                                                                    type: integer
                                                              shrink:
                                                                type: object
                                                                properties:
                                                                  number-of-shards:
                                                                    type: integer
                                                                  max-primary-shard-size:
                                                                    type: string
                                                              unfollow:
                                                                type: object
                                                      cold:
                                                        type: object
                                                        properties:
                                                          min-age:
                                                            type: string
                                                          actions:
                                                            type: object
                                                            properties:
                                                              allocate:
                                                                type: object
                                                                minProperties: 1
                                                                additionalProperties: false
                                                                properties:
                                                                  number-of-replicas:
                                                                    type: integer
                                                                  total-shards-per-node:
                                                                    type: integer
                                                                  include:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                  exclude:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                  require:
                                                                    type: object
                                                                    properties:
                                                                      box-type:
                                                                        type: string
                                                                        enum:
                                                                          - 'hot'
                                                                          - 'warm'
                                                                          - 'cold'
                                                                          - 'frozen'
                                                                          - 'delete'
                                                                      storage:
                                                                        type: string
                                                                        enum:
                                                                          - 'high'
                                                              migrate:
                                                                type: object
                                                                properties:
                                                                  enabled:
                                                                    type: boolean
                                                              readonly:
                                                                type: object
                                                              searchable-snapshot:
                                                                type: object
                                                                required:
                                                                  - snapshot-repository
                                                                properties:
                                                                  snapshot-repository:
                                                                    type: string
                                                                  force-merge-index:
                                                                    type: boolean
                                                              set-priority:
                                                                type: object
                                                                required:
                                                                  - priority
                                                                properties:
                                                                  priority:
                                                                    type: integer
                                                              unfollow:
                                                                type: object
                                                      frozen:
                                                        type: object
                                                        properties:
                                                          min-age:
                                                            type: string
                                                          actions:
                                                            type: object
                                                            properties:
                                                              searchable-snapshot:
                                                                type: object
                                                                required:
                                                                  - snapshot-repository
                                                                properties:
                                                                  snapshot-repository:
                                                                    type: string
                                                                  force-merge-index:
                                                                    type: boolean
                                                              unfollow:
                                                                type: object
                                                      delete:
                                                        type: object
                                                        properties:
                                                          min-age:
                                                            type: string
                                                          actions:
                                                            type: object
                                                            required:
                                                              - delete
                                                            properties:
                                                              delete:
                                                                type: object
                                                                properties:
                                                                  delete-searchable-snapshot:
                                                                    type: boolean
                                                              wait-for-snapshot:
                                                                type: object
                                                                required:
                                                                  - policy
                                                                properties:
                                                                  policy:
                                                                    type: string
                                          elasticsearch-client-interface-status:
                                            type: object
                                            required:
                                              - operational-state
                                              - life-cycle-state
                                            properties:
                                              operational-state:
                                                type: string
                                                enum:
                                                  - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_AVAILABLE'
                                                  - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_UNAVAILABLE'
                                                  - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
                                              life-cycle-state:
                                                type: string
                                                enum:
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                                                  - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                                  - description: 'http client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - http-client-interface-1-0:http-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      http-client-interface-1-0:http-client-interface-pac:
                                        type: object
                                        required:
                                          - http-client-interface-configuration
                                        properties:
                                          http-client-interface-configuration:
                                            type: object
                                            required:
                                              - application-name
                                              - release-number
                                            properties:
                                              application-name:
                                                type: string
                                              release-number:
                                                type: string
                                  - description: 'tcp client'
                                    type: object
                                    required:
                                      - local-id
                                      - layer-protocol-name
                                      - tcp-client-interface-1-0:tcp-client-interface-pac
                                    properties:
                                      local-id:
                                        type: string
                                      layer-protocol-name:
                                        type: string
                                        enum:
                                          - 'operation-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'http-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-server-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                          - 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                          - 'elasticsearch-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_ELASTICSEARCH_LAYER'
                                          - 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                          - 'tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER'
                                      tcp-client-interface-1-0:tcp-client-interface-pac:
                                        type: object
                                        required:
                                          - tcp-client-interface-configuration
                                        properties:
                                          tcp-client-interface-configuration:
                                            type: object
                                            required:
                                              - remote-address
                                              - remote-port
                                            properties:
                                              remote-address:
                                                type: object
                                                minProperties: 1
                                                maxProperties: 1
                                                additionalProperties: false
                                                properties:
                                                  ip-address:
                                                    type: object
                                                    minProperties: 1
                                                    additionalProperties: false
                                                    properties:
                                                      ipv-4-address:
                                                        type: string
                                                  domain-name:
                                                    type: string
                                              remote-port:
                                                type: integer
                        example:
                          - uuid: 'ro-2-0-0-op-c-bm-ro-2-0-0-000'
                            ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SINK'
                            client-ltp: []
                            server-ltp: ['ro-2-0-0-http-c-bm-ro-2-0-0-000']
                            layer-protocol:
                              - local-id: '0'
                                layer-protocol-name: 'operation-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_OPERATION_LAYER'
                                operation-client-interface-1-0:operation-client-interface-pac:
                                  operation-client-interface-configuration:
                                    operation-name: '/v1/register-application'
                                    operation-key: 'Operation key not yet provided.'
                                  operation-client-interface-status:
                                    operational-state: 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
                                    life-cycle-state: 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                          - uuid: 'ro-2-0-0-http-c-bm-ro-2-0-0-000'
                            ltp-direction: 'core-model-1-4:TERMINATION_DIRECTION_SINK'
                            client-ltp: ['ro-2-0-0-op-c-bm-ro-2-0-0-000']
                            server-ltp: ['ro-2-0-0-tcp-c-bm-ro-2-0-0-000']
                            layer-protocol:
                              - local-id: '0'
                                layer-protocol-name: 'http-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_HTTP_LAYER'
                                http-client-interface-1-0:http-client-interface-pac:
                                  http-client-interface-configuration:
                                    application-name: 'RegistryOffice'
                                    release-number: '2.0.0'
                      forwarding-domain:
                        type: array
                        minItems: 1
                        maxItems: 1
                        items:
                          type: object
                          required:
                            - uuid
                            - forwarding-construct
                          properties:
                            uuid:
                              type: string
                            forwarding-construct:
                              type: array
                              items:
                                type: object
                                required:
                                  - uuid
                                  - name
                                  - fc-port
                                properties:
                                  uuid:
                                    type: string
                                  name:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - value-name
                                        - value
                                      properties:
                                        value-name:
                                          type: string
                                        value:
                                          type: string
                                  fc-port:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - local-id
                                        - port-direction
                                        - logical-termination-point
                                      properties:
                                        local-id:
                                          type: string
                                        port-direction:
                                          type: string
                                          enum:
                                            - 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                            - 'core-model-1-4:PORT_DIRECTION_TYPE_INPUT'
                                            - 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                                        logical-termination-point:
                                          type: string
                        example:
                          - uuid: 'ro-2-0-0-op-fd-000'
                            forwarding-construct:
                              - uuid: 'ro-2-0-0-op-fc-bm-003'
                                name:
                                  - value-name: 'ForwardingKind'
                                    value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                  - value-name: 'ForwardingName'
                                    value: 'OamRequestCausesLoggingRequest'
                                fc-port:
                                  - local-id: '000'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                    logical-termination-point: 'ro-2-0-0-op-s-bm-003'
                                  - local-id: '200'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                                    logical-termination-point: 'ro-2-0-0-op-c-bs-ol-2-0-0-000'
                              - uuid: 'ro-2-0-0-op-fc-bm-004'
                                name:
                                  - value-name: 'ForwardingKind'
                                    value: 'core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET'
                                  - value-name: 'ForwardingName'
                                    value: 'OamRequestCausesInquiryForAuthentication'
                                fc-port:
                                  - local-id: '000'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_MANAGEMENT'
                                    logical-termination-point: 'ro-2-0-0-op-s-bm-005'
                                  - local-id: '200'
                                    port-direction: 'core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT'
                                    logical-termination-point: 'ro-2-0-0-op-c-bs-aa-2-0-0-000'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

  /core-model-1-4:control-construct/profile-collection/profile={uuid}:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([a-z]+)-p-([0-9,a-f]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getProfileInstance
      summary: 'Returns entire instance of Profile'
      tags:
        - Core
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Instance of Profile provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - core-model-1-4:profile
                properties:
                  core-model-1-4:profile:
                    oneOf:
                      - description: 'action profile'
                        type: object
                        required:
                          - uuid
                          - profile-name
                          - action-profile-1-0:action-profile-pac
                        properties:
                          uuid:
                            type: string
                          profile-name:
                            type: string
                            enum:
                              - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                              - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                              - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                              - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                          action-profile-1-0:action-profile-pac:
                            type: object
                            required:
                              - action-profile-capability
                              - action-profile-configuration
                            properties:
                              action-profile-capability:
                                type: object
                                required:
                                  - operation-name
                                  - label
                                  - display-in-new-browser-window
                                properties:
                                  operation-name:
                                    type: string
                                  label:
                                    type: string
                                  input-value-list:
                                    type: array
                                    items:
                                      type: object
                                      required:
                                        - field-name
                                      properties:
                                        field-name:
                                          type: string
                                        unit:
                                          type: string
                                  display-in-new-browser-window:
                                    type: boolean
                              action-profile-configuration:
                                type: object
                                required:
                                  - request
                                properties:
                                  request:
                                    type: string
                      - description: 'file profile'
                        type: object
                        required:
                          - uuid
                          - profile-name
                          - file-profile-1-0:file-profile-pac
                        properties:
                          uuid:
                            type: string
                          profile-name:
                            type: string
                            enum:
                              - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                              - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                              - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                              - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                          file-profile-1-0:file-profile-pac:
                            type: object
                            required:
                              - file-profile-capability
                              - file-profile-configuration
                            properties:
                              file-profile-capability:
                                type: object
                                required:
                                  - file-identifier
                                  - file-description
                                properties:
                                  file-identifier:
                                    type: string
                                  file-description:
                                    type: string
                              file-profile-configuration:
                                type: object
                                required:
                                  - file-path
                                properties:
                                  file-path:
                                    type: string
                                  user-name:
                                    type: string
                                  password:
                                    type: string
                                  operation:
                                    type: string
                                    enum:
                                      - 'file-profile-1-0:OPERATION_TYPE_READ_ONLY'
                                      - 'file-profile-1-0:OPERATION_TYPE_READ_WRITE'
                                      - 'file-profile-1-0:OPERATION_TYPE_OFF'
                                      - 'file-profile-1-0:OPERATION_TYPE_NOT_YET_DEFINED'
                      - description: 'integer profile'
                        type: object
                        required:
                          - uuid
                          - profile-name
                          - integer-profile-1-0:integer-profile-pac
                        properties:
                          uuid:
                            type: string
                          profile-name:
                            type: string
                            enum:
                              - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                              - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                              - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                              - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                          integer-profile-1-0:integer-profile-pac:
                            type: object
                            required:
                              - integer-profile-capability
                              - integer-profile-configuration
                            properties:
                              integer-profile-capability:
                                type: object
                                required:
                                  - integer-name
                                properties:
                                  integer-name:
                                    type: string
                                  unit:
                                    type: string
                                  minimum:
                                    type: integer
                                  maximum:
                                    type: integer
                              integer-profile-configuration:
                                type: object
                                required:
                                  - integer-value
                                properties:
                                  integer-value:
                                    type: integer
                      - description: 'string profile'
                        type: object
                        required:
                          - uuid
                          - profile-name
                          - string-profile-1-0:string-profile-pac
                        properties:
                          uuid:
                            type: string
                          profile-name:
                            type: string
                            enum:
                              - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                              - 'file-profile-1-0:PROFILE_NAME_TYPE_FILE_PROFILE'
                              - 'integer-profile-1-0:PROFILE_NAME_TYPE_INTEGER_PROFILE'
                              - 'string-profile-1-0:PROFILE_NAME_TYPE_STRING_PROFILE'
                          string-profile-1-0:string-profile-pac:
                            type: object
                            required:
                              - string-profile-capability
                              - string-profile-configuration
                            properties:
                              string-profile-capability:
                                type: object
                                required:
                                  - string-name
                                properties:
                                  string-name:
                                    type: string
                              string-profile-configuration:
                                type: object
                                required:
                                  - string-value
                                properties:
                                  string-value:
                                    type: string
              example:
                core-model-1-4:profile:
                  uuid: 'ro-2-0-0-action-p-000'
                  profile-name: 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE'
                  action-profile-1-0:action-profile-pac:
                    action-profile-capability:
                      operation-name: '/v1/start-application-in-generic-representation'
                      label: 'Inform about Application'
                      input-value-list:
                        - field-name: 'Label of input field'
                          unit: 'Unit at input field'
                      display-in-new-browser-window: false
                    action-profile-configuration:
                      request: 'https://1.1.4.1:4001/v1/inform-about-application-in-generic-representation'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'


  /core-model-1-4:control-construct/profile-collection/profile={uuid}/integer-profile-1-0:integer-profile-pac/integer-profile-capability/integer-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-integer-p-([0-9]{3})$'
          example: 'ro-2-0-0-integer-p-000'
    get:
      operationId: getIntegerProfileIntegerName
      summary: 'Returns the name of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Integer name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - integer-profile-1-0:integer-name
                properties:
                  integer-profile-1-0:integer-name:
                    type: string
                    example: 'maximumNumberOfEntries'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/integer-profile-1-0:integer-profile-pac/integer-profile-capability/unit:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-integer-p-([0-9]{3})$'
          example: 'ro-2-0-0-integer-p-000'
    get:
      operationId: getIntegerProfileUnit
      summary: 'Returns the unit of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Integer unit provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - integer-profile-1-0:unit
                properties:
                  integer-profile-1-0:unit:
                    type: string
                    example: 'records'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/integer-profile-1-0:integer-profile-pac/integer-profile-capability/minimum:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-integer-p-([0-9]{3})$'
          example: 'ro-2-0-0-integer-p-000'
    get:
      operationId: getIntegerProfileMinimum
      summary: 'Returns the minimum value of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Minimum value provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - integer-profile-1-0:minimum
                properties:
                  integer-profile-1-0:minimum:
                    type: integer
                    example: 0
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/integer-profile-1-0:integer-profile-pac/integer-profile-capability/maximum:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-integer-p-([0-9]{3})$'
          example: 'ro-2-0-0-integer-p-000'
    get:
      operationId: getIntegerProfileMaximum
      summary: 'Returns the maximum value of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Maximum value provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - integer-profile-1-0:maximum
                properties:
                  integer-profile-1-0:maximum:
                    type: integer
                    example: 1000000
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/integer-profile-1-0:integer-profile-pac/integer-profile-configuration/integer-value:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-integer-p-([0-9]{3})$'
          example: 'ro-2-0-0-integer-p-000'
    get:
      operationId: getIntegerProfileIntegerValue
      summary: 'Returns the configured value of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Integer value provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - integer-profile-1-0:integer-value
                properties:
                  integer-profile-1-0:integer-value:
                    type: integer
                    example: 1000000
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putIntegerProfileIntegerValue
      summary: 'Configures value of the Integer'
      tags:
        - IntegerProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - integer-profile-1-0:integer-value
              properties:
                integer-profile-1-0:integer-value:
                  type: integer
                  example: 1000000
      responses:
        '204':
          description: 'Integer value configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-capability/file-identifier:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfileFileIdentifier
      summary: 'Returns the identifier of the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'File identifier provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:file-identifier
                properties:
                  file-profile-1-0:file-identifier:
                    type: string
                    example: 'applicationData'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-capability/file-description:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfileFileDescription
      summary: 'Returns the description of the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'File description provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:file-description
                properties:
                  file-profile-1-0:file-description:
                    type: string
                    example: 'Holds administrator-names, user-names, authorization codes and allowed-methods.'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-configuration/file-path:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfileFilePath
      summary: 'Returns the path of the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'File path provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:file-path
                properties:
                  file-profile-1-0:file-path:
                    type: string
                    example: '../application-data/application-data.json'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putFileProfileFilePath
      summary: 'Configures path of the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - file-profile-1-0:file-path
              properties:
                file-profile-1-0:file-path:
                  type: string
                  example: '../application-data/application-data.json'
      responses:
        '204':
          description: 'File path configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-configuration/user-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfileUserName
      summary: 'Returns the user name for acccessing the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'User name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:user-name
                properties:
                  file-profile-1-0:user-name:
                    type: string
                    example: 'firstname.surname'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putFileProfileUserName
      summary: 'Configures the user name for acccessing the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - file-profile-1-0:user-name
              properties:
                file-profile-1-0:user-name:
                  type: string
                  example: 'firstname.surname'
      responses:
        '204':
          description: 'User name configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-configuration/password:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfilePassword
      summary: 'Returns the password for acccessing the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Password provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:password
                properties:
                  file-profile-1-0:password:
                    type: string
                    example: 'stupid_phrase'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putFileProfilePassword
      summary: 'Configures the password for acccessing the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - file-profile-1-0:password
              properties:
                file-profile-1-0:password:
                  type: string
                  example: 'stupid_phrase'
      responses:
        '204':
          description: 'Password configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/file-profile-1-0:file-profile-pac/file-profile-configuration/operation:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-file-p-([0-9]{3})$'
          example: 'ro-2-0-0-file-p-000'
    get:
      operationId: getFileProfileOperation
      summary: 'Returns the allowed operation on the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - file-profile-1-0:operation
                properties:
                  file-profile-1-0:operation:
                    type: string
                    enum:
                      - 'file-profile-1-0:OPERATION_TYPE_READ_ONLY'
                      - 'file-profile-1-0:OPERATION_TYPE_READ_WRITE'
                      - 'file-profile-1-0:OPERATION_TYPE_OFF'
                      - 'file-profile-1-0:OPERATION_TYPE_NOT_YET_DEFINED'
                    example: 'file-profile-1-0:OPERATION_TYPE_READ_ONLY'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putFileProfileOperation
      summary: 'Configures the allowed operation on the file'
      tags:
        - FileProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - file-profile-1-0:operation
              properties:
                file-profile-1-0:operation:
                  type: string
                  enum:
                    - 'file-profile-1-0:OPERATION_TYPE_READ_ONLY'
                    - 'file-profile-1-0:OPERATION_TYPE_READ_WRITE'
                    - 'file-profile-1-0:OPERATION_TYPE_OFF'
                    - 'file-profile-1-0:OPERATION_TYPE_NOT_YET_DEFINED'
                  example: 'file-profile-1-0:OPERATION_TYPE_READ_WRITE'
      responses:
        '204':
          description: 'Operation configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'


  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-configuration/auth/api-key:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-es-c-im-([0-9]{3})$'
          example: 'ro-2-0-0-es-c-im-000'
    get:
      operationId: getElasticsearchClientApiKey
      summary: 'Returns API key'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'API key provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - elasticsearch-client-interface-1-0:api-key
                properties:
                  elasticsearch-client-interface-1-0:api-key:
                    type: string
                    example: 'YWRtaW46MTIzNDU2'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putElasticsearchClientApiKey
      summary: 'Configures API key'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - elasticsearch-client-interface-1-0:api-key
              properties:
                elasticsearch-client-interface-1-0:api-key:
                  type: string
      responses:
        '204':
          description: 'API key configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-configuration/index-alias:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-es-c-im-([0-9]{3})$'
          example: 'ro-2-0-0-es-c-im-000'
    get:
      operationId: getElasticsearchClientIndexAlias
      summary: 'Returns index alias'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Index alias provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - elasticsearch-client-interface-1-0:index-alias
                properties:
                  elasticsearch-client-interface-1-0:index-alias:
                    type: string
                    example: 'eatl_service_records'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putElasticsearchClientIndexAlias
      summary: 'Configures index alias'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - elasticsearch-client-interface-1-0:index-alias
              properties:
                elasticsearch-client-interface-1-0:index-alias:
                  type: string
      responses:
        '204':
          description: 'Index alias configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-configuration/service-records-policy:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-es-c-im-([0-9]{3})$'
          example: 'ro-2-0-0-es-c-im-000'
    get:
      operationId: getElasticsearchClientServiceRecordsPolicy
      summary: 'Returns service records policy'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Service records policy provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - elasticsearch-client-interface-1-0:service-records-policy
                properties:
                  elasticsearch-client-interface-1-0:service-records-policy:
                    type: object
                    required:
                      - service-records-policy-name
                      - phases
                    properties:
                      service-records-policy-name:
                        type: string
                      master-timeout:
                        type: string
                      timeout:
                        type: string
                      description:
                        type: string
                      project:
                        type: object
                        properties:
                          name:
                            type: string
                          department:
                            type: string
                      phases:
                        type: object
                        properties:
                          hot:
                            type: object
                            properties:
                              min-age:
                                type: string
                              actions:
                                type: object
                                properties:
                                  forcemerge:
                                    type: object
                                    required:
                                      - max-num-segments
                                    properties:
                                      max-num-segments:
                                        type: integer
                                      index-codec:
                                        type: string
                                  readonly:
                                    type: object
                                  rollover:
                                    type: object
                                    minProperties: 1
                                    additionalProperties: false
                                    properties:
                                      max-age:
                                        type: string
                                      max-docs:
                                        type: integer
                                      max-size:
                                        type: string
                                      max-primary-shard-size:
                                        type: string
                                      max-primary-shard-docs:
                                        type: integer
                                      min-age:
                                        type: string
                                      min-docs:
                                        type: integer
                                      min-size:
                                        type: string
                                      min-primary-shard-size:
                                        type: string
                                      min-primary-shard-docs:
                                        type: integer
                                  searchable-snapshot:
                                    type: object
                                    required:
                                      - snapshot-repository
                                    properties:
                                      snapshot-repository:
                                        type: string
                                      force-merge-index:
                                        type: boolean
                                  set-priority:
                                    type: object
                                    required:
                                      - priority
                                    properties:
                                      priority:
                                        type: integer
                                  shrink:
                                    type: object
                                    properties:
                                      number-of-shards:
                                        type: integer
                                      max-primary-shard-size:
                                        type: string
                                  unfollow:
                                    type: object
                          warm:
                            type: object
                            properties:
                              min-age:
                                type: string
                              actions:
                                type: object
                                properties:
                                  allocate:
                                    type: object
                                    minProperties: 1
                                    additionalProperties: false
                                    properties:
                                      number-of-replicas:
                                        type: integer
                                      total-shards-per-node:
                                        type: integer
                                      include:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                      exclude:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                      require:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                          storage:
                                            type: string
                                            enum:
                                              - 'high'
                                  forcemerge:
                                    type: object
                                    required:
                                      - max-num-segments
                                    properties:
                                      max-num-segments:
                                        type: integer
                                      index-codec:
                                        type: string
                                  migrate:
                                    type: object
                                    properties:
                                      enabled:
                                        type: boolean
                                  readonly:
                                    type: object
                                  set-priority:
                                    type: object
                                    required:
                                      - priority
                                    properties:
                                      priority:
                                        type: integer
                                  shrink:
                                    type: object
                                    properties:
                                      number-of-shards:
                                        type: integer
                                      max-primary-shard-size:
                                        type: string
                                  unfollow:
                                    type: object
                          cold:
                            type: object
                            properties:
                              min-age:
                                type: string
                              actions:
                                type: object
                                properties:
                                  allocate:
                                    type: object
                                    minProperties: 1
                                    additionalProperties: false
                                    properties:
                                      number-of-replicas:
                                        type: integer
                                      total-shards-per-node:
                                        type: integer
                                      include:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                      exclude:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                      require:
                                        type: object
                                        properties:
                                          box-type:
                                            type: string
                                            enum:
                                              - 'hot'
                                              - 'warm'
                                              - 'cold'
                                              - 'frozen'
                                              - 'delete'
                                          storage:
                                            type: string
                                            enum:
                                              - 'high'
                                  migrate:
                                    type: object
                                    properties:
                                      enabled:
                                        type: boolean
                                  readonly:
                                    type: object
                                  searchable-snapshot:
                                    type: object
                                    required:
                                      - snapshot-repository
                                    properties:
                                      snapshot-repository:
                                        type: string
                                      force-merge-index:
                                        type: boolean
                                  set-priority:
                                    type: object
                                    required:
                                      - priority
                                    properties:
                                      priority:
                                        type: integer
                                  unfollow:
                                    type: object
                          frozen:
                            type: object
                            properties:
                              min-age:
                                type: string
                              actions:
                                type: object
                                properties:
                                  searchable-snapshot:
                                    type: object
                                    required:
                                      - snapshot-repository
                                    properties:
                                      snapshot-repository:
                                        type: string
                                      force-merge-index:
                                        type: boolean
                                  unfollow:
                                    type: object
                          delete:
                            type: object
                            properties:
                              min-age:
                                type: string
                              actions:
                                type: object
                                required:
                                  - delete
                                properties:
                                  delete:
                                    type: object
                                    properties:
                                      delete-searchable-snapshot:
                                        type: boolean
                                  wait-for-snapshot:
                                    type: object
                                    required:
                                      - policy
                                    properties:
                                      policy:
                                        type: string
                    example:
                      service-records-policy-name: 'eatl_service_records_policy'
                      phases:
                        hot:
                          min-age: '30s'
                          actions:
                            rollover:
                              max-age: '5d'
                        delete:
                          min-age: '5d'
                          actions:
                            delete:
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putElasticsearchClientServiceRecordsPolicy
      summary: 'Configures service records policy'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - elasticsearch-client-interface-1-0:service-records-policy
              properties:
                elasticsearch-client-interface-1-0:service-records-policy:
                  type: object
                  required:
                    - service-records-policy-name
                    - phases
                  properties:
                    service-records-policy-name:
                      type: string
                    master-timeout:
                      type: string
                    timeout:
                      type: string
                    description:
                      type: string
                    project:
                      type: object
                      properties:
                        name:
                          type: string
                        department:
                          type: string
                    phases:
                      type: object
                      properties:
                        hot:
                          type: object
                          properties:
                            min-age:
                              type: string
                            actions:
                              type: object
                              properties:
                                forcemerge:
                                  type: object
                                  required:
                                    - max-num-segments
                                  properties:
                                    max-num-segments:
                                      type: integer
                                    index-codec:
                                      type: string
                                readonly:
                                  type: object
                                rollover:
                                  type: object
                                  minProperties: 1
                                  additionalProperties: false
                                  properties:
                                    max-age:
                                      type: string
                                    max-docs:
                                      type: integer
                                    max-size:
                                      type: string
                                    max-primary-shard-size:
                                      type: string
                                    max-primary-shard-docs:
                                      type: integer
                                    min-age:
                                      type: string
                                    min-docs:
                                      type: integer
                                    min-size:
                                      type: string
                                    min-primary-shard-size:
                                      type: string
                                    min-primary-shard-docs:
                                      type: integer
                                searchable-snapshot:
                                  type: object
                                  required:
                                    - snapshot-repository
                                  properties:
                                    snapshot-repository:
                                      type: string
                                    force-merge-index:
                                      type: boolean
                                set-priority:
                                  type: object
                                  required:
                                    - priority
                                  properties:
                                    priority:
                                      type: integer
                                shrink:
                                  type: object
                                  properties:
                                    number-of-shards:
                                      type: integer
                                    max-primary-shard-size:
                                      type: string
                                unfollow:
                                  type: object
                        warm:
                          type: object
                          properties:
                            min-age:
                              type: string
                            actions:
                              type: object
                              properties:
                                allocate:
                                  type: object
                                  minProperties: 1
                                  additionalProperties: false
                                  properties:
                                    number-of-replicas:
                                      type: integer
                                    total-shards-per-node:
                                      type: integer
                                    include:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                    exclude:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                    require:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                        storage:
                                          type: string
                                          enum:
                                            - 'high'
                                forcemerge:
                                  type: object
                                  required:
                                    - max-num-segments
                                  properties:
                                    max-num-segments:
                                      type: integer
                                    index-codec:
                                      type: string
                                migrate:
                                  type: object
                                  properties:
                                    enabled:
                                      type: boolean
                                readonly:
                                  type: object
                                set-priority:
                                  type: object
                                  required:
                                    - priority
                                  properties:
                                    priority:
                                      type: integer
                                shrink:
                                  type: object
                                  properties:
                                    number-of-shards:
                                      type: integer
                                    max-primary-shard-size:
                                      type: string
                                unfollow:
                                  type: object
                        cold:
                          type: object
                          properties:
                            min-age:
                              type: string
                            actions:
                              type: object
                              properties:
                                allocate:
                                  type: object
                                  minProperties: 1
                                  additionalProperties: false
                                  properties:
                                    number-of-replicas:
                                      type: integer
                                    total-shards-per-node:
                                      type: integer
                                    include:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                    exclude:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                    require:
                                      type: object
                                      properties:
                                        box-type:
                                          type: string
                                          enum:
                                            - 'hot'
                                            - 'warm'
                                            - 'cold'
                                            - 'frozen'
                                            - 'delete'
                                        storage:
                                          type: string
                                          enum:
                                            - 'high'
                                migrate:
                                  type: object
                                  properties:
                                    enabled:
                                      type: boolean
                                readonly:
                                  type: object
                                searchable-snapshot:
                                  type: object
                                  required:
                                    - snapshot-repository
                                  properties:
                                    snapshot-repository:
                                      type: string
                                    force-merge-index:
                                      type: boolean
                                set-priority:
                                  type: object
                                  required:
                                    - priority
                                  properties:
                                    priority:
                                      type: integer
                                unfollow:
                                  type: object
                        frozen:
                          type: object
                          properties:
                            min-age:
                              type: string
                            actions:
                              type: object
                              properties:
                                searchable-snapshot:
                                  type: object
                                  required:
                                    - snapshot-repository
                                  properties:
                                    snapshot-repository:
                                      type: string
                                    force-merge-index:
                                      type: boolean
                                unfollow:
                                  type: object
                        delete:
                          type: object
                          properties:
                            min-age:
                              type: string
                            actions:
                              type: object
                              required:
                                - delete
                              properties:
                                delete:
                                  type: object
                                  properties:
                                    delete-searchable-snapshot:
                                      type: boolean
                                wait-for-snapshot:
                                  type: object
                                  required:
                                    - policy
                                  properties:
                                    policy:
                                      type: string
                  example:
                    service-records-policy-name: 'eatl_service_records_policy'
                    phases:
                      hot:
                        min-age: '30s'
                        actions:
                          rollover:
                            max-age: '5d'
                      delete:
                        min-age: '5d'
                        actions:
                          delete:
                            delete-searchable-snapshot: true
      responses:
        '204':
          description: 'Service records policy configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-status/operational-state:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-es-c-im-([0-9]{3})$'
          example: 'ro-2-0-0-es-c-im-000'
    get:
      operationId: getElasticsearchClientOperationalState
      summary: 'Returns operational state of the connection towards Elasticsearch'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operational state provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - elasticsearch-client-interface-1-0:operational-state
                properties:
                  elasticsearch-client-interface-1-0:operational-state:
                    type: string
                    enum:
                      - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_AVAILABLE'
                      - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_UNAVAILABLE'
                      - 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
                    example: 'elasticsearch-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/elasticsearch-client-interface-1-0:elasticsearch-client-interface-pac/elasticsearch-client-interface-status/life-cycle-state:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-es-c-im-([0-9]{3})$'
          example: 'ro-2-0-0-es-c-im-000'
    get:
      operationId: getElasticsearchClientLifeCycleState
      summary: 'Returns life cycle state of the connection towards Elasticsearch'
      tags:
        - ElasticsearchClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Life cycle state provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - elasticsearch-client-interface-1-0:life-cycle-state
                properties:
                  elasticsearch-client-interface-1-0:life-cycle-state:
                    type: string
                    enum:
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                      - 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                    example: 'elasticsearch-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

########################################################################################################################
#   OAM Layer - Basic Part - Following paths must be copied into every application
########################################################################################################################
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/action-profile-1-0:action-profile-pac/action-profile-capability/operation-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-action-p-([0-9]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getActionProfileOperationName
      summary: 'Returns the name of the Operation'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - action-profile-1-0:operation-name
                properties:
                  action-profile-1-0:operation-name:
                    type: string
                    example: '/v1/start-application-in-generic-representation'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/action-profile-1-0:action-profile-pac/action-profile-capability/label:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-action-p-([0-9]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getActionProfileLabel
      summary: 'Returns the Label of the Action'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Label provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - action-profile-1-0:label
                properties:
                  action-profile-1-0:label:
                    type: string
                    example: 'Inform about Application'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/action-profile-1-0:action-profile-pac/action-profile-capability/input-value-list:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-action-p-([0-9]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getActionProfileInputValueListt
      summary: 'Returns the list of input values'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Input values provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - action-profile-1-0:input-value-list
                properties:
                  action-profile-1-0:input-value-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                        - field-name
                      properties:
                        field-name:
                          type: string
                          example: 'Label of input field'
                        unit:
                          type: string
                          example: 'Unit at input field'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/action-profile-1-0:action-profile-pac/action-profile-capability/display-in-new-browser-window:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-action-p-([0-9]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getActionProfileDisplayInNewBrowserWindow
      summary: 'Returns whether to be presented in new browser window'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Whether to be presented in new browser window provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - action-profile-1-0:display-in-new-browser-window
                properties:
                  action-profile-1-0:display-in-new-browser-window:
                    type: boolean
                    example: false
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/profile-collection/profile={uuid}/action-profile-1-0:action-profile-pac/action-profile-configuration/request:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-action-p-([0-9]{3})$'
          example: 'ro-2-0-0-action-p-000'
    get:
      operationId: getActionProfileRequest
      summary: 'Returns the configured path of the Request'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Request path provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - action-profile-1-0:request
                properties:
                  action-profile-1-0:request:
                    type: string
                    example: 'https://1.1.4.1:4001/v1/inform-about-application-in-generic-representation'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putActionProfileRequest
      summary: 'Configures path of the Request'
      tags:
        - ActionProfile
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - action-profile-1-0:request
              properties:
                action-profile-1-0:request:
                  type: string
                  example: 'https://1.1.4.1:4001/v1/inform-about-application-in-generic-representation'
      responses:
        '204':
          description: 'Request path configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'


  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-s-([bi][ms])-([0-9]{3})$'
          example: 'ro-2-0-0-op-s-bm-000'
    get:
      operationId: getOperationServerOperationName
      summary: 'Returns operation name'
      tags:
        - OperationServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-server-interface-1-0:operation-name
                properties:
                  operation-server-interface-1-0:operation-name:
                    type: string
                    example: '/v1/register-yourself'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/life-cycle-state:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-s-([bi][ms])-([0-9]{3})$'
          example: 'ro-2-0-0-op-s-bm-000'
    get:
      operationId: getOperationServerLifeCycleState
      summary: 'Returns the configured life cycle state of the operation'
      tags:
        - OperationServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Life cycle state provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-server-interface-1-0:life-cycle-state
                properties:
                  operation-server-interface-1-0:life-cycle-state:
                    type: string
                    enum:
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                      - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                    example: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putOperationServerLifeCycleState
      summary: 'Configures life cycle state'
      tags:
        - OperationServer
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-server-interface-1-0:life-cycle-state
              properties:
                operation-server-interface-1-0:life-cycle-state:
                  type: string
                  enum:
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                    - 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                  example: 'operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
      responses:
        '204':
          description: 'Life cycle state configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-configuration/operation-key:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-s-([bi][ms])-([0-9]{3})$'
          example: 'ro-2-0-0-op-s-bm-000'
    get:
      operationId: getOperationServerOperationKey
      summary: 'Returns key for connecting'
      tags:
        - OperationServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation key provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-server-interface-1-0:operation-key
                properties:
                  operation-server-interface-1-0:operation-key:
                    type: string
                    example: 'Operation key not yet provided.'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putOperationServerOperationKey
      summary: 'Changes key for connecting'
      tags:
        - OperationServer
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-server-interface-1-0:operation-key
              properties:
                operation-server-interface-1-0:operation-key:
                  type: string
                  minLength: 5
                  example: 'Operation key not yet provided.'
      responses:
        '204':
          description: 'Operation key changed'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerApplicationName
      summary: 'Returns application name'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Application name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:application-name
                properties:
                  http-server-interface-1-0:application-name:
                    type: string
                    example: 'ApplicationName'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerReleaseNumber
      summary: 'Returns release number'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Release number provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:release-number
                properties:
                  http-server-interface-1-0:release-number:
                    type: string
                    example: '1.0.0'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerApplicationPurpose
      summary: 'Returns application purpose'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Application purpose provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:application-purpose
                properties:
                  http-server-interface-1-0:application-purpose:
                    type: string
                    example: 'Brief description of the purpose of the application.'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerDataUpdatePeriode
      summary: 'Returns update period'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Update period provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:data-update-period
                properties:
                  http-server-interface-1-0:data-update-period:
                    type: string
                    enum:
                      - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_REAL_TIME'
                      - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_1H_PERIOD'
                      - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_24H_PERIOD'
                      - 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_MANUAL'
                    example: 'http-server-interface-1-0:DATA_UPDATE_PERIOD_TYPE_REAL_TIME'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerOwnerName
      summary: 'Returns owner name'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Owner name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:owner-name
                properties:
                  http-server-interface-1-0:owner-name:
                    type: string
                    example: 'Thorsten Heinze'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerOwnerEmailAddress
      summary: 'Returns owner email address'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Email address of owner provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:owner-email-address
                properties:
                  http-server-interface-1-0:owner-email-address:
                    type: string
                    example: 'Thorsten.Heinze@telefonica.com'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-s-bm-000'
          example: 'ro-2-0-0-http-s-bm-000'
    get:
      operationId: getHttpServerReleaseList
      summary: 'Returns list of releases'
      tags:
        - HttpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'List of releases provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-server-interface-1-0:release-list
                properties:
                  http-server-interface-1-0:release-list:
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      required:
                      - release-number
                      - release-date
                      - changes
                      properties:
                        release-number:
                          type: string
                        release-date:
                          type: string
                        changes:
                          type: string
                    example:
                      - release-number: '1.0.0'
                        release-date: '20.11.2010'
                        changes: 'Initial version.'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address: 
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-tcp-s-bm-000'
          example: 'ro-2-0-0-tcp-s-bm-000'
    get:
      operationId: getTcpServerLocalAddress
      summary: 'Returns address of the server'
      tags:
        - TcpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Local address provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - tcp-server-interface-1-0:local-address
                properties:
                  tcp-server-interface-1-0:local-address:
                    type: object
                    minProperties: 1
                    additionalProperties: false
                    properties:
                      ipv-4-address:
                        type: string
                        example: '1.1.4.1'
                      domain-name:
                        type: string
                        example: 'application-pattern.mw-domain.transport.ger.telefonica.com'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putTcpServerLocalAddress
      summary: 'Documents address of the server'
      tags:
        - TcpServer
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tcp-server-interface-1-0:local-address
              properties:
                tcp-server-interface-1-0:local-address:
                  type: object
                  minProperties: 1
                  additionalProperties: false
                  properties:
                    ipv-4-address:
                      type: string
                      pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                      example: '1.1.4.1'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      example: 'application-pattern.mw-domain.transport.ger.telefonica.com'
      responses:
        '204':
          description: 'Local IPv4 address documented'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-tcp-s-bm-000'
          example: 'ro-2-0-0-tcp-s-bm-000'
    get:
      operationId: getTcpServerLocalPort
      summary: 'Returns TCP port of the server'
      tags:
        - TcpServer
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Local port provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - tcp-server-interface-1-0:local-port
                properties:
                  tcp-server-interface-1-0:local-port:
                    type: integer
                    example: 1000
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putTcpServerLocalPort
      summary: 'Documents TCP port of the server'
      tags:
        - TcpServer
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tcp-server-interface-1-0:local-port
              properties:
                tcp-server-interface-1-0:local-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  example: 1000
      responses:
        '204':
          description: 'Local port documented'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'  

  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$'
          example: 'ro-2-0-0-op-c-bm-or-1-0-0-000'
    get:
      operationId: getOperationClientOperationName
      summary: 'Returns operation name'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation name provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-client-interface-1-0:operation-name
                properties:
                  operation-client-interface-1-0:operation-name:
                    type: string
                    example: '/v1/bequeath-your-data-and-die'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putOperationClientOperationName
      summary: 'Configures operation name'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-client-interface-1-0:operation-name
              properties:
                operation-client-interface-1-0:operation-name:
                  type: string
                  minLength: 6
                  example: '/v1/bequeath-your-data-and-die'
      responses:
        '204':
          description: 'Operation name configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-key:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$'
          example: 'ro-2-0-0-op-c-bm-or-1-0-0-000'
    get:
      operationId: getOperationClientOperationKey
      summary: 'Returns key used for connecting to server.'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operation key provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-client-interface-1-0:operation-key
                properties:
                  operation-client-interface-1-0:operation-key:
                    type: string
                    example: 'Operation key not yet provided.'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putOperationClientOperationKey
      summary: 'Configures key used for connecting to server.'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-client-interface-1-0:operation-key
              properties:
                operation-client-interface-1-0:operation-key:
                  type: string
                  minLength: 5
                  example: 'Operation key not yet provided.'
      responses:
        '204':
          description: 'Operation key configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-status/operational-state:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$'
          example: 'ro-2-0-0-op-c-bm-or-1-0-0-000'
    get:
      operationId: getOperationClientOperationalState
      summary: 'Returns operational state of the operation'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Operational state provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-client-interface-1-0:operational-state
                properties:
                  operation-client-interface-1-0:operational-state:
                    type: string
                    enum:
                      - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_AVAILABLE'
                      - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_UNAVAILABLE'
                      - 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
                    example: 'operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-status/life-cycle-state:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$'
          example: 'ro-2-0-0-op-c-bm-or-1-0-0-000'
    get:
      operationId: getOperationClientLifeCycleState
      summary: 'Returns life cycle state of the operation'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Life cycle state provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-client-interface-1-0:life-cycle-state
                properties:
                  operation-client-interface-1-0:life-cycle-state:
                    type: string
                    enum:
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL'
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL'
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED'
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_OBSOLETE'
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_UNKNOWN'
                      - 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
                    example: 'operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_NOT_YET_DEFINED'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/detailed-logging-is-on:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-op-c-bm-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$'
          example: 'ro-2-0-0-op-c-bs-eatl-2-0-0-000'
    get:
      operationId: getOperationClientDetailedLoggingIsOn
      summary: 'Returns detailed logging configuration.'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Detailed logging configuration provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - operation-client-interface-1-0:detailed-logging-is-on
                properties:
                  operation-client-interface-1-0:detailed-logging-is-on:
                    type: boolean
                    example: false
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putOperationClientDetailedLoggingIsOn
      summary: 'Configures detailed logging on/off.'
      tags:
        - OperationClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - operation-client-interface-1-0:detailed-logging-is-on
              properties:
                operation-client-interface-1-0:detailed-logging-is-on:
                  type: boolean
                  example: false
      responses:
        '204':
          description: 'Operation key configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$'
          example: 'ro-2-0-0-http-c-bm-or-1-0-0-000'
    get:
      operationId: getHttpClientApplicationName
      summary: 'Returns name of application to be addressed'
      tags:
        - HttpClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Addressed application provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-client-interface-1-0:application-name
                properties:
                  http-client-interface-1-0:application-name:
                    type: string
                    example: 'OldRelease'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putHttpClientApplicationName
      summary: 'Configures name of application to be addressed'
      tags:
        - HttpClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - http-client-interface-1-0:application-name
              properties:
                http-client-interface-1-0:application-name:
                  type: string
                  minLength: 3
                  example: 'NewApplication'
      responses:
        '204':
          description: 'Name of addressed application configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-http-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$'
          example: 'ro-2-0-0-http-c-bm-or-1-0-0-000'
    get:
      operationId: getHttpClientReleaseNumber
      summary: 'Returns release number of application to be addressed'
      tags:
        - HttpClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Release number provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - http-client-interface-1-0:release-number
                properties:
                  http-client-interface-1-0:release-number:
                    type: string
                    example: '1.0.0'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putHttpClientReleaseNumber
      summary: 'Configures release number of application to be addressed'
      tags:
        - HttpClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
            application/json:
              schema:
                type: object
                required:
                  - http-client-interface-1-0:release-number
                properties:
                  http-client-interface-1-0:release-number:
                    type: string
                    pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$'
                    example: '1.0.0'
      responses:
        '204':
          description: 'Release number configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'  

  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-tcp-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$'
          example: 'ro-2-0-0-tcp-c-bm-or-1-0-0-000'
    get:
      operationId: getTcpClientRemoteAddress
      summary: 'Returns remote address'
      tags:
        - TcpClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Remote address provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - tcp-client-interface-1-0:remote-address
                properties:
                  tcp-client-interface-1-0:remote-address:
                    type: object
                    minProperties: 1
                    maxProperties: 1
                    additionalProperties: false
                    properties:
                      ip-address:
                        type: object
                        minProperties: 1
                        additionalProperties: false
                        properties:
                          ipv-4-address:
                            type: string
                            example: '1.1.4.1'
                      domain-name:
                        type: string
                        example: 'application-pattern.mw-domain.transport.ger.telefonica.com'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putTcpClientRemoteAddress
      summary: 'Configures remote address'
      tags:
        - TcpClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tcp-client-interface-1-0:remote-address
              properties:
                tcp-client-interface-1-0:remote-address:
                  type: object
                  minProperties: 1
                  maxProperties: 1
                  additionalProperties: false
                  properties:
                    ip-address:
                      type: object
                      minProperties: 1
                      additionalProperties: false
                      properties:
                        ipv-4-address:
                          type: string
                          pattern: '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'
                          example: '1.1.4.1'
                    domain-name:
                      type: string
                      pattern: '^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$'
                      example: 'application-pattern.mw-domain.transport.ger.telefonica.com'
      responses:
        '204':
          description: 'Remote IPv4 address configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'  
  /core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port:
    parameters:
      - in: path
        name: uuid
        required: true
        schema:
          type: string
          pattern: '^([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-tcp-c-([bi][ms])-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$'
          example: 'ro-2-0-0-tcp-c-bm-or-1-0-0-000'
    get:
      operationId: getTcpClientRemotePort
      summary: 'Returns target TCP port at server'
      tags:
        - TcpClient
      security:
        - basicAuth: []
      responses:
        '200':
          description: 'Remote port provided'
          content:
            application/json:
              schema:
                type: object
                required:
                  - tcp-client-interface-1-0:remote-port
                properties:
                  tcp-client-interface-1-0:remote-port:
                    type: integer
                    example: 1000
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'
    put:
      operationId: putTcpClientRemotePort
      summary: 'Configures target TCP port at server'
      tags:
        - TcpClient
      security:
        - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - tcp-client-interface-1-0:remote-port
              properties:
                tcp-client-interface-1-0:remote-port:
                  type: integer
                  minimum: 0
                  maximum: 65535
                  example: 1000
      responses:
        '204':
          description: 'Remote port configured'
        '400':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '401':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '403':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '404':
          $ref: '#/components/responses/responseForErroredOamRequests'
        '500':
          $ref: '#/components/responses/responseForErroredOamRequests'
        default:
          $ref: '#/components/responses/responseForErroredOamRequests'

########################################################################################################################
#   Common Components
########################################################################################################################
components:
  parameters:
    user:
      name: user
      in: header
      required: true
      schema: 
        type: string
        example: 'User Name'
      description: 'User identifier from the system starting the service call'
    originator:
      name: originator
      in: header
      required: true
      schema: 
        type: string
        minLength: 3
        example: 'Resolver'
      description: >
        'Identification for the system consuming the API, as defined in
         [/core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]'
    x-correlator:
      name: x-correlator
      in: header
      required: true
      schema: 
        type: string
        pattern: '^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$'
        description: 'Empty string accepted from external applications.'
        example: '550e8400-e29b-11d4-a716-446655440000'
      description: 'UUID for the service execution flow that allows to correlate requests and responses'
    trace-indicator:
      name: trace-indicator
      in: header
      required: true
      schema: 
        type: string
        pattern: '^([0-9]+)(\.([0-9]+))*$'
        description: 'Empty string accepted from external applications.'
        example: '1.3.1'
      description: 'Sequence of request numbers along the flow'
    customer-journey:
      name: customer-journey
      in: header
      required: true
      schema: 
        type: string
        example: 'Unknown value'
      description: 'Holds information supporting customer’s journey to which the execution applies'
  responses:
    responseForErroredServiceRequests:
      description: 'Response in case of errored service requests'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorDescription'
      headers:
        x-correlator:
          schema: 
            type: string
            pattern: '^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$'
            example: '550e8400-e29b-11d4-a716-446655440000'
          description: 'UUID for the service execution flow that allows to correlate requests and responses. Its value must be identical at the response compared with its corresponding request'
        exec-time:
          schema:
            type: integer
            example: 1100
          description: 'Value written by the service provider, reporting the total elapsed time for the execution, including all the additional processing needed to retrieve the data from the backend service. Expressed in milliseconds'
        backend-time:
          schema:
            type: integer
            example: 850
          description: 'Value written by the service provider, reporting the elapsed time for data retrieval from the backend (service invocation, database access…). Expressed in milliseconds'
    responseForErroredOamRequests:
      description: 'Response in case of errored OaM requests'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorDescription'
  schemas:
    errorDescription:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: operation-key
    basicAuth:
      type: http
      scheme: basic