From 2d939b536ebd9d2f643f96ffa5793268144ffa20 Mon Sep 17 00:00:00 2001 From: Thorsten Heinze <46722892+openBackhaul@users.noreply.github.com> Date: Fri, 9 Dec 2022 18:36:14 +0100 Subject: [PATCH 01/12] Update CODEOWNERS --- .github/CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 42b20eb..f2e9a07 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1,3 @@ @openBackhaul +/server/ @PrathibaJee +/docs/ @openBackhaul @PrathibaJee @IswaryaaS From 77fbf1f87350a47a58440728767be918e4942bbf Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Sun, 11 Dec 2022 11:44:22 +0100 Subject: [PATCH 02/12] Support pagination Add pagination at /v1/list-records Add pagination at /v1/list-records-of-flow Add pagination at /v1/list-records-of-unsuccessful Remove uniqueItems to allow indication of duplicates Update release numbers to 2.0.0 in ServiceList --- ExecutionAndTraceLog+services.yaml | 8 ++--- ExecutionAndTraceLog.yaml | 53 ++++++++++++++++++++++++++++-- 2 files changed, 54 insertions(+), 7 deletions(-) diff --git a/ExecutionAndTraceLog+services.yaml b/ExecutionAndTraceLog+services.yaml index 7560b9a..96b2624 100644 --- a/ExecutionAndTraceLog+services.yaml +++ b/ExecutionAndTraceLog+services.yaml @@ -59,7 +59,7 @@ servers: uuid: eatl-2-0-0-op-s-is-007 http-server: own-application-name: ExecutionAndTraceLog - own-release-number: 1.0.0 + own-release-number: 2.0.0 uuid: eatl-2-0-0-http-s-bm-000 tpc-server: - description: Without TLS layer @@ -110,7 +110,7 @@ clients: - http-client: application-name: NewRelease - release-number: 1.0.0 + release-number: 2.0.0 uuid: eatl-2-0-0-http-c-im-nr-2-0-0-000 tcp-client: remote-protocol: http @@ -129,7 +129,7 @@ clients: - http-client: application-name: RegistryOffice - release-number: 1.0.0 + release-number: 2.0.0 uuid: eatl-2-0-0-http-c-bm-ro-2-0-0-000 tcp-client: remote-protocol: http @@ -181,7 +181,7 @@ clients: - http-client: application-name: ExecutionAndTraceLog - release-number: 1.0.0 + release-number: 2.0.0 uuid: eatl-2-0-0-http-c-im-eatl-2-0-0-000 tcp-client: remote-protocol: http diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 6bce196..66dfb5a 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -1312,6 +1312,25 @@ paths: - IndividualServices security: - apiKeyAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - latest-record + - number-of-records + properties: + latest-record: + type: integer + description: 'Youngest record to be returned.' + number-of-records: + type: integer + description: 'Maximum number of records to be returned.' + example: + latest-record: 0 + number-of-records: 1000 responses: '200': description: 'List of recorded service requests provided' @@ -1319,7 +1338,6 @@ paths: application/json: schema: type: array - uniqueItems: true items: $ref: '#/components/schemas/serviceRequestRecord' description: 'from elasticsearch' @@ -1408,9 +1426,21 @@ paths: type: object required: - x-correlator + - latest-match + - number-of-records properties: x-correlator: type: string + latest-match: + type: integer + description: 'Youngest record, which is matching the filter criteria, to be returned.' + number-of-records: + type: integer + description: 'Maximum number of records to be returned.' + example: + x-correlator: '550e8400-e29b-11d4-a716-446655440000' + latest-match: 0 + number-of-records: 100 responses: '200': description: 'List of service request records of the same flow provided' @@ -1418,7 +1448,6 @@ paths: application/json: schema: type: array - uniqueItems: true items: $ref: '#/components/schemas/serviceRequestRecord' description: > @@ -1500,6 +1529,25 @@ paths: - IndividualServices security: - apiKeyAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - latest-unsuccessful + - number-of-records + properties: + latest-unsuccessful: + type: integer + description: 'Youngest record, which had an http response code higher than 204, to be returned.' + number-of-records: + type: integer + description: 'Maximum number of records to be returned.' + example: + latest-unsuccessful: 0 + number-of-records: 100 responses: '200': description: 'List of unsuccessful service requests provided' @@ -1507,7 +1555,6 @@ paths: application/json: schema: type: array - uniqueItems: true items: $ref: '#/components/schemas/serviceRequestRecord' description: > From de44637bc74c684a21b3b3bd09f5c9af09a3713d Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Mon, 12 Dec 2022 12:38:04 +0100 Subject: [PATCH 03/12] Correct several small issues Correct uuid of ElasticsearchClient Change HttpClient::ApplicationName to config Correct detailed-logging-is-on value to Boolean --- ExecutionAndTraceLog+config.json | 56 ++++++++++-------------------- ExecutionAndTraceLog+services.yaml | 6 ++-- 2 files changed, 21 insertions(+), 41 deletions(-) diff --git a/ExecutionAndTraceLog+config.json b/ExecutionAndTraceLog+config.json index 68861f2..4c28ede 100644 --- a/ExecutionAndTraceLog+config.json +++ b/ExecutionAndTraceLog+config.json @@ -938,12 +938,12 @@ ] }, { - "uuid": "eatl-2-0-0-es-c-is-es-1-0-0-000", + "uuid": "eatl-2-0-0-es-c-es-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-is-es-1-0-0-000" + "eatl-2-0-0-http-c-es-1-0-0-000" ], "layer-protocol": [ { @@ -965,13 +965,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-is-es-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-es-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-es-c-is-es-1-0-0-000" + "eatl-2-0-0-es-c-es-1-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-is-es-1-0-0-000" + "eatl-2-0-0-tcp-c-es-1-0-0-000" ], "layer-protocol": [ { @@ -987,10 +987,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-is-es-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-es-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-is-es-1-0-0-000" + "eatl-2-0-0-http-c-es-1-0-0-000" ], "server-ltp": [ ], @@ -1051,10 +1051,8 @@ "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-capability": { - "application-name": "OldRelease" - }, "http-client-interface-configuration": { + "application-name": "OldRelease", "release-number": "1.0.0" } } @@ -1126,10 +1124,8 @@ "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-capability": { - "application-name": "NewRelease" - }, "http-client-interface-configuration": { + "application-name": "NewRelease", "release-number": "2.0.0" } } @@ -1383,10 +1379,8 @@ "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-capability": { - "application-name": "RegistryOffice" - }, "http-client-interface-configuration": { + "application-name": "RegistryOffice", "release-number": "2.0.0" } } @@ -1458,10 +1452,8 @@ "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-capability": { - "application-name": "TypeApprovalRegister" - }, "http-client-interface-configuration": { + "application-name": "TypeApprovalRegister", "release-number": "1.0.0" } } @@ -1535,7 +1527,7 @@ "operation-client-interface-configuration": { "operation-name": "/v1/record-service-request", "operation-key": "Operation key not yet provided.", - "detailed-logging-is-on": "false" + "detailed-logging-is-on": false }, "operation-client-interface-status": { "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_NOT_YET_DEFINED", @@ -1560,10 +1552,8 @@ "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-capability": { - "application-name": "ExecutionAndTraceLog" - }, "http-client-interface-configuration": { + "application-name": "ExecutionAndTraceLog", "release-number": "2.0.0" } } @@ -1661,10 +1651,8 @@ "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-capability": { - "application-name": "OamLog" - }, "http-client-interface-configuration": { + "application-name": "OamLog", "release-number": "1.0.0" } } @@ -1762,10 +1750,8 @@ "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-capability": { - "application-name": "AdministratorAdministration" - }, "http-client-interface-configuration": { + "application-name": "AdministratorAdministration", "release-number": "1.0.0" } } @@ -1993,10 +1979,8 @@ "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-capability": { - "application-name": "ApplicationLayerTopology" - }, "http-client-interface-configuration": { + "application-name": "ApplicationLayerTopology", "release-number": "1.0.0" } } @@ -2068,10 +2052,8 @@ "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-capability": { - "application-name": "OperationKeyManagement" - }, "http-client-interface-configuration": { + "application-name": "OperationKeyManagement", "release-number": "1.0.0" } } @@ -2143,10 +2125,8 @@ "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-capability": { - "application-name": "CurrentController" - }, "http-client-interface-configuration": { + "application-name": "CurrentController", "release-number": "0.0.6" } } diff --git a/ExecutionAndTraceLog+services.yaml b/ExecutionAndTraceLog+services.yaml index 7560b9a..fc8ce3b 100644 --- a/ExecutionAndTraceLog+services.yaml +++ b/ExecutionAndTraceLog+services.yaml @@ -79,14 +79,14 @@ clients: - http-client: application-name: ElasticSearch release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-is-es-1-0-0-000 + uuid: eatl-2-0-0-http-c-es-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.15 tcp-port: 3015 - uuid: eatl-2-0-0-tcp-c-is-es-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-es-1-0-0-000 elasticsearch-client: - uuid: eatl-2-0-0-es-c-is-es-1-0-0-000 + uuid: eatl-2-0-0-es-c-es-1-0-0-000 index-alias: eatl-2-0-0 - http-client: From 700b897015f6bbd607c360499d6221781bec48b1 Mon Sep 17 00:00:00 2001 From: kmohr-soprasteria Date: Tue, 13 Dec 2022 10:01:41 +0100 Subject: [PATCH 04/12] Remove ApiSegment from UUIDs of HttpClients/Servers and TcpClients/Servers Fixes #119 --- ExecutionAndTraceLog+config.json | 212 ++++++++++----------- ExecutionAndTraceLog+profileInstances.yaml | 22 +-- ExecutionAndTraceLog+services.yaml | 46 ++--- ExecutionAndTraceLog.yaml | 84 ++++---- 4 files changed, 182 insertions(+), 182 deletions(-) diff --git a/ExecutionAndTraceLog+config.json b/ExecutionAndTraceLog+config.json index 4c28ede..e668dd5 100644 --- a/ExecutionAndTraceLog+config.json +++ b/ExecutionAndTraceLog+config.json @@ -73,7 +73,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name" } } } @@ -92,7 +92,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name" } } } @@ -111,7 +111,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number" } } } @@ -130,7 +130,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose" } } } @@ -149,7 +149,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-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" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period" } } } @@ -168,7 +168,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name" } } } @@ -187,7 +187,7 @@ }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-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" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address" } } } @@ -199,14 +199,14 @@ "response-profile-capability": { "operation-name": "/v1/inform-about-release-history-in-generic-representation", "field-name": { - "field-name-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number" + "field-name-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number" }, "description": "Represents the first entry in the list of releases", "datatype": "string" }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes" } } } @@ -218,14 +218,14 @@ "response-profile-capability": { "operation-name": "/v1/inform-about-release-history-in-generic-representation", "field-name": { - "field-name-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/release-number" + "field-name-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/release-number" }, "description": "List of release numbers and changes", "datatype": "string" }, "response-profile-configuration": { "value": { - "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/changes" + "value-reference": "/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/changes" } } } @@ -254,7 +254,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -278,7 +278,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -302,7 +302,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -326,7 +326,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -350,7 +350,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -374,7 +374,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -398,7 +398,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -422,7 +422,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -446,7 +446,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -470,7 +470,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -494,7 +494,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -518,7 +518,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -542,7 +542,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -566,7 +566,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -590,7 +590,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -614,7 +614,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -638,7 +638,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -662,7 +662,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -686,7 +686,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -710,7 +710,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -734,7 +734,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -758,7 +758,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -782,7 +782,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -806,7 +806,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -830,7 +830,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "layer-protocol": [ { @@ -849,7 +849,7 @@ ] }, { - "uuid": "eatl-2-0-0-http-s-bm-000", + "uuid": "eatl-2-0-0-http-s-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SOURCE", "client-ltp": [ "eatl-2-0-0-op-s-bm-000", @@ -879,7 +879,7 @@ "eatl-2-0-0-op-s-is-007" ], "server-ltp": [ - "eatl-2-0-0-tcp-s-bm-000" + "eatl-2-0-0-tcp-s-000" ], "layer-protocol": [ { @@ -913,10 +913,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-s-bm-000", + "uuid": "eatl-2-0-0-tcp-s-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SOURCE", "client-ltp": [ - "eatl-2-0-0-http-s-bm-000" + "eatl-2-0-0-http-s-000" ], "server-ltp": [ ], @@ -1018,7 +1018,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-or-1-0-0-000" + "eatl-2-0-0-http-c-or-1-0-0-000" ], "layer-protocol": [ { @@ -1038,13 +1038,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-bm-or-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-or-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-bm-or-1-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-bm-or-1-0-0-000" + "eatl-2-0-0-tcp-c-or-1-0-0-000" ], "layer-protocol": [ { @@ -1060,10 +1060,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-bm-or-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-or-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-bm-or-1-0-0-000" + "eatl-2-0-0-http-c-or-1-0-0-000" ], "server-ltp": [ ], @@ -1091,7 +1091,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-nr-2-0-0-000" + "eatl-2-0-0-http-c-nr-2-0-0-000" ], "layer-protocol": [ { @@ -1111,13 +1111,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-nr-2-0-0-000", + "uuid": "eatl-2-0-0-http-c-nr-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-nr-2-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-nr-2-0-0-000" + "eatl-2-0-0-tcp-c-nr-2-0-0-000" ], "layer-protocol": [ { @@ -1133,10 +1133,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-nr-2-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-nr-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-nr-2-0-0-000" + "eatl-2-0-0-http-c-nr-2-0-0-000" ], "server-ltp": [ ], @@ -1164,7 +1164,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1189,7 +1189,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1214,7 +1214,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1239,7 +1239,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1264,7 +1264,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1289,7 +1289,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1314,7 +1314,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1339,7 +1339,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1359,7 +1359,7 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-bm-ro-2-0-0-000", + "uuid": "eatl-2-0-0-http-c-ro-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-bm-ro-2-0-0-000", @@ -1372,7 +1372,7 @@ "eatl-2-0-0-op-c-im-ro-2-0-0-004" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-bm-ro-2-0-0-000" + "eatl-2-0-0-tcp-c-ro-2-0-0-000" ], "layer-protocol": [ { @@ -1388,10 +1388,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-bm-ro-2-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-ro-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-bm-ro-2-0-0-000" + "eatl-2-0-0-http-c-ro-2-0-0-000" ], "server-ltp": [ ], @@ -1419,7 +1419,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-tar-1-0-0-000" + "eatl-2-0-0-http-c-tar-1-0-0-000" ], "layer-protocol": [ { @@ -1439,13 +1439,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-tar-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-tar-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-tar-1-0-0-004" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-tar-1-0-0-000" + "eatl-2-0-0-tcp-c-tar-1-0-0-000" ], "layer-protocol": [ { @@ -1461,10 +1461,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-tar-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-tar-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-tar-1-0-0-000" + "eatl-2-0-0-http-c-tar-1-0-0-000" ], "server-ltp": [ ], @@ -1492,7 +1492,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-eatl-2-0-0-000" + "eatl-2-0-0-http-c-eatl-2-0-0-000" ], "layer-protocol": [ { @@ -1517,7 +1517,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-eatl-2-0-0-000" + "eatl-2-0-0-http-c-eatl-2-0-0-000" ], "layer-protocol": [ { @@ -1538,14 +1538,14 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-eatl-2-0-0-000", + "uuid": "eatl-2-0-0-http-c-eatl-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-eatl-2-0-0-004", "eatl-2-0-0-op-c-bs-eatl-2-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-eatl-2-0-0-000" + "eatl-2-0-0-tcp-c-eatl-2-0-0-000" ], "layer-protocol": [ { @@ -1561,10 +1561,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-eatl-2-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-eatl-2-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-eatl-2-0-0-000" + "eatl-2-0-0-http-c-eatl-2-0-0-000" ], "server-ltp": [ ], @@ -1592,7 +1592,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-ol-1-0-0-000" + "eatl-2-0-0-http-c-ol-1-0-0-000" ], "layer-protocol": [ { @@ -1617,7 +1617,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-ol-1-0-0-000" + "eatl-2-0-0-http-c-ol-1-0-0-000" ], "layer-protocol": [ { @@ -1637,14 +1637,14 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-ol-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-ol-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-ol-1-0-0-004", "eatl-2-0-0-op-c-bs-ol-1-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-ol-1-0-0-000" + "eatl-2-0-0-tcp-c-ol-1-0-0-000" ], "layer-protocol": [ { @@ -1660,10 +1660,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-ol-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-ol-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-ol-1-0-0-000" + "eatl-2-0-0-http-c-ol-1-0-0-000" ], "server-ltp": [ ], @@ -1691,7 +1691,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-aa-1-0-0-000" + "eatl-2-0-0-http-c-aa-1-0-0-000" ], "layer-protocol": [ { @@ -1716,7 +1716,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-aa-1-0-0-000" + "eatl-2-0-0-http-c-aa-1-0-0-000" ], "layer-protocol": [ { @@ -1736,14 +1736,14 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-aa-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-aa-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-aa-1-0-0-004", "eatl-2-0-0-op-c-bs-aa-1-0-0-000" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-aa-1-0-0-000" + "eatl-2-0-0-tcp-c-aa-1-0-0-000" ], "layer-protocol": [ { @@ -1759,10 +1759,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-aa-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-aa-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-aa-1-0-0-000" + "eatl-2-0-0-http-c-aa-1-0-0-000" ], "server-ltp": [ ], @@ -1790,7 +1790,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1815,7 +1815,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1840,7 +1840,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1865,7 +1865,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1890,7 +1890,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1915,7 +1915,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1940,7 +1940,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1960,7 +1960,7 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-bm-alt-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-alt-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-bm-alt-1-0-0-000", @@ -1972,7 +1972,7 @@ "eatl-2-0-0-op-c-im-alt-1-0-0-004" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-bm-alt-1-0-0-000" + "eatl-2-0-0-tcp-c-alt-1-0-0-000" ], "layer-protocol": [ { @@ -1988,10 +1988,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-bm-alt-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-alt-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-bm-alt-1-0-0-000" + "eatl-2-0-0-http-c-alt-1-0-0-000" ], "server-ltp": [ ], @@ -2019,7 +2019,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-okm-1-0-0-000" + "eatl-2-0-0-http-c-okm-1-0-0-000" ], "layer-protocol": [ { @@ -2039,13 +2039,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-okm-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-okm-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-okm-1-0-0-004" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-okm-1-0-0-000" + "eatl-2-0-0-tcp-c-okm-1-0-0-000" ], "layer-protocol": [ { @@ -2061,10 +2061,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-okm-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-okm-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-okm-1-0-0-000" + "eatl-2-0-0-http-c-okm-1-0-0-000" ], "server-ltp": [ ], @@ -2092,7 +2092,7 @@ "client-ltp": [ ], "server-ltp": [ - "eatl-2-0-0-http-c-im-cc-1-0-0-000" + "eatl-2-0-0-http-c-cc-1-0-0-000" ], "layer-protocol": [ { @@ -2112,13 +2112,13 @@ ] }, { - "uuid": "eatl-2-0-0-http-c-im-cc-1-0-0-000", + "uuid": "eatl-2-0-0-http-c-cc-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ "eatl-2-0-0-op-c-im-cc-1-0-0-004" ], "server-ltp": [ - "eatl-2-0-0-tcp-c-im-cc-1-0-0-000" + "eatl-2-0-0-tcp-c-cc-1-0-0-000" ], "layer-protocol": [ { @@ -2134,10 +2134,10 @@ ] }, { - "uuid": "eatl-2-0-0-tcp-c-im-cc-1-0-0-000", + "uuid": "eatl-2-0-0-tcp-c-cc-1-0-0-000", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", "client-ltp": [ - "eatl-2-0-0-http-c-im-cc-1-0-0-000" + "eatl-2-0-0-http-c-cc-1-0-0-000" ], "server-ltp": [ ], diff --git a/ExecutionAndTraceLog+profileInstances.yaml b/ExecutionAndTraceLog+profileInstances.yaml index 5a45ad4..1800a01 100644 --- a/ExecutionAndTraceLog+profileInstances.yaml +++ b/ExecutionAndTraceLog+profileInstances.yaml @@ -36,7 +36,7 @@ profile-instances: description: 'Own application name' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-001' @@ -46,7 +46,7 @@ profile-instances: description: 'Name of this application' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-002' @@ -56,7 +56,7 @@ profile-instances: description: 'Number of this release' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-003' @@ -66,7 +66,7 @@ profile-instances: description: 'Purpose of this application' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-004' @@ -76,7 +76,7 @@ profile-instances: description: 'Period of updating the data inside this application' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-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' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-005' @@ -86,7 +86,7 @@ profile-instances: description: 'Name of the ApplicationOwner' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-006' @@ -96,27 +96,27 @@ profile-instances: description: 'Email address of the ApplicationOwner' datatype: 'string' configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-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' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-007' capability: operation-name: '/v1/inform-about-release-history-in-generic-representation' - field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number' + field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number' description: 'Represents the first entry in the list of releases' datatype: string configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes' - profile-name: 'GenericResponseProfile' uuid: 'eatl-2-0-0-response-p-008' capability: operation-name: '/v1/inform-about-release-history-in-generic-representation' - field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/release-number' + field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/release-number' description: 'List of release numbers and changes' datatype: string configuration: - value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/changes' + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=1/changes' - profile-name: 'IntegerProfile' diff --git a/ExecutionAndTraceLog+services.yaml b/ExecutionAndTraceLog+services.yaml index fc8ce3b..31cb97b 100644 --- a/ExecutionAndTraceLog+services.yaml +++ b/ExecutionAndTraceLog+services.yaml @@ -60,18 +60,18 @@ servers: http-server: own-application-name: ExecutionAndTraceLog own-release-number: 1.0.0 - uuid: eatl-2-0-0-http-s-bm-000 + uuid: eatl-2-0-0-http-s-000 tpc-server: - description: Without TLS layer local-protocol: http own-ip-address: 1.1.3.10 own-tcp-port: 3010 - uuid: eatl-2-0-0-tcp-s-bm-000 + uuid: eatl-2-0-0-tcp-s-000 - description: With TLS layer local-protocol: https own-ip-address: 1.2.3.10 own-tcp-port: 3210 - uuid: eatl-2-0-0-tcp-s-bm-001 + uuid: eatl-2-0-0-tcp-s-001 clients: @@ -92,12 +92,12 @@ clients: - http-client: application-name: OldRelease release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-bm-or-1-0-0-000 + uuid: eatl-2-0-0-http-c-or-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.3 tcp-port: 3003 - uuid: eatl-2-0-0-tcp-c-bm-or-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-or-1-0-0-000 operation-clients: own-oam: basic: @@ -111,12 +111,12 @@ clients: - http-client: application-name: NewRelease release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-nr-2-0-0-000 + uuid: eatl-2-0-0-http-c-nr-2-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.10 tcp-port: 3010 - uuid: eatl-2-0-0-tcp-c-im-nr-2-0-0-000 + uuid: eatl-2-0-0-tcp-c-nr-2-0-0-000 operation-clients: own-oam: basic: @@ -130,12 +130,12 @@ clients: - http-client: application-name: RegistryOffice release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-bm-ro-2-0-0-000 + uuid: eatl-2-0-0-http-c-ro-2-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.8 tcp-port: 3008 - uuid: eatl-2-0-0-tcp-c-bm-ro-2-0-0-000 + uuid: eatl-2-0-0-tcp-c-ro-2-0-0-000 operation-clients: own-oam: basic: @@ -163,12 +163,12 @@ clients: - http-client: application-name: TypeApprovalRegister release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-tar-1-0-0-000 + uuid: eatl-2-0-0-http-c-tar-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.2 tcp-port: 3002 - uuid: eatl-2-0-0-tcp-c-im-tar-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-tar-1-0-0-000 operation-clients: own-oam: basic: @@ -182,12 +182,12 @@ clients: - http-client: application-name: ExecutionAndTraceLog release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-eatl-2-0-0-000 + uuid: eatl-2-0-0-http-c-eatl-2-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.10 tcp-port: 3010 - uuid: eatl-2-0-0-tcp-c-im-eatl-2-0-0-000 + uuid: eatl-2-0-0-tcp-c-eatl-2-0-0-000 operation-clients: own-oam: basic: @@ -203,12 +203,12 @@ clients: - http-client: application-name: OamLog release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-ol-1-0-0-000 + uuid: eatl-2-0-0-http-c-ol-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.4 tcp-port: 3004 - uuid: eatl-2-0-0-tcp-c-im-ol-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-ol-1-0-0-000 operation-clients: own-oam: basic: @@ -224,12 +224,12 @@ clients: - http-client: application-name: AdministratorAdministration release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-aa-1-0-0-000 + uuid: eatl-2-0-0-http-c-aa-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.5 tcp-port: 3005 - uuid: eatl-2-0-0-tcp-c-im-aa-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-aa-1-0-0-000 operation-clients: own-oam: basic: @@ -245,12 +245,12 @@ clients: - http-client: application-name: ApplicationLayerTopology release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-bm-alt-1-0-0-000 + uuid: eatl-2-0-0-http-c-alt-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.6 tcp-port: 3006 - uuid: eatl-2-0-0-tcp-c-bm-alt-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-alt-1-0-0-000 operation-clients: own-oam: basic: @@ -276,12 +276,12 @@ clients: - http-client: application-name: OperationKeyManagement release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-okm-1-0-0-000 + uuid: eatl-2-0-0-http-c-okm-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.3.7 tcp-port: 3007 - uuid: eatl-2-0-0-tcp-c-im-okm-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-okm-1-0-0-000 operation-clients: own-oam: basic: @@ -295,12 +295,12 @@ clients: - http-client: application-name: CurrentController release-number: 1.0.0 - uuid: eatl-2-0-0-http-c-im-cc-1-0-0-000 + uuid: eatl-2-0-0-http-c-cc-1-0-0-000 tcp-client: remote-protocol: http ip-address: 1.1.4.1 tcp-port: 4001 - uuid: eatl-2-0-0-tcp-c-im-cc-1-0-0-000 + uuid: eatl-2-0-0-tcp-c-cc-1-0-0-000 operation-clients: own-oam: basic: diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 6bce196..f6eb164 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -38,13 +38,13 @@ paths: 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=eatl-2-0-0-http-c-im-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + find or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-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=eatl-2-0-0-http-c-im-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + find or update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' new-application-protocol: type: string enum: @@ -52,7 +52,7 @@ paths: - 'HTTPS' description: > 'Protocol to be used for addressing the application that shall be target of the handover process - update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' new-application-address: type: object minProperties: 1 @@ -69,20 +69,20 @@ paths: 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=eatl-2-0-0-tcp-c-im-nr-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]' + update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 be target of the handover process - update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' + update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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' @@ -138,7 +138,7 @@ paths: $ref: '#/components/responses/responseForErroredServiceRequests' callbacks: PromptForBequeathingDataCausesTransferOfListOfApplications: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-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=eatl-2-0-0-tcp-c-im-nr-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=eatl-2-0-0-tcp-c-im-nr-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=eatl-2-0-0-op-c-im-nr-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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=eatl-2-0-0-tcp-c-nr-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=eatl-2-0-0-tcp-c-nr-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=eatl-2-0-0-op-c-im-nr-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] post: parameters: - $ref: '#/components/parameters/user' @@ -227,7 +227,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptForBequeathingDataCausesRObeingRequestedToNotifyApprovalsOfNewApplicationsToNewRelease: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-0-0-op-c-im-ro-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-op-c-im-ro-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] post: parameters: - $ref: '#/components/parameters/user' @@ -252,12 +252,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' subscriber-release-number: type: string description: > 'Future release number - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-im-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' subscriber-operation: type: string description: > @@ -267,12 +267,12 @@ paths: type: string description: > 'Future IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-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]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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]' subscriber-port: type: integer description: > 'Future port - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' example: subscriber-application: 'ExecutionAndTraceLog' subscriber-release-number: '2.0.0' @@ -323,7 +323,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptForBequeathingDataCausesRObeingRequestedToNotifyWithdrawnApprovalsToNewRelease: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-0-0-op-c-im-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-op-c-im-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] post: parameters: - $ref: '#/components/parameters/user' @@ -348,12 +348,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' subscriber-release-number: type: string description: > 'Future release number - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-im-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' subscriber-operation: type: string description: > @@ -363,12 +363,12 @@ paths: type: string description: > 'Future IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-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]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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]' subscriber-port: type: integer description: > 'Future port - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' example: subscriber-application: 'ExecutionAndTraceLog' subscriber-release-number: '2.0.0' @@ -419,7 +419,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptForBequeathingDataCausesRObeingRequestedToStopNotificationsToOldRelease: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-0-0-op-c-im-ro-2-0-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-op-c-im-ro-2-0-0-002/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] post: parameters: - $ref: '#/components/parameters/user' @@ -442,12 +442,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' subscriber-release-number: type: string description: > 'Old release number - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-bm-or-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-or-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' subscription: type: string description: > @@ -503,7 +503,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptForBequeathingDataCausesRequestForBroadcastingInfoAboutServerReplacement: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-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] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-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] post: parameters: - $ref: '#/components/parameters/user' @@ -529,22 +529,22 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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=eatl-2-0-0-http-c-im-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' new-application-protocol: type: string description: > 'Future protocol to be used - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' new-application-address: type: object minProperties: 1 @@ -560,17 +560,17 @@ paths: type: string description: > 'Future IPv4 address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-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]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 description: > 'Future domain name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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=eatl-2-0-0-tcp-c-im-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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' @@ -624,7 +624,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptForBequeathingDataCausesRequestForDeregisteringOfOldRelease: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-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] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-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] post: parameters: - $ref: '#/components/parameters/user' @@ -646,12 +646,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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' @@ -699,7 +699,7 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' PromptingNewReleaseForUpdatingServerCausesRequestForBroadcastingInfoAboutBackwardCompatibleUpdateOfOperation: - url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-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] + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-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] description: > 'This callback belongs to the sequence of actions that have to be done during the bequeath-your-data-and-die process, despite the forwarding gets neither managed nor directly initiated by the /v1/bequeath-your-data-and-die request. After consuming applications have been redirected to the new release, the new release is triggered (this callback) to request the RegistryOffice for broadcasting information about backward compatible replacements of services.' @@ -726,12 +726,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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: > @@ -948,12 +948,12 @@ paths: type: string description: > 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' service-log-application-release-number: type: string description: > 'Own release number - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-bm-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' service-log-operation: type: string description: > @@ -963,12 +963,12 @@ paths: type: string description: > 'Own IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]' service-log-port: type: integer description: > 'Own TCP port - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-bm-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/local-port]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/local-port]' example: service-log-application: 'ExecutionAndTraceLog' service-log-application-release-number: '2.0.0' @@ -1721,13 +1721,13 @@ components: description: > 'Request that shall be called, when button gets pressed from - [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-bm-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol}] + [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol}] :// - [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-bm-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address} + [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address} or - {/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-bm-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name}] + {/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name}] : - [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-bm-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port}] + [{/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port}] [{/core-model-1-4:control-construct/profile-collection/profile=eatl-2-0-0-action-p-*/action-profile-1-0:action-profile-pac/action-profile-configuration/consequent-operation-reference}]' input-value-list: type: array From 7f12c638f38d547a8e011fd9f4b961f93bfef777 Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Tue, 13 Dec 2022 16:59:08 +0100 Subject: [PATCH 05/12] Delete 2nd TcpServer --- ExecutionAndTraceLog+services.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/ExecutionAndTraceLog+services.yaml b/ExecutionAndTraceLog+services.yaml index 31cb97b..30ba269 100644 --- a/ExecutionAndTraceLog+services.yaml +++ b/ExecutionAndTraceLog+services.yaml @@ -67,11 +67,6 @@ servers: own-ip-address: 1.1.3.10 own-tcp-port: 3010 uuid: eatl-2-0-0-tcp-s-000 - - description: With TLS layer - local-protocol: https - own-ip-address: 1.2.3.10 - own-tcp-port: 3210 - uuid: eatl-2-0-0-tcp-s-001 clients: From d9ec2264f4124249dca5946cbfa37dc949da7c1a Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Tue, 13 Dec 2022 17:17:00 +0100 Subject: [PATCH 06/12] Correct FakeIP in /v1/list-applications example --- ExecutionAndTraceLog.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 365f2f5..00d4cdf 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -1172,11 +1172,11 @@ paths: port: 3008 - application-name: 'TypeApprovalRegister' release-number: '1.0.0' - protocol: 'HTTPS' + protocol: 'HTTP' address: ip-address: - ipv-4-address: '1.2.3.9' - port: 3209 + ipv-4-address: '1.1.3.2' + port: 3002 headers: x-correlator: schema: From dcc28bde71779815e1eedc7f789c2d96fb8fab8e Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Mon, 19 Dec 2022 17:45:19 +0100 Subject: [PATCH 07/12] Update NewRelease by /v1/...ath-your-data-and-die --- ExecutionAndTraceLog.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 00d4cdf..39c568a 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -38,13 +38,13 @@ paths: 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=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-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=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' new-application-protocol: type: string enum: @@ -52,7 +52,7 @@ paths: - 'HTTPS' description: > 'Protocol to be used for addressing the application that shall be target of the handover process - update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' new-application-address: type: object minProperties: 1 @@ -69,20 +69,20 @@ paths: 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=eatl-2-0-0-tcp-c-nr-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]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 be target of the handover process - update or create [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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' From 4e8dd5646ed9a6bf900345139a5eea6c5ec3ac54 Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Tue, 20 Dec 2022 18:13:24 +0100 Subject: [PATCH 08/12] Update Callbacks --- ExecutionAndTraceLog.yaml | 180 +++++++++++++++++++++++++++----------- 1 file changed, 131 insertions(+), 49 deletions(-) diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 39c568a..f8eaa7b 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -154,35 +154,55 @@ paths: type: object required: - application-name - - application-release-number - - application-address - - application-port + - release-number + - protocol + - address + - port properties: application-name: type: string description: > 'Name of application that shall be requested for service request notifications from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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: + release-number: type: string description: > 'Release of application that shall be requested for service request notifications from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' - application-address: + protocol: type: string description: > - 'IP of application that shall be requested for service request notifications - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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]' - application-port: + 'Protocol to be used for requesting service request notifications + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + address: + type: object + properties: + ip-address: + type: object + properties: + ipv-4-address: + type: string + description: > + 'IP of application that shall be requested for service request notifications + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 + description: > + 'Future domain name + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' + port: type: integer description: > 'TCP port of application that shall be requested for service request notifications from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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' - application-release-number: '2.0.0' - application-address: '1.1.3.8' - application-port: 3008 + release-number: '2.0.0' + protocol: 'HTTP' + address: + ip-address: + ipv-4-address: '1.1.3.8' + port: 3008 responses: '204': description: 'Application will be requested for service request notifications' @@ -245,6 +265,7 @@ paths: - subscriber-application - subscriber-release-number - subscriber-operation + - subscriber-protocol - subscriber-address - subscriber-port properties: @@ -263,11 +284,28 @@ paths: description: > 'Names of the operation that shall be addressed by notifications about new approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-is-001/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]' - subscriber-address: + subscriber-protocol: type: string description: > - 'Future IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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]' + 'Protocol to be used for addressing the application that wants to receive notifications about new approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + subscriber-address: + type: object + properties: + ip-address: + type: object + properties: + ipv-4-address: + type: string + description: > + 'IPv4 address of application that wants to receive notifications about new approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 wants to receive notifications about new approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' subscriber-port: type: integer description: > @@ -277,7 +315,10 @@ paths: subscriber-application: 'ExecutionAndTraceLog' subscriber-release-number: '2.0.0' subscriber-operation: '/v1/regard-application' - subscriber-address: '1.1.3.10' + subscriber-protocol: 'HTTP' + subscriber-address: + ip-address: + ipv-4-address: '1.1.3.10' subscriber-port: 3010 responses: '204': @@ -341,6 +382,7 @@ paths: - subscriber-application - subscriber-release-number - subscriber-operation + - subscriber-protocol - subscriber-address - subscriber-port properties: @@ -359,21 +401,41 @@ paths: description: > 'Names of the operation that shall be addressed by notifications about withdrawn approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-is-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]' - subscriber-address: + subscriber-protocol: type: string description: > - 'Future IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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]' + 'Protocol to be used for addressing the application that wants to receive notifications about withdrawn approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + subscriber-address: + type: object + properties: + ip-address: + type: object + properties: + ipv-4-address: + type: string + description: > + 'IP address of the application that wants to receive notifications about withdrawn approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 the application that wants to receive notifications about withdrawn approvals + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' subscriber-port: type: integer description: > - 'Future port + 'TCP port of the application that wants to receive notifications about withdrawn approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' example: subscriber-application: 'ExecutionAndTraceLog' subscriber-release-number: '2.0.0' subscriber-operation: '/v1/disregard-application' - subscriber-address: '1.1.3.10' + subscriber-protocol: 'HTTP' + subscriber-address: + ip-address: + ipv-4-address: '1.1.3.10' subscriber-port: 3010 responses: '204': @@ -519,33 +581,33 @@ paths: type: object required: - application-name - - old-application-release-number - - new-application-release-number - - new-application-protocol - - new-application-address - - new-application-port + - old-release-number + - new-release-number + - new-protocol + - new-address + - new-port properties: application-name: type: string description: > 'Own application name from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' - old-application-release-number: + old-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=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' - new-application-release-number: + new-release-number: type: string description: > 'Future release number from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' - new-application-protocol: + new-protocol: type: string description: > 'Future protocol to be used from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' - new-application-address: + new-address: type: object minProperties: 1 maxProperties: 1 @@ -566,20 +628,20 @@ paths: description: > 'Future domain name from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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: + new-port: type: integer description: > 'Future port from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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-protocol: 'HTTP' - new-application-address: + old-release-number: '1.0.0' + new-release-number: '2.0.0' + new-protocol: 'HTTP' + new-address: ip-address: ipv-4-address: '1.1.3.8' - new-application-port: 3008 + new-port: 3008 responses: '204': description: 'Will broadcast server replacement' @@ -640,21 +702,21 @@ paths: type: object required: - application-name - - application-release-number + - release-number properties: application-name: type: string description: > 'Own application name from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' - application-release-number: + release-number: type: string description: > 'Own release number from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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' + release-number: '1.0.0' responses: '204': description: 'Application deregistered' @@ -718,7 +780,7 @@ paths: type: object required: - application-name - - application-release-number + - release-number - old-operation-name - new-operation-name properties: @@ -727,7 +789,7 @@ paths: description: > 'Own application name from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' - application-release-number: + release-number: type: string description: > 'Own release number @@ -744,7 +806,7 @@ paths: from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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' + release-number: '2.0.0' old-operation-name: '/v1/register-application' new-operation-name: '/v2/register-application' responses: @@ -941,6 +1003,7 @@ paths: - service-log-application - service-log-application-release-number - service-log-operation + - service-log-protocol - service-log-address - service-log-port properties: @@ -957,13 +1020,29 @@ paths: service-log-operation: type: string description: > - 'Own service for logging service requests + 'Operation for recording the service requests from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-is-004/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]' - service-log-address: + service-log-protocol: type: string description: > - 'Own IP address - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/ipv-4-address]' + 'Protocol to be used for addressing the application that shall record the service requests + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol]' + service-log-address: + type: object + properties: + ip-address: + type: object + properties: + ipv-4-address: + type: string + description: > + 'Own IP address + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-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=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/local-port]' service-log-port: type: integer description: > @@ -973,7 +1052,10 @@ paths: service-log-application: 'ExecutionAndTraceLog' service-log-application-release-number: '2.0.0' service-log-operation: '/v1/record-service-request' - service-log-address: '1.1.3.10' + service-log-protocol: 'HTTP' + service-log-address: + ip-address: + ipv-4-address: '1.1.3.10' service-log-port: 3010 responses: '204': @@ -1247,7 +1329,7 @@ paths: user: 'User Name' originator: 'Resolver' application-name: 'CurrentController' - application-release-number: '1.0.0' + release-number: '1.0.0' operation-name: '/v1/provide-current-controller' response-code: 200 timestamp: '2010-11-20T14:00:00+01:00' @@ -2109,7 +2191,7 @@ components: - user - originator - application-name - - application-release-number + - release-number - operation-name - response-code properties: @@ -2132,7 +2214,7 @@ components: type: string minLength: 3 description: 'ApplicationName on the server side' - application-release-number: + release-number: type: string pattern: ^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$ description: 'ReleaseNumber on the server side' From 186e6c66ef2e0bc5540a6778709c0f2844c1a6de Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Wed, 21 Dec 2022 16:41:29 +0100 Subject: [PATCH 09/12] Consolidate feedback --- ExecutionAndTraceLog.yaml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index f8eaa7b..1ea7689 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -272,8 +272,8 @@ paths: subscriber-application: type: string description: > - 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + 'Future application name + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' subscriber-release-number: type: string description: > @@ -389,8 +389,8 @@ paths: subscriber-application: type: string description: > - 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' + 'Future application name + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' subscriber-release-number: type: string description: > @@ -509,7 +509,7 @@ paths: type: string description: > 'Old release number - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-or-1-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' subscription: type: string description: > @@ -605,7 +605,7 @@ paths: new-protocol: type: string description: > - 'Future protocol to be used + 'Protocol to be used in future for addressing the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' new-address: type: object @@ -621,17 +621,17 @@ paths: ipv-4-address: type: string description: > - 'Future IPv4 address + 'Future IPv4 address of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 description: > - 'Future domain name + 'Future domain name of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' new-port: type: integer description: > - 'Future port + 'Future port of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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' @@ -2216,7 +2216,7 @@ components: description: 'ApplicationName on the server side' release-number: type: string - pattern: ^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$ + pattern: ^([0-9]{1,2}).([0-9]{1,2}).([0-9]{1,2})$ description: 'ReleaseNumber on the server side' operation-name: type: string From 11b88aa42e07dc1b8c6e53741c8f772a1e828d5f Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Thu, 22 Dec 2022 17:24:49 +0100 Subject: [PATCH 10/12] Rectify callbacks --- ExecutionAndTraceLog.yaml | 77 ++++++++++++++++++++------------------- 1 file changed, 40 insertions(+), 37 deletions(-) diff --git a/ExecutionAndTraceLog.yaml b/ExecutionAndTraceLog.yaml index 1ea7689..47bd03c 100644 --- a/ExecutionAndTraceLog.yaml +++ b/ExecutionAndTraceLog.yaml @@ -188,7 +188,7 @@ paths: domain-name: type: string description: > - 'Future domain name + 'Domain name of application that shall be requested for service request notifications from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' port: type: integer @@ -309,7 +309,7 @@ paths: subscriber-port: type: integer description: > - 'Future port + 'TCP port of application that wants to receive notifications about new approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' example: subscriber-application: 'ExecutionAndTraceLog' @@ -415,18 +415,18 @@ paths: ipv-4-address: type: string description: > - 'IP address of the application that wants to receive notifications about withdrawn approvals + 'IPv4 address of application that wants to receive notifications about withdrawn approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-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 the application that wants to receive notifications about withdrawn approvals + 'Domain name of application that wants to receive notifications about withdrawn approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' subscriber-port: type: integer description: > - 'TCP port of the application that wants to receive notifications about withdrawn approvals + 'TCP port of application that wants to receive notifications about withdrawn approvals from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' example: subscriber-application: 'ExecutionAndTraceLog' @@ -508,7 +508,7 @@ paths: subscriber-release-number: type: string description: > - 'Old release number + 'Own release number from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' subscription: type: string @@ -516,10 +516,11 @@ paths: 'Name of operation that had been addressed for starting getting notifications from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-c-im-ro-2-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] and - from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-c-im-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]' + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-c-im-ro-2-0-0-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] + in two separate, sequential requests.' example: subscriber-application: 'ExecutionAndTraceLog' - subscriber-release-number: '2.0.0' + subscriber-release-number: '1.0.0' subscription: '/v1/notify-approvals' responses: '204': @@ -580,43 +581,44 @@ paths: schema: type: object required: - - application-name - - old-release-number - - new-release-number - - new-protocol - - new-address - - new-port + - current-application-name + - current-release-number + - future-application-name + - future-release-number + - future-protocol + - future-address + - future-port properties: - application-name: + current-application-name: type: string description: > 'Own application name from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name]' - old-release-number: + current-release-number: type: string description: > - 'Old release number = current release number of the application requested to bequeath its data and die + 'Own release number from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' - new-release-number: + future-application-name: type: string description: > - 'Future release number + 'Future name of the application that has updated connection data + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + future-release-number: + type: string + description: > + 'Future release number of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-nr-2-0-0-000/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' - new-protocol: + future-protocol: type: string description: > 'Protocol to be used in future for addressing the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' - new-address: + future-address: type: object - minProperties: 1 - maxProperties: 1 - additionalProperties: false properties: ip-address: type: object - minProperties: 1 - additionalProperties: false properties: ipv-4-address: type: string @@ -628,20 +630,21 @@ paths: description: > 'Future domain name of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' - new-port: + future-port: type: integer description: > 'Future port of the application that has updated connection data from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-nr-2-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-release-number: '1.0.0' - new-release-number: '2.0.0' - new-protocol: 'HTTP' - new-address: + current-application-name: 'ExecutionAndTraceLog' + current-release-number: '1.0.0' + future-application-name: 'ExecutionAndTraceLog' + future-release-number: '2.0.0' + future-protocol: 'HTTP' + future-address: ip-address: - ipv-4-address: '1.1.3.8' - new-port: 3008 + ipv-4-address: '1.1.3.9' + future-port: 3009 responses: '204': description: 'Will broadcast server replacement' @@ -805,10 +808,10 @@ paths: 'Name of the replacing operation from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-name: 'ExecutionAndTraceLog' release-number: '2.0.0' - old-operation-name: '/v1/register-application' - new-operation-name: '/v2/register-application' + old-operation-name: '/v1/regard-application' + new-operation-name: '/v2/regard-application' responses: '204': description: 'Will broadcast operation update' From 9ce105602d2e3ec4d04d46d7b0dfd9eed8305de2 Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Fri, 23 Dec 2022 22:46:32 +0100 Subject: [PATCH 11/12] Restructure folders --- README.md | 45 ++++++------------- .../ExecutionAndTraceLog+config.json | 0 .../ExecutionAndTraceLog+forwardings.yaml | 0 ...ExecutionAndTraceLog+profileInstances.yaml | 0 .../ExecutionAndTraceLog+profiles.yaml | 0 .../ExecutionAndTraceLog+services.yaml | 0 .../ExecutionAndTraceLog.yaml | 0 spec/README.md | 20 +++++++++ .../ExecutionAndTraceLog+data.json | 0 .../ExecutionAndTraceLog+testcases.json | 0 testing/README.md | 10 +++++ 11 files changed, 44 insertions(+), 31 deletions(-) rename ExecutionAndTraceLog+config.json => spec/ExecutionAndTraceLog+config.json (100%) rename ExecutionAndTraceLog+forwardings.yaml => spec/ExecutionAndTraceLog+forwardings.yaml (100%) rename ExecutionAndTraceLog+profileInstances.yaml => spec/ExecutionAndTraceLog+profileInstances.yaml (100%) rename ExecutionAndTraceLog+profiles.yaml => spec/ExecutionAndTraceLog+profiles.yaml (100%) rename ExecutionAndTraceLog+services.yaml => spec/ExecutionAndTraceLog+services.yaml (100%) rename ExecutionAndTraceLog.yaml => spec/ExecutionAndTraceLog.yaml (100%) create mode 100644 spec/README.md rename ExecutionAndTraceLog+data.json => testing/ExecutionAndTraceLog+data.json (100%) rename ExecutionAndTraceLog+testcases.json => testing/ExecutionAndTraceLog+testcases.json (100%) create mode 100644 testing/README.md diff --git a/README.md b/README.md index 11e269f..569b42f 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,21 @@ # ExecutionAndTraceLog -- List of records about service requests -- Thorsten Heinze (Thorsten.Heinze@openBackhaul.com) -### ServiceList -- [ExecutionAndTraceLog+services](./ExecutionAndTraceLog+services.yaml) +### Location +The ExecutionAndTraceLog is part of the TinyApplicationController. +The TinyApplicationController is for managing the REST microservices of the application layer. -### ProfileList and ProfileInstanceList -- to be provided -- to be provided +### Description +Every application that belongs to the application layer sends a record about every processed service request to the ExecutionAndTraceLog. +The ExecutionAndTraceLog stores these records into an ElasticSearch database. +Filtering service records for unsuccessfully executed requests or requests belonging to the same flow is supported. -### ForwardingList -- [ExecutionAndTraceLog+forwardings](./ExecutionAndTraceLog+forwardings.yaml) +### Relevance +The ExecutionAndTraceLog is core element of the application layer running in the live network at Telefonica Germany. -### Open API specification (Swagger) -- [ExecutionAndTraceLog](ExecutionAndTraceLog.yaml) - -### CONFIGfile (JSON) -- to be provided - -### Test Cases (Postman Export) and Data File -- [ExecutionAndTraceLog+testcases](./ExecutionAndTraceLog%2Btestcases.json) -- [ExecutionAndTraceLog+data](./ExecutionAndTraceLog+data.json) - -### NodeJS Implementation -- to be provided - -### Publication -- No official publication planned - -### Aspired Classification -- Live Network - -### Open Issue List -- [ExecutionAndTraceLog/issues](../../issues) +### Resources +- [Specification](./spec/) +- [TestSuite](./testing/) +- [Implementation](./server/) ### Comments -This application is part of the TinyApplicationController for managing the REST applications forming the MBH SDN application layer at Telefonica Germany. +./. diff --git a/ExecutionAndTraceLog+config.json b/spec/ExecutionAndTraceLog+config.json similarity index 100% rename from ExecutionAndTraceLog+config.json rename to spec/ExecutionAndTraceLog+config.json diff --git a/ExecutionAndTraceLog+forwardings.yaml b/spec/ExecutionAndTraceLog+forwardings.yaml similarity index 100% rename from ExecutionAndTraceLog+forwardings.yaml rename to spec/ExecutionAndTraceLog+forwardings.yaml diff --git a/ExecutionAndTraceLog+profileInstances.yaml b/spec/ExecutionAndTraceLog+profileInstances.yaml similarity index 100% rename from ExecutionAndTraceLog+profileInstances.yaml rename to spec/ExecutionAndTraceLog+profileInstances.yaml diff --git a/ExecutionAndTraceLog+profiles.yaml b/spec/ExecutionAndTraceLog+profiles.yaml similarity index 100% rename from ExecutionAndTraceLog+profiles.yaml rename to spec/ExecutionAndTraceLog+profiles.yaml diff --git a/ExecutionAndTraceLog+services.yaml b/spec/ExecutionAndTraceLog+services.yaml similarity index 100% rename from ExecutionAndTraceLog+services.yaml rename to spec/ExecutionAndTraceLog+services.yaml diff --git a/ExecutionAndTraceLog.yaml b/spec/ExecutionAndTraceLog.yaml similarity index 100% rename from ExecutionAndTraceLog.yaml rename to spec/ExecutionAndTraceLog.yaml diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 0000000..616a2ac --- /dev/null +++ b/spec/README.md @@ -0,0 +1,20 @@ +# ExecutionAndTraceLog Specification + +### ServiceList +- [ExecutionAndTraceLog+services](./ExecutionAndTraceLog+services.yaml) + +### ProfileList and ProfileInstanceList +- [ExecutionAndTraceLog+profiles](./ExecutionAndTraceLog+profiles.yaml) +- [ExecutionAndTraceLog+profileInstances](./ExecutionAndTraceLog+profileInstances.yaml) + +### ForwardingList +- [ExecutionAndTraceLog+forwardings](./ExecutionAndTraceLog+forwardings.yaml) + +### Open API specification (Swagger) +- [ExecutionAndTraceLog](./ExecutionAndTraceLog.yaml) + +### CONFIGfile (JSON) +- [ExecutionAndTraceLog+config](./ExecutionAndTraceLog+config.json) + +### Comments +./. diff --git a/ExecutionAndTraceLog+data.json b/testing/ExecutionAndTraceLog+data.json similarity index 100% rename from ExecutionAndTraceLog+data.json rename to testing/ExecutionAndTraceLog+data.json diff --git a/ExecutionAndTraceLog+testcases.json b/testing/ExecutionAndTraceLog+testcases.json similarity index 100% rename from ExecutionAndTraceLog+testcases.json rename to testing/ExecutionAndTraceLog+testcases.json diff --git a/testing/README.md b/testing/README.md new file mode 100644 index 0000000..29f1b02 --- /dev/null +++ b/testing/README.md @@ -0,0 +1,10 @@ +# ExecutionAndTraceLog Testing + +### Test Cases (Postman Export) +- [ExecutionAndTraceLog+testcases](./ExecutionAndTraceLog+testcases.json) + +### DATAfile +- [ExecutionAndTraceLog+data](./ExecutionAndTraceLog+data.json) + +### Comments +./. From 49ad6bb2398e34a4d05609009fde62bfa550d133 Mon Sep 17 00:00:00 2001 From: openBackhaul Date: Fri, 23 Dec 2022 23:28:55 +0100 Subject: [PATCH 12/12] Marry EaTL with AP --- spec/ExecutionAndTraceLog.yaml | 8165 +++++++++++++++++++++++++++++++- 1 file changed, 8159 insertions(+), 6 deletions(-) diff --git a/spec/ExecutionAndTraceLog.yaml b/spec/ExecutionAndTraceLog.yaml index 47bd03c..bec5d7a 100644 --- a/spec/ExecutionAndTraceLog.yaml +++ b/spec/ExecutionAndTraceLog.yaml @@ -1701,14 +1701,8167 @@ paths: ######################################## # Service Layer - Basic Part ######################################## + /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: true + content: + application/json: + schema: + oneOf: + - description: 'use existing configuration' + type: object + maxProperties: 0 + - description: 'update configuration' + type: object + required: + - registry-office-application + - registry-office-application-release-number + - registration-operation + - registry-office-protocol + - registry-office-address + - registry-office-port + properties: + registry-office-application: + type: string + minLength: 3 + description: > + 'If body provided, name of RegistryOffice application + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'If body provided, protocol for addressing the RegistryOffice application + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + http-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 (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == http + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/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 (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == http + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]' + http-port: + type: integer + minimum: 0 + maximum: 65535 + description: > + 'If provided, own TCP port, which has to be documented (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == http + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]' + https-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 (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == https + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/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 (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == https + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]' + https-port: + type: integer + minimum: 0 + maximum: 65535 + description: > + 'If provided, own TCP port, which has to be documented (but not be directly used for formulating the callback) into the TcpServer with + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol] == https + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-*/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]' + preceding-application-name: + type: string + minLength: 3 + description: > + 'If provided, the new application will address /v1/bequeath-your-data-and-die at the preceding application after receiving /v1/embed-yourself + (/v1/bequeath-your-data-and-die will not be sent, if application-name in *-http-c-or-* == OldRelease) + update [/core-model-1-4:control-construct/logical-termination-point=*-http-c-or-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + preceding-release-number: + type: string + pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$' + description: > + 'If application-name in *-http-c-or-* different from OldRelease, the new application will address /v1/bequeath-your-data-and-die at the preceding release after receiving /v1/embed-yourself + update [/core-model-1-4:control-construct/logical-termination-point=*-http-c-or-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + example: + registry-office-application: 'RegistryOffice' + registry-office-application-release-number: '2.0.0' + registration-operation: '/v1/register-application' + registry-office-protocol: 'HTTP' + registry-office-address: + ip-address: + ipv-4-address: '1.1.3.8' + registry-office-port: 3008 + http-address: + ip-address: + ipv-4-address: '1.1.3.9' + http-port: 3009 + preceding-application-name: 'TypeApprovalRegister' + preceding-release-number: '1.0.0' + 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=eatl-2-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://{[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]}:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-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] + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - application-name + - release-number + - embedding-operation + - client-update-operation + - operation-client-update-operation + - tcp-server-list + properties: + application-name: + type: string + description: > + 'Own application name + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + preceding-application-name: + type: string + description: > + 'To be providede if application-name in *-http-c-or-* different from OldRelease + for preparing RO for the new application addressing /v1/bequeath-your-data-and-die at the preceding application after receiving /v1/embed-yourself + from [/core-model-1-4:control-construct/logical-termination-point=*-http-c-or-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + preceding-release-number: + type: string + description: > + 'To be providede if application-name in *-http-c-or-* different from OldRelease + for preparing RO for the new application addressing /v1/bequeath-your-data-and-die at the preceding application after receiving /v1/embed-yourself + from [/core-model-1-4:control-construct/logical-termination-point=*-http-c-or-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + embedding-operation: + type: string + description: > + 'Name of service for initiating embedding process + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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=eatl-2-0-0-op-s-bm-007/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]' + operation-client-update-operation: + type: string + description: > + 'Name of service for broadcasting replacements of operations by backward compatible substitutes + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-bm-011/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name]' + tcp-server-list: + type: array + items: + type: object + required: + - protocol + - address + - port + properties: + protocol: + type: string + description: > + 'Own protocol (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=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol]' + address: + type: object + properties: + ip-address: + type: object + 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=eatl-2-0-0-tcp-s-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=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-address/domain-name]' + 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=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-port]' + example: + application-name: 'TypeApprovalRegister' + release-number: '2.0.0' + preceding-application-name: 'TypeApprovalRegister' + preceding-release-number: '1.0.0' + embedding-operation: '/v1/embed-yourself' + client-update-operation: '/v1/update-client' + operation-client-update-operation: '/v1/update-operation-client' + tcp-server-list: + - protocol: 'HTTP' + address: + ip-address: + ipv-4-address: '1.1.3.9' + port: 3009 + - protocol: 'HTTPS' + address: + ip-address: + ipv-4-address: '1.2.3.9' + port: 3209 + 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' + '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-protocol + - registry-office-address + - registry-office-port + - old-release-protocol + - old-release-address + - old-release-port + properties: + registry-office-application: + type: string + description: > + 'Name of RegistryOffice application + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol for addressing RegistryOffice application + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol for addressing the currently running old release of the same application + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-or-1-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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-protocol: 'HTTP' + registry-office-address: + ip-address: + ipv-4-address: '1.1.3.8' + registry-office-port: 3008 + old-release-protocol: 'HTTP' + 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=eatl-2-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ro-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-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] + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - new-application-name + - new-application-release + - new-application-protocol + - 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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number]' + new-application-protocol: + type: string + description: > + 'Protocol expected by this application + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-000/layer-protocol=0/tcp-server-interface-1-0:tcp-server-interface-pac/tcp-server-interface-configuration/local-protocol]' + new-application-address: + type: object + properties: + ip-address: + type: object + properties: + ipv-4-address: + type: string + description: > + 'Own IPv4 address + from [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-s-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=eatl-2-0-0-tcp-s-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=eatl-2-0-0-tcp-s-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-protocol: 'HTTP' + 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-protocol + - 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=eatl-2-0-0-http-c-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=eatl-2-0-0-http-c-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=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol to be used for addressing the application that shall record the service requests + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-eatl-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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-protocol: 'HTTP' + 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=eatl-2-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-eatl-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-eatl-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=eatl-2-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] + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-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-protocol + - 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=eatl-2-0-0-http-c-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=eatl-2-0-0-http-c-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=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol to be used for addressing the application that shall record the OaM requests + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ol-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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=eatl-2-0-0-tcp-c-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-protocol: 'HTTP' + 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=eatl-2-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ol-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-ol-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=eatl-2-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] + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-tcp-s-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=eatl-2-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=eatl-2-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=eatl-2-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=eatl-2-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-protocol + - 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=eatl-2-0-0-http-c-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=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol to be used for addressing the application that shall approve the OaM requests + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-aa-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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-protocol: 'HTTP' + 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=eatl-2-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-aa-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-aa-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=eatl-2-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] + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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 + 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 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' + description: > + 'Initiates update of release number and TCP/IP address at existing HttpClients and TcpClients. + If combination of {future-application-name, future-release-number} is different from combination {current-application-name, current-release-number} + and if HttpClient with combination of {future-application-name, future-release-number} already exists, + HttpClient with combination {current-application-name, current-release-number} shall not be updated, + but OperationClients shall be transferred to the HttpClient with combination of {future-application-name, future-release-number}.' + tags: + - BasicServices + security: + - apiKeyAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - current-application-name + - current-release-number + - future-application-name + - future-release-number + - future-protocol + - future-address + - future-port + properties: + current-application-name: + type: string + description: > + 'Current name of the application that has updated connection data + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + current-release-number: + type: string + pattern: '^([0-9]{1,2})\.([0-9]{1,2})\.([0-9]{1,2})$' + description: > + 'Current release number of the application that has updated connection data + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + future-application-name: + type: string + description: > + 'Future name of the application that has updated connection data + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + future-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=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/release-number]' + future-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol to be used in future for addressing the application that has updated connection data + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + future-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=eatl-2-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=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-address/domain-name]' + future-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=eatl-2-0-0-tcp-c-*/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-port]' + example: + current-application-name: 'RegistryOffice' + current-release-number: '1.0.0' + future-application-name: 'RegistryOffice' + future-release-number: '2.0.0' + future-protocol: 'HTTP' + future-address: + ip-address: + ipv-4-address: '1.1.3.8' + future-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=eatl-2-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: + $ref: '#/components/schemas/logicalTerminationPoint' + 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-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-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: + $ref: '#/components/schemas/forwardingDomain' + 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=eatl-2-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 and provides current data tree' + tags: + - BasicServices + security: + - apiKeyAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - topology-application + - topology-application-release-number + - topology-operation-ltp-update + - topology-operation-ltp-deletion + - topology-operation-fc-update + - topology-operation-fc-port-update + - topology-operation-fc-port-deletion + - topology-application-protocol + - topology-application-address + - topology-application-port + properties: + topology-application: + type: string + description: > + 'Name of application that shall document the application layer topology + find [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-c-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-ltp-update: + type: string + minLength: 6 + description: > + 'Operation for updating an LTP + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 and its dependents like FC port and Link (if applicable) + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 a ForwardingConstruct instance + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-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-protocol: + type: string + enum: + - 'HTTP' + - 'HTTPS' + description: > + 'Protocol to be used for addresing the application that shall document the application layer topology + update [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]' + 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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 [/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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-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-protocol: 'HTTP' + topology-application-address: + ip-address: + ipv-4-address: '1.1.3.13' + topology-application-port: 3013 + responses: + '200': + description: 'Client side for sending information about topology changes has been updated and current data tree has been provided' + content: + application/json: + schema: + type: object + required: + - core-model-1-4:control-construct + properties: + core-model-1-4:control-construct: + type: object + description: > + 'Entire internal datatree + from [/core-model-1-4:control-construct]' + required: + - uuid + - logical-termination-point + - forwarding-domain + properties: + uuid: + type: string + logical-termination-point: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/logicalTerminationPoint' + 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-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-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: + $ref: '#/components/schemas/forwardingDomain' + 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=eatl-2-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: + ServiceRequestCausesLtpUpdateRequest: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever a service request causes the creation or change of an LTP' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/logicalTerminationPoint' + 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-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever a service request causes an LTP being deleted' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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 and its dependents 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever a service request causes the creation or change of an FC port' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever a service request causes an FC port being updated' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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 + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever a service request causes an FC port being deleted' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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-003' + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever an OaM request causes the creation or change of an LTP' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/logicalTerminationPoint' + 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-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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever an OaM request causes an LTP being deleted' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever an OaM request causes the creation or change of an FC port' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever an OaM request causes an FC port being updated' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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: + url: #[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-2-0-0-000/layer-protocol=0/tcp-client-interface-1-0:tcp-client-interface-pac/tcp-client-interface-configuration/remote-protocol]://[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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 or /core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-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]:[/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-tcp-c-alt-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=eatl-2-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] + description: 'To be activated whenever an OaM request causes an FC port being deleted' + post: + parameters: + - $ref: '#/components/parameters/user' + - $ref: '#/components/parameters/originator' + - $ref: '#/components/parameters/x-correlator' + - $ref: '#/components/parameters/trace-indicator' + - $ref: '#/components/parameters/customer-journey' + 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=eatl-2-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 + - 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=eatl-2-0-0-http-c-*/layer-protocol=0/http-client-interface-1-0:http-client-interface-pac/http-client-interface-configuration/application-name]' + 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=eatl-2-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=eatl-2-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=eatl-2-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' + 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=eatl-2-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/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: + - BasicServices + responses: + '200': + description: 'Start mask provided' + content: + application/json: + schema: + $ref: '#/components/schemas/genericRepresentation' + example: + response-value-list: + - field-name: 'applicationName' + value: 'OwnApplicationName' + datatype: 'string' + consequent-action-list: + - 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=eatl-2-0-0-op-s-bs-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' + '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 + - 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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address]' + example: + application-name: 'OwnApplicationName' + 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=eatl-2-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: + $ref: '#/components/schemas/genericRepresentation' + example: + response-value-list: + - 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: + - 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=eatl-2-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-0-0-http-s-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=eatl-2-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: + $ref: '#/components/schemas/genericRepresentation' + example: + response-value-list: + - field-name: '1.0.0' + value: '20.11.2010 - Initial version.' + datatype: 'string' + consequent-action-list: + 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=eatl-2-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 +######################################## + /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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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: + - consequent-operation-reference + properties: + consequent-operation-reference: + type: string + - description: 'generic response profile' + type: object + required: + - uuid + - profile-name + - response-profile-1-0:response-profile-pac + properties: + uuid: + type: string + profile-name: + type: string + enum: + - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + response-profile-1-0:response-profile-pac: + type: object + required: + - response-profile-capability + - response-profile-configuration + properties: + response-profile-capability: + type: object + required: + - operation-name + - field-name + - datatype + properties: + operation-name: + type: string + field-name: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-field-name: + type: string + field-name-reference: + type: string + description: + type: string + datatype: + type: string + response-profile-configuration: + type: object + required: + - value + properties: + value: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-value: + type: string + value-reference: + 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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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 + enumeration: + type: string + pattern: + 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: + - local-id + - release-number + - release-date + - changes + properties: + local-id: + type: string + 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: + - description + - local-protocol + - local-address + - local-port + properties: + description: + type: string + local-protocol: + type: string + local-address: + type: object + minProperties: 1 + maxProperties: 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 + 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-protocol + - remote-address + - remote-port + properties: + remote-protocol: + type: string + 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-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-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-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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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: + - consequent-operation-reference + properties: + consequent-operation-reference: + type: string + - description: 'generic response profile' + type: object + required: + - uuid + - profile-name + - response-profile-1-0:response-profile-pac + properties: + uuid: + type: string + profile-name: + type: string + enum: + - 'action-profile-1-0:PROFILE_NAME_TYPE_ACTION_PROFILE' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + response-profile-1-0:response-profile-pac: + type: object + required: + - response-profile-capability + - response-profile-configuration + properties: + response-profile-capability: + type: object + required: + - operation-name + - field-name + - datatype + properties: + operation-name: + type: string + field-name: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-field-name: + type: string + field-name-reference: + type: string + description: + type: string + datatype: + type: string + response-profile-configuration: + type: object + required: + - value + properties: + value: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-value: + type: string + value-reference: + 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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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' + - 'response-profile-1-0:PROFILE_NAME_TYPE_GENERIC_RESPONSE_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 + enumeration: + type: string + pattern: + 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: + consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name' + '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 +######################################## + /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/consequent-operation-reference: + 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: getActionProfileConsequentOperationReference + summary: 'Returns the reference on the consequent operation' + tags: + - ActionProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Reference on the consequent operation provided' + content: + application/json: + schema: + type: object + required: + - action-profile-1-0:consequent-operation-reference + properties: + action-profile-1-0:consequent-operation-reference: + type: string + example: '/core-model-1-4:control-construct/logical-termination-point=ro-1-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name' + '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: putActionProfileConsequentOperationReference + summary: 'Configures the reference on the consequent operation' + tags: + - ActionProfile + security: + - basicAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - action-profile-1-0:consequent-operation-reference + properties: + action-profile-1-0:consequent-operation-reference: + type: string + example: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name' + responses: + '204': + description: 'Reference on the consequent 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/profile-collection/profile={uuid}/response-profile-1-0:response-profile-pac/response-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})-response-p-([0-9]{3})$' + example: 'ro-2-0-0-response-p-000' + get: + operationId: getGenericResponseProfileOperationName + summary: 'Returns the name of the Operation' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Operation name provided' + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:operation-name + properties: + response-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}/response-profile-1-0:response-profile-pac/response-profile-capability/field-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})-response-p-([0-9]{3})$' + example: 'ro-2-0-0-response-p-000' + get: + operationId: getGenericResponseProfileFieldName + summary: 'Returns the name of the Field' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Field name provided' + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:field-name + properties: + response-profile-1-0:field-name: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-field-name: + type: string + field-name-reference: + type: string + example: + static-field-name: '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/profile-collection/profile={uuid}/response-profile-1-0:response-profile-pac/response-profile-capability/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})-response-p-([0-9]{3})$' + example: 'ro-2-0-0-response-p-000' + get: + operationId: getGenericResponseProfileDescription + summary: 'Returns the Description of the Field' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Description of the field provided' + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:description + properties: + response-profile-1-0:description: + type: string + example: 'Name of this 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}/response-profile-1-0:response-profile-pac/response-profile-capability/datatype: + 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})-response-p-([0-9]{3})$' + example: 'ro-2-0-0-response-p-000' + get: + operationId: getGenericResponseProfileDatatype + summary: 'Returns the Datatype of the Field' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Datatype of the field provided' + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:datatype + properties: + response-profile-1-0:datatype: + type: string + example: 'string' + '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}/response-profile-1-0:response-profile-pac/response-profile-configuration/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})-response-p-([0-9]{3})$' + example: 'ro-2-0-0-response-p-000' + get: + operationId: getGenericResponseProfileValue + summary: 'Returns the Value of the Field' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + responses: + '200': + description: 'Value of the field provided' + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:value + properties: + response-profile-1-0:value: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-value: + type: string + value-reference: + type: string + example: + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' + '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: putGenericResponseProfileValue + summary: 'Configures the Value of the Field' + tags: + - GenericResponseProfile + security: + - basicAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - response-profile-1-0:value + properties: + response-profile-1-0:value: + type: object + minProperties: 1 + maxProperties: 1 + additionalProperties: false + properties: + static-value: + type: string + value-reference: + type: string + example: + value-reference: '/core-model-1-4:control-construct/logical-termination-point=eatl-2-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name' + 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/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/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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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-000' + example: 'ro-2-0-0-http-s-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: + - local-id + - release-number + - release-date + - changes + properties: + local-id: + type: string + release-number: + type: string + release-date: + type: string + changes: + type: string + example: + - local-id: 0 + 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/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})-tcp-s-([0-9]{3})$' + example: 'ro-2-0-0-tcp-s-000' + get: + operationId: getTcpServerDescription + summary: 'Returns Description of TcpServer' + tags: + - TcpServer + security: + - basicAuth: [] + responses: + '200': + description: 'Description provided' + content: + application/json: + schema: + type: object + required: + - tcp-server-interface-1-0:description + properties: + tcp-server-interface-1-0:description: + type: string + '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: putTcpServerDescription + summary: 'Documents Description of TcpServer' + tags: + - TcpServer + security: + - basicAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - tcp-server-interface-1-0:description + properties: + tcp-server-interface-1-0:description: + type: string + responses: + '204': + description: 'Description 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-protocol: + 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-([0-9]{3})$' + example: 'ro-2-0-0-tcp-s-000' + get: + operationId: getTcpServerLocalProtocol + summary: 'Returns Protocol of TcpServer' + tags: + - TcpServer + security: + - basicAuth: [] + responses: + '200': + description: 'Local protocol provided' + content: + application/json: + schema: + type: object + required: + - tcp-server-interface-1-0:local-protocol + properties: + tcp-server-interface-1-0:local-protocol: + type: string + enum: + - 'tcp-server-interface-1-0:PROTOCOL_TYPE_HTTP' + - 'tcp-server-interface-1-0:PROTOCOL_TYPE_HTTPS' + - 'tcp-server-interface-1-0:PROTOCOL_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' + put: + operationId: putTcpServerLocalProtocol + summary: 'Documents Protocol of TcpServer' + tags: + - TcpServer + security: + - basicAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - tcp-server-interface-1-0:local-protocol + properties: + tcp-server-interface-1-0:local-protocol: + type: string + enum: + - 'tcp-server-interface-1-0:PROTOCOL_TYPE_HTTP' + - 'tcp-server-interface-1-0:PROTOCOL_TYPE_HTTPS' + - 'tcp-server-interface-1-0:PROTOCOL_TYPE_NOT_YET_DEFINED' + responses: + '204': + description: 'Local protocol 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-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-([0-9]{3})$' + example: 'ro-2-0-0-tcp-s-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 + 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 + maxProperties: 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-([0-9]{3})$' + example: 'ro-2-0-0-tcp-s-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/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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$' + example: 'eatl-2-0-0-es-c-es-1-0-0-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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$' + example: 'eatl-2-0-0-es-c-es-1-0-0-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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$' + example: 'eatl-2-0-0-es-c-es-1-0-0-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 + 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 + 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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$' + example: 'eatl-2-0-0-es-c-es-1-0-0-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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{3})$' + example: 'eatl-2-0-0-es-c-es-1-0-0-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 - Individual Part -######################################## + /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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$' + example: 'ro-2-0-0-http-c-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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$' + example: 'ro-2-0-0-http-c-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' -######################################## -# OAM Layer - Basic Part -######################################## + /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-protocol: + 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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$' + example: 'ro-2-0-0-tcp-c-or-1-0-0-000' + get: + operationId: getTcpClientRemoteProtocol + summary: 'Returns protocol for addressing remote side' + tags: + - TcpClient + security: + - basicAuth: [] + responses: + '200': + description: 'Protocol for addressing remote side provided' + content: + application/json: + schema: + type: object + required: + - tcp-client-interface-1-0:remote-protocol + properties: + tcp-client-interface-1-0:remote-protocol: + type: string + enum: + - 'tcp-client-interface-1-0:PROTOCOL_TYPE_HTTP' + - 'tcp-client-interface-1-0:PROTOCOL_TYPE_HTTPS' + - 'tcp-client-interface-1-0:PROTOCOL_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' + put: + operationId: putTcpClientRemoteProtocol + summary: 'Configures protocol for addressing remote side' + tags: + - TcpClient + security: + - basicAuth: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - tcp-client-interface-1-0:remote-protocol + properties: + tcp-client-interface-1-0:remote-protocol: + type: string + enum: + - 'tcp-client-interface-1-0:PROTOCOL_TYPE_HTTP' + - 'tcp-client-interface-1-0:PROTOCOL_TYPE_HTTPS' + - 'tcp-client-interface-1-0:PROTOCOL_TYPE_NOT_YET_DEFINED' + responses: + '204': + description: 'Protocol for addressing remote side 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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$' + example: 'ro-2-0-0-tcp-c-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 + properties: + ip-address: + type: object + 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-([a-z]{2,6})-([0-9]{1,2})-([0-9]{1,2})-([0-9]{1,2})-000$' + example: 'ro-2-0-0-tcp-c-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