diff --git a/README.md b/README.md index af583da9..6737ad62 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ Also **notification handling** has been changed: - now, Kafka has been added in between NP and MWDI to overcome the performance problems - NP will push the notifications to Kafka ("proper" notification topic) - MWDI will pull the notifications from Kafka ("proper" notification topic) -- the *regard*-services previously used to receive notifications have been marked as deprecated + - the *regard*-services previously called by NP to push the notifications to MWDI, will now be called from MWDI internally after pulling of notifications The list of related issues can be found in issue collection [MWDI v1.3.0_spec](https://github.com/openBackhaul/MicroWaveDeviceInventory/milestone/20) diff --git a/spec/MicroWaveDeviceInventory+config.json b/spec/MicroWaveDeviceInventory+config.json index 40a572cc..ac155a94 100644 --- a/spec/MicroWaveDeviceInventory+config.json +++ b/spec/MicroWaveDeviceInventory+config.json @@ -1108,7 +1108,7 @@ "operation-name": "/v1/regard-controller-attribute-value-change" }, "operation-server-interface-configuration": { - "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED", + "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL", "operation-key": "n.a." } } @@ -1132,7 +1132,7 @@ "operation-name": "/v1/regard-device-alarm" }, "operation-server-interface-configuration": { - "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED", + "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL", "operation-key": "n.a." } } @@ -1156,7 +1156,7 @@ "operation-name": "/v1/regard-device-attribute-value-change" }, "operation-server-interface-configuration": { - "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED", + "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL", "operation-key": "n.a." } } @@ -1180,7 +1180,7 @@ "operation-name": "/v1/regard-device-object-creation" }, "operation-server-interface-configuration": { - "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED", + "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL", "operation-key": "n.a." } } @@ -1204,7 +1204,7 @@ "operation-name": "/v1/regard-device-object-deletion" }, "operation-server-interface-configuration": { - "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_DEPRECATED", + "life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL", "operation-key": "n.a." } } @@ -13824,210 +13824,6 @@ } ] }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-000", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/notify-controller-attribute-value-changes", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-010", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/notify-device-alarms", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-011", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/notify-device-attribute-value-changes", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-012", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/notify-device-object-creations", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-013", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/notify-device-object-deletions", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-op-c-is-np-1-0-2-020", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - ], - "server-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-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/end-subscription", - "operation-key": "Operation key not yet provided." - }, - "operation-client-interface-status": { - "operational-state": "operation-client-interface-1-0:OPERATIONAL_STATE_TYPE_EXPERIMENTAL", - "life-cycle-state": "operation-client-interface-1-0:LIFE_CYCLE_STATE_TYPE_EXPERIMENTAL" - } - } - } - ] - }, - - { - "uuid": "mwdi-1-3-0-http-c-np-1-0-2-000", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - "mwdi-1-3-0-op-c-is-np-1-0-2-000", - "mwdi-1-3-0-op-c-is-np-1-0-2-010", - "mwdi-1-3-0-op-c-is-np-1-0-2-011", - "mwdi-1-3-0-op-c-is-np-1-0-2-012", - "mwdi-1-3-0-op-c-is-np-1-0-2-013", - "mwdi-1-3-0-op-c-is-np-1-0-2-020" - ], - "server-ltp": [ - "mwdi-1-3-0-tcp-c-np-1-0-2-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": "NotificationProxy", - "release-number": "1.0.2" - } - } - } - ] - }, - { - "uuid": "mwdi-1-3-0-tcp-c-np-1-0-2-000", - "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", - "client-ltp": [ - "mwdi-1-3-0-http-c-np-1-0-2-000" - ], - "server-ltp": [ - ], - "layer-protocol": [ - { - "local-id": "0", - "layer-protocol-name": "tcp-client-interface-1-0:LAYER_PROTOCOL_NAME_TYPE_TCP_LAYER", - "tcp-client-interface-1-0:tcp-client-interface-pac": { - "tcp-client-interface-configuration": { - "remote-protocol": "tcp-client-interface-1-0:PROTOCOL_TYPE_HTTP", - "remote-address": { - "ip-address": { - "ipv-4-address": "127.0.0.1" - } - }, - "remote-port": 4011 - } - } - } - ] - }, { "uuid": "mwdi-1-3-0-op-c-is-hmwdi-1-0-0-100", "ltp-direction": "core-model-1-4:TERMINATION_DIRECTION_SINK", @@ -14544,51 +14340,6 @@ } ] }, - { - "uuid": "mwdi-1-3-0-op-fc-im-060", - "name": [ - { - "value-name": "ForwardingKind", - "value": "core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET" - }, - { - "value-name": "ForwardingName", - "value": "PromptForEmbeddingCausesSubscribingForNotifications" - } - ], - "fc-port": [ - { - "local-id": "1000", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_INPUT", - "logical-termination-point": "mwdi-1-3-0-op-s-bm-001" - }, - { - "local-id": "2000", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-000" - }, - { - "local-id": "2001", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-010" - }, - { - "local-id": "2002", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-011" - }, - { - "local-id": "2003", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-012" - }, - { - "local-id": "2004", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-013" - } - ] - }, { "uuid": "mwdi-1-3-0-op-fc-im-060", "name": [ @@ -15614,31 +15365,6 @@ } ] }, - { - "uuid": "mwdi-1-3-0-op-fc-im-115", - "name": [ - { - "value-name": "ForwardingKind", - "value": "core-model-1-4:FORWARDING_KIND_TYPE_INVARIANT_PROCESS_SNIPPET" - }, - { - "value-name": "ForwardingName", - "value": "PromptForBequeathingDataCausesUnsubscribingFromDeviceAndControllerNotificationsAtNP" - } - ], - "fc-port": [ - { - "local-id": "1000", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_INPUT", - "logical-termination-point": "mwdi-1-3-0-op-s-im-000" - }, - { - "local-id": "2000", - "port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT", - "logical-termination-point": "mwdi-1-3-0-op-c-is-np-1-0-2-020" - } - ] - }, { "uuid": "mwdi-1-3-0-op-fc-bm-105", "name": [ diff --git a/spec/MicroWaveDeviceInventory+forwardings.yaml b/spec/MicroWaveDeviceInventory+forwardings.yaml index 2250d15e..fcd2b111 100644 --- a/spec/MicroWaveDeviceInventory+forwardings.yaml +++ b/spec/MicroWaveDeviceInventory+forwardings.yaml @@ -235,29 +235,6 @@ forwardings: - client-name: ElasticSearch uuid: mwdi-1-3-0-es-c-es-1-0-0-000 - - forwarding-name: PromptForEmbeddingCausesSubscribingForNotifications - uuid: mwdi-1-3-0-op-fc-im-060 - forwarding-type: InvariantProcessSnippet - management-requests: - operation-client-update: - fc-port-update: - fc-port-deletion: - operation-client-deletion: - initiating-requests: - - server-name: /v1/embed-yourself - uuid: mwdi-1-3-0-op-s-bm-001 - consequent-requests: - - client-name: NotificationProxy://v1/notify-controller-attribute-value-changes - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-000 - - client-name: NotificationProxy://v1/notify-device-alarms - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-010 - - client-name: NotificationProxy://v1/notify-device-attribute-value-changes - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-011 - - client-name: NotificationProxy://v1/notify-device-object-creations - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-012 - - client-name: NotificationProxy://v1/notify-device-object-deletions - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-013 - - forwarding-name: ServiceRequestCausesLoggingRequest uuid: mwdi-1-3-0-op-fc-bm-002 forwarding-type: InvariantProcessSnippet @@ -702,22 +679,6 @@ forwardings: - client-name: NewRelease://v1/notify-object-deletions uuid: mwdi-1-3-0-op-c-im-nr-1-3-0-002 - - forwarding-name: PromptForBequeathingDataCausesUnsubscribingFromDeviceAndControllerNotificationsAtNP - uuid: mwdi-1-3-0-op-fc-im-115 - forwarding-type: InvariantProcessSnippet - management-requests: - operation-client-update: - fc-port-update: - fc-port-deletion: - operation-client-deletion: - initiating-requests: - - server-name: /v1/bequeath-your-data-and-die - uuid: mwdi-1-3-0-op-s-im-000 - consequent-requests: - - client-name: NotificationProxy://v1/end-subscription - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-020 - - - forwarding-name: PromptForBequeathingDataCausesRequestForBroadcastingInfoAboutServerReplacement uuid: mwdi-1-3-0-op-fc-bm-105 forwarding-type: InvariantProcessSnippet @@ -1549,7 +1510,6 @@ forwardings: - client-name: ElasticSearch://control-construct={mountName}/logical-termination-point={uuid}/layer-protocol={localId}/wire-interface-2-0:wire-interface-pac/wire-interface-historical-performances uuid: mwdi-1-3-0-op-c-del-es-1-0-0-874 - - forwarding-name: NotifiedNewDeviceCausesMetadataTableUpdate uuid: mwdi-1-3-0-op-fc-is-001 forwarding-type: InvariantProcessSnippet diff --git a/spec/MicroWaveDeviceInventory+services.yaml b/spec/MicroWaveDeviceInventory+services.yaml index a63870aa..ed216e0d 100644 --- a/spec/MicroWaveDeviceInventory+services.yaml +++ b/spec/MicroWaveDeviceInventory+services.yaml @@ -57,7 +57,7 @@ servers: uuid: mwdi-1-3-0-op-s-bs-005 operation-key: n.a. individual: - # receivers for notifications from NotificationProxy: deprecated since v1.3.0 + # receivers for notifications - operation-name: /v1/regard-controller-attribute-value-change uuid: mwdi-1-3-0-op-s-is-000 operation-key: n.a. @@ -1480,40 +1480,6 @@ clients: - operation-name: /{controllerInternalPathToMountPoint}/node={mountName}/yang-ext:mount/core-model-1-4:control-construct/logical-termination-point={uuid}/layer-protocol={localId}/wire-interface-2-0:wire-interface-pac/wire-interface-historical-performances uuid: mwdi-1-3-0-op-c-is-odl-4-0-2-574 - - http-client: - application-name: NotificationProxy - release-number: 1.0.2 - uuid: mwdi-1-3-0-http-c-np-1-0-2-000 - tcp-client: - remote-protocol: http - ip-address: 127.0.0.1 - tcp-port: 4011 - uuid: mwdi-1-3-0-tcp-c-np-1-0-2-000 - operation-clients: - own-oam: - basic: - individual: - service: - basic: - individual: - ## subscribing for controller notifications - - operation-name: /v1/notify-controller-attribute-value-changes - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-000 - - ## subscribing for device notifications - - operation-name: /v1/notify-device-alarms - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-010 - - operation-name: /v1/notify-device-attribute-value-changes - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-011 - - operation-name: /v1/notify-device-object-creations - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-012 - - operation-name: /v1/notify-device-object-deletions - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-013 - - ## unsubscribe from notifications - - operation-name: /v1/end-subscription - uuid: mwdi-1-3-0-op-c-is-np-1-0-2-020 - - http-client: application-name: HistoricalMicroWaveDeviceInventory release-number: 1.0.0 diff --git a/spec/MicroWaveDeviceInventory.yaml b/spec/MicroWaveDeviceInventory.yaml index 0df6ba78..ca3a8d5d 100644 --- a/spec/MicroWaveDeviceInventory.yaml +++ b/spec/MicroWaveDeviceInventory.yaml @@ -458,97 +458,6 @@ paths: $ref: '#/components/responses/responseForErroredServiceRequests' default: $ref: '#/components/responses/responseForErroredServiceRequests' - PromptForBequeathingDataCausesUnsubscribingFromDeviceAndControllerNotificationsAtNP: - url: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-020/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: - - subscriber-application - - subscriber-release-number - - subscription - properties: - subscriber-application: - type: string - description: > - 'Own application name - from [/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-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: > - 'Own release number - from [/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-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: > - 'Name of operation that had been addressed for starting getting notifications. Requests have to be sent for the following subscriptions: - from [/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-op-c-is-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-010/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=mwdi-1-3-0-op-c-is-np-1-0-2-011/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=mwdi-1-3-0-op-c-is-np-1-0-2-012/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=mwdi-1-3-0-op-c-is-np-1-0-2-013/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] - in five separate, sequential requests.' - example: - subscriber-application: 'MicroWaveDeviceInventory' - subscriber-release-number: '1.0.0' - subscription: '/v1/notify-controller-attribute-value-changes' - 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' - '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' PromptForBequeathingDataCausesRequestForBroadcastingInfoAboutServerReplacement: url: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-ro-2-1-2-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=mwdi-1-3-0-tcp-c-ro-2-1-2-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=mwdi-1-3-0-tcp-c-ro-2-1-2-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=mwdi-1-3-0-tcp-c-ro-2-1-2-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=mwdi-1-3-0-op-c-bm-ro-2-1-2-001/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name] post: @@ -841,10 +750,6 @@ paths: $ref: '#/components/responses/responseForErroredServiceRequests' /v1/regard-controller-attribute-value-change: - description: > - 'DEPRECATED - Service shall be deleted with MWDI v2.0.0 - Starting from MWDI v1.3.0, service shall no longer be used' parameters: - $ref: '#/components/parameters/user' - $ref: '#/components/parameters/originator' @@ -1013,10 +918,6 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' /v1/regard-device-alarm: - description: > - 'DEPRECATED - Service shall be deleted with MWDI v2.0.0 - Starting from MWDI v1.3.0, service shall no longer be used' parameters: - $ref: '#/components/parameters/user' - $ref: '#/components/parameters/originator' @@ -1189,10 +1090,6 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' /v1/regard-device-attribute-value-change: - description: > - 'DEPRECATED - Service shall be deleted with MWDI v2.0.0 - Starting from MWDI v1.3.0, service shall no longer be used' parameters: - $ref: '#/components/parameters/user' - $ref: '#/components/parameters/originator' @@ -1325,10 +1222,6 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' /v1/regard-device-object-creation: - description: > - 'DEPRECATED - Service shall be deleted with MWDI v2.0.0 - Starting from MWDI v1.3.0, service shall no longer be used' parameters: - $ref: '#/components/parameters/user' - $ref: '#/components/parameters/originator' @@ -1433,10 +1326,6 @@ paths: default: $ref: '#/components/responses/responseForErroredServiceRequests' /v1/regard-device-object-deletion: - description: > - 'DEPRECATED - Service shall be deleted with MWDI v2.0.0 - Starting from MWDI v1.3.0, service shall no longer be used' parameters: - $ref: '#/components/parameters/user' - $ref: '#/components/parameters/originator' @@ -23278,533 +23167,6 @@ paths: $ref: '#/components/responses/532' default: $ref: '#/components/responses/responseForErroredServiceRequests' - PromptForEmbeddingCausesSubscribingForNotifications: - #This callback belong to deprecated functionality and needs to be removed with v2.0.0 - ControllerAttributeValueChange: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-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: - - subscribing-application-name - - subscribing-application-release - - subscribing-application-protocol - - subscribing-application-address - - subscribing-application-port - - notifications-receiving-operation - properties: - subscribing-application-name: - type: string - description: 'Name of the application that is subscribing for notifications, i.e. MicroWaveDeviceInventory' - subscribing-application-release: - type: string - description: 'Release number of the MicroWaveDeviceInventory' - subscribing-application-protocol: - type: string - enum: - - 'HTTP' - - 'HTTPS' - description: 'Protocol to be used for addressing the MicroWaveDeviceInventory' - subscribing-application-address: - type: object - properties: - ip-address: - type: object - properties: - ipv-4-address: - type: string - description: 'IPv4 address of the MicroWaveDeviceInventory' - domain-name: - type: string - description: 'Domain name of the MicroWaveDeviceInventory' - subscribing-application-port: - type: integer - description: 'Port of the MicroWaveDeviceInventory' - notifications-receiving-operation: - type: string - description: 'Operation for receiving the notifications at MicroWaveDeviceInventory' - example: - subscribing-application-name: 'MicroWaveDeviceInventory' - subscribing-application-release: '1.3.0' - subscribing-application-protocol: 'HTTP' - subscribing-application-address: - ip-address: - ipv-4-address: '127.0.0.1' - subscribing-application-port: 4024 - notifications-receiving-operation: '/v1/regard-controller-attribute-value-change' - responses: - '204': - description: 'Subscription for notifications about changes of attributes at the controllers created' - 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' - DeviceAlarms: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-010/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: - - subscribing-application-name - - subscribing-application-release - - subscribing-application-protocol - - subscribing-application-address - - subscribing-application-port - - notifications-receiving-operation - properties: - subscribing-application-name: - type: string - description: 'Name of the application that is subscribing for notifications, i.e. MicroWaveDeviceInventory' - subscribing-application-release: - type: string - description: 'Release number of the MicroWaveDeviceInventory' - subscribing-application-protocol: - type: string - enum: - - 'HTTP' - - 'HTTPS' - description: 'Protocol to be used for addressing the MicroWaveDeviceInventory' - subscribing-application-address: - type: object - properties: - ip-address: - type: object - properties: - ipv-4-address: - type: string - description: 'IPv4 address of the MicroWaveDeviceInventory' - domain-name: - type: string - description: 'Domain name of the MicroWaveDeviceInventory' - subscribing-application-port: - type: integer - description: 'Port of the MicroWaveDeviceInventory' - notifications-receiving-operation: - type: string - description: 'Operation for receiving the notifications at MicroWaveDeviceInventory' - example: - subscribing-application-name: 'MicroWaveDeviceInventory' - subscribing-application-release: '1.3.0' - subscribing-application-protocol: 'HTTP' - subscribing-application-address: - ip-address: - ipv-4-address: '127.0.0.1' - subscribing-application-port: 4024 - notifications-receiving-operation: '/v1/regard-device-alarm' - responses: - '204': - description: 'Subscription for notifications about device alarms created' - 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' - DeviceAttributeValueChange: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-010/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: - - subscribing-application-name - - subscribing-application-release - - subscribing-application-protocol - - subscribing-application-address - - subscribing-application-port - - notifications-receiving-operation - properties: - subscribing-application-name: - type: string - description: 'Name of the application that is subscribing for notifications, i.e. MicroWaveDeviceInventory' - subscribing-application-release: - type: string - description: 'Release number of the MicroWaveDeviceInventory' - subscribing-application-protocol: - type: string - enum: - - 'HTTP' - - 'HTTPS' - description: 'Protocol to be used for addressing the MicroWaveDeviceInventory' - subscribing-application-address: - type: object - properties: - ip-address: - type: object - properties: - ipv-4-address: - type: string - description: 'IPv4 address of the MicroWaveDeviceInventory' - domain-name: - type: string - description: 'Domain name of the MicroWaveDeviceInventory' - subscribing-application-port: - type: integer - description: 'Port of the MicroWaveDeviceInventory' - notifications-receiving-operation: - type: string - description: 'Operation for receiving the notifications at MicroWaveDeviceInventory' - example: - subscribing-application-name: 'MicroWaveDeviceInventory' - subscribing-application-release: '1.3.0' - subscribing-application-protocol: 'HTTP' - subscribing-application-address: - ip-address: - ipv-4-address: '127.0.0.1' - subscribing-application-port: 4024 - notifications-receiving-operation: '/v1/regard-device-attribute-value-change' - responses: - '204': - description: 'Subscription for notifications about device attribute value changes created' - 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' - DeviceObjectCreations: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-012/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: - - subscribing-application-name - - subscribing-application-release - - subscribing-application-protocol - - subscribing-application-address - - subscribing-application-port - - notifications-receiving-operation - properties: - subscribing-application-name: - type: string - description: 'Name of the application that is subscribing for notifications, i.e. MicroWaveDeviceInventory' - subscribing-application-release: - type: string - description: 'Release number of the MicroWaveDeviceInventory' - subscribing-application-protocol: - type: string - enum: - - 'HTTP' - - 'HTTPS' - description: 'Protocol to be used for addressing the MicroWaveDeviceInventory' - subscribing-application-address: - type: object - properties: - ip-address: - type: object - properties: - ipv-4-address: - type: string - description: 'IPv4 address of the MicroWaveDeviceInventory' - domain-name: - type: string - description: 'Domain name of the MicroWaveDeviceInventory' - subscribing-application-port: - type: integer - description: 'Port of the MicroWaveDeviceInventory' - notifications-receiving-operation: - type: string - description: 'Operation for receiving the notifications at MicroWaveDeviceInventory' - example: - subscribing-application-name: 'MicroWaveDeviceInventory' - subscribing-application-release: '1.3.0' - subscribing-application-protocol: 'HTTP' - subscribing-application-address: - ip-address: - ipv-4-address: '127.0.0.1' - subscribing-application-port: 4024 - notifications-receiving-operation: '/v1/regard-device-object-creations' - responses: - '204': - description: 'Subscription for notifications about device object creations created' - 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' - DeviceObjectDeletions: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-tcp-c-np-1-0-2-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=mwdi-1-3-0-op-c-is-np-1-0-2-013/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: - - subscribing-application-name - - subscribing-application-release - - subscribing-application-protocol - - subscribing-application-address - - subscribing-application-port - - notifications-receiving-operation - properties: - subscribing-application-name: - type: string - description: 'Name of the application that is subscribing for notifications, i.e. MicroWaveDeviceInventory' - subscribing-application-release: - type: string - description: 'Release number of the MicroWaveDeviceInventory' - subscribing-application-protocol: - type: string - enum: - - 'HTTP' - - 'HTTPS' - description: 'Protocol to be used for addressing the MicroWaveDeviceInventory' - subscribing-application-address: - type: object - properties: - ip-address: - type: object - properties: - ipv-4-address: - type: string - description: 'IPv4 address of the MicroWaveDeviceInventory' - domain-name: - type: string - description: 'Domain name of the MicroWaveDeviceInventory' - subscribing-application-port: - type: integer - description: 'Port of the MicroWaveDeviceInventory' - notifications-receiving-operation: - type: string - description: 'Operation for receiving the notifications at MicroWaveDeviceInventory' - example: - subscribing-application-name: 'MicroWaveDeviceInventory' - subscribing-application-release: '1.3.0' - subscribing-application-protocol: 'HTTP' - subscribing-application-address: - ip-address: - ipv-4-address: '127.0.0.1' - subscribing-application-port: 4024 - notifications-receiving-operation: '/v1/regard-device-object-deletions' - responses: - '204': - description: 'Subscription for notifications about device object deletions created' - 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: diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1020_NotificationBasedDeviceListSyncAdd.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1020_NotificationBasedDeviceListSyncAdd.plantuml deleted file mode 100644 index 142cef44..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1020_NotificationBasedDeviceListSyncAdd.plantuml +++ /dev/null @@ -1,36 +0,0 @@ -@startuml -1020_NotificationBasedDeviceListSyncAdd -skinparam responseMessageBelowArrow true - -title - NotifiedNewDeviceCausesSelfCallingForLoadingOfControlConstruct - NotifiedNewDeviceCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-controller-attribute-value-changes" as subscription -participant "MWDI://v1/regard-controller-attribute-value-change" as regardNewDevice -participant "MWDI://core-model-1-4:network-control-domain=live/control-construct={mountName}" as liveControlConstruct -participant "ElasticSearch\n(metadataTable)" as es - -subscription -> regardNewDevice: AttributeValueChangedNotification (apiKeyAuth) -activate regardNewDevice - -note over regardNewDevice -IF attribute-name == 'connection-status' -AND IF new-value == 'connected' -end note - -regardNewDevice -> liveControlConstruct: {path = first part of resource incl. control-construct} (apiKeyAuth) - -note over regardNewDevice - UpdateMetadataTable - Either add the device to the metadataTable, - if it is not included yet, or update the existing - entry. - (see description under spec/additionalDescription/ - MetadataTableUpdateProcess.md) -end note -regardNewDevice -> es: {mountName from notification} - -deactivate regardNewDevice - -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1021_NotificationBasedDeviceListSyncDelete.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1021_NotificationBasedDeviceListSyncDelete.plantuml deleted file mode 100644 index cf9ec8d3..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1021_NotificationBasedDeviceListSyncDelete.plantuml +++ /dev/null @@ -1,35 +0,0 @@ -@startuml -1021_NotificationBasedDeviceListSyncDelete -skinparam responseMessageBelowArrow true - -title - NotifiedDisconnectedDeviceCausesDeviceDeletionFromCache - NotifiedDisconnectedDeviceCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-controller-attribute-value-changes" as subscription -participant "MWDI://v1/regard-controller-attribute-value-change" as regardDisconnectedDevice -participant "ElasticSearch://control-construct={mountName}" as es -participant "ElasticSearch\n(metadataTable)" as es - -subscription -> regardDisconnectedDevice: notification {mount-name} (apiKeyAuth) -activate regardDisconnectedDevice - -note over regardDisconnectedDevice -IF attribute-name == 'connection-status' -AND IF new-value != 'connected' -end note - -regardDisconnectedDevice -> es: delete {mount-name = value behind control-construct= in resource} - - -note over regardDisconnectedDevice - UpdateMetadataTable - Update the device record according to the description in - spec/additionalDescription/MetadataTableUpdateProcess.md. -end note -regardDisconnectedDevice -> es: {mountName from notification} - - -deactivate regardDisconnectedDevice - -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1022_NotificationBasedAlarmListUpdate.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1022_NotificationBasedAlarmListUpdate.plantuml deleted file mode 100644 index 26a6c832..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1022_NotificationBasedAlarmListUpdate.plantuml +++ /dev/null @@ -1,69 +0,0 @@ -@startuml -1022_NotificationBasedAlarmListUpdate - -skinparam responseMessageBelowArrow true - -title - NotifiedDeviceAlarmCausesUpdatingTheEntryInCurrentAlarmListOfCache - NotifiedDeviceAlarmCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-device-alarms" as subscription -participant "MWDI://v1/regard-device-alarm" as regardAlarm -participant "ElasticSearch://control-construct={mountName}/alarms-1-0:alarm-pac/current-alarms" as CurrentAlarms -participant "ElasticSearch\n(metadataTable)" as es - -subscription -> regardAlarm: {counter, timestamp, resource, alarm-type-id, alarm-type-qualifier, severity} (apiKeyAuth) -activate regardAlarm - -regardAlarm -> CurrentAlarms: GET {mount-name = value behind control-construct= in resource} -CurrentAlarms --> regardAlarm: {currentAlarmList, numberOfCurrentAlarms, timeOfLatestChange} - -note over regardAlarm -Entry in CurrentAlarmList is identified by 3 key attribute values: -1. alarm-type-id -2. alarm-type-qualifier -3. resource -It might make sense to read the entire list, search for the notified entry, change the list and write it back to cache - -IF request.body.problem-severity != CLEARED: -- currentAlarmList to be complemented by content of AlarmNotification -- numberOfCurrentAlarms++ -- timeOfLatestChange=request.body.timestamp - -IF request.body.problem-severity == CLEARED: -- content of Alarmnotification to be removed from currentAlarmList -- numberOfCurrentAlarms-- -- timeOfLatestChange=request.body.timestamp -end note - -regardAlarm -> CurrentAlarms: PUT {currentAlarmList, numberOfCurrentAlarms, timeOfLatestChange} - -note over regardAlarm - UpdateMetadataTable - Upon update completion of the CC data in the cache, - update the metadata table for the device - (last-control-construct-notification-update-time, - number-of-partial-updates-since-last-complete-update) -end note -regardAlarm -> es: {mount-name} - -deactivate regardAlarm - -note over CurrentAlarms -Remark 1: -MWDI://v1/regard-device-alarm -initiates ObjectCreationNotifications and ObjectDeletionNotifications, -but no AlarmNotifications -at MWDI NBI -end note - -note over CurrentAlarms -Remark 2: -There would be an alternative way. -Instead of loading the list of current alarms from cache, updating it, and writing it back into the cache, -self-calling of MWDI://core-model-1-4:network-control-domain=live/control-construct={mountName}/alarms-1-0:alarm-pac/current-alarms would lead to the same result. -The latter way would be slower, but probably compensate missed alarm notifications. -The implementer to comment on the preferred way. -end note - -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1023_NotificationBasedAttributeUpdate.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1023_NotificationBasedAttributeUpdate.plantuml deleted file mode 100644 index 7683602b..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1023_NotificationBasedAttributeUpdate.plantuml +++ /dev/null @@ -1,46 +0,0 @@ -@startuml -1023_NotificationBasedAttributeUpdate -skinparam responseMessageBelowArrow true - -title - NotifiedDeviceAttributeValueChangeCausesUpdateOfCache - NotifiedDeviceAttributeValueChangeCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-device-attribute-value-changes" as subscription -participant "MWDI://v1/regard-device-attribute-value-change" as regardAttributeChange -participant "ElasticSearch://{resource}" as es -participant "ElasticSearch\n(metadataTable)" as mtab - -subscription -> regardAttributeChange: {counter, timestamp, resource, attributeName, newValue} (apiKeyAuth) -activate regardAttributeChange - -regardAttributeChange -> es: GET -es --> regardAttributeChange: class - -note over regardAttributeChange -Value of the {attributeName} attribute to be replaced by {newValue} -end note - -regardAttributeChange -> es: PUT -deactivate regardAttributeChange - -note over regardAttributeChange - UpdateMetadataTable - Upon update completion of the CC data in the cache, - update the metadata table for the device - (last-control-construct-notification-update-time, - number-of-partial-updates-since-last-complete-update) -end note -regardAttributeChange -> es: {mount-name} - - -note over es -Remark: -There would be an alternative way. -Instead of loading the class from cache, updating the changed attribute, and writing the class back into the cache, -self-calling of MWDI://{resource} would lead to the same result. -The latter way would be slower, but probably compensate missed notifications. -The implementer to comment on the preferred way. -end note - -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1024_NotificationBasedObjectCreation.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1024_NotificationBasedObjectCreation.plantuml deleted file mode 100644 index 1bf63a04..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1024_NotificationBasedObjectCreation.plantuml +++ /dev/null @@ -1,29 +0,0 @@ -@startuml -1024_NotificationBasedObjectCreation -skinparam responseMessageBelowArrow true - -title - NotifiedDeviceObjectCreationCausesSelfCallingOfLiveResourcePath - NotifiedDeviceObjectCreationCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-device-object-creations" as subscription -participant "MWDI://v1/regard-device-object-creation" as regardObjectCreation -participant "MWDI://{resource}" as odlCreatedObject -participant "ElasticSearch\n(metadataTable)" as es - -subscription -> regardObjectCreation: {counter, timestamp, resource, objectType} (apiKeyAuth) -activate regardObjectCreation - -regardObjectCreation -> odlCreatedObject: {path = resource potentially shortened to a supported live path} - -note over regardObjectCreation - UpdateMetadataTable - Upon update completion of the CC data in the cache, - update the metadata table for the device - (last-control-construct-notification-update-time, - number-of-partial-updates-since-last-complete-update) -end note -regardObjectCreation -> es: {mount-name} - -deactivate regardObjectCreation -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1026_NotificationBasedObjectDeletion.plantuml b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1026_NotificationBasedObjectDeletion.plantuml deleted file mode 100644 index 67777782..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/deprecated_-1026_NotificationBasedObjectDeletion.plantuml +++ /dev/null @@ -1,31 +0,0 @@ -@startuml -1026_NotificationBasedObjectDeletion -skinparam responseMessageBelowArrow true - -title - NotifiedDeviceObjectDeletionCausesDeletingTheObjectInCache - NotifiedDeviceObjectDeletionCausesMetadataTableUpdate -end title - -participant "NP://v1/notify-device-object-deletions" as subscription -participant "MWDI://v1/regard-device-object-deletion" as regardObjectDeletion -participant "ElasticSearch://{resource}" as es -participant "ElasticSearch\n(metadataTable)" as mtab - -subscription -> regardObjectDeletion: {counter, timestamp, resource} (apiKeyAuth) - -activate regardObjectDeletion - -regardObjectDeletion -> es: delete object {path = resource, but shortened by /core-model-1-4:network-control-domain=live} - -note over regardObjectDeletion - UpdateMetadataTable - Upon update completion of the CC data in the cache, - update the metadata table for the device - (last-control-construct-notification-update-time, - number-of-partial-updates-since-last-complete-update) -end note -regardObjectDeletion -> mtab: {mount-name} - -deactivate regardObjectDeletion - -@enduml \ No newline at end of file diff --git a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/info.txt b/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/info.txt deleted file mode 100644 index 7d37d919..00000000 --- a/spec/diagrams/diagrams_for_deprecated_regard_services_(notifications)/info.txt +++ /dev/null @@ -1,4 +0,0 @@ -The regard-services /v1/regard-* used to receive notifications from NotificationProxy (up to MWDI v1.2.x), -will no longer be used (starting from v1.3.0); instead MWDI will pull notifications from Kafka. - -The old diagrams using regard-services are kept until v2.0.0 (then the deprecated services will be removed). \ No newline at end of file diff --git a/spec/diagrams/01x_MwdiSubscribesAtNp.plantuml b/spec/diagrams/notification_diagrams_before_change/01x_MwdiSubscribesAtNp.plantuml similarity index 100% rename from spec/diagrams/01x_MwdiSubscribesAtNp.plantuml rename to spec/diagrams/notification_diagrams_before_change/01x_MwdiSubscribesAtNp.plantuml diff --git a/spec/diagrams/01x_MwdiSubscribesAtNp.png b/spec/diagrams/notification_diagrams_before_change/01x_MwdiSubscribesAtNp.png similarity index 100% rename from spec/diagrams/01x_MwdiSubscribesAtNp.png rename to spec/diagrams/notification_diagrams_before_change/01x_MwdiSubscribesAtNp.png diff --git a/spec/diagrams/020_NotificationBasedDeviceListSyncAdd.plantuml b/spec/diagrams/notification_diagrams_before_change/020_NotificationBasedDeviceListSyncAdd.plantuml similarity index 100% rename from spec/diagrams/020_NotificationBasedDeviceListSyncAdd.plantuml rename to spec/diagrams/notification_diagrams_before_change/020_NotificationBasedDeviceListSyncAdd.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/020_NotificationBasedDeviceListSyncAdd.png b/spec/diagrams/notification_diagrams_before_change/020_NotificationBasedDeviceListSyncAdd.png new file mode 100644 index 00000000..5b5c0efc Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/020_NotificationBasedDeviceListSyncAdd.png differ diff --git a/spec/diagrams/021_NotificationBasedDeviceListSyncDelete.plantuml b/spec/diagrams/notification_diagrams_before_change/021_NotificationBasedDeviceListSyncDelete.plantuml similarity index 100% rename from spec/diagrams/021_NotificationBasedDeviceListSyncDelete.plantuml rename to spec/diagrams/notification_diagrams_before_change/021_NotificationBasedDeviceListSyncDelete.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/021_NotificationBasedDeviceListSyncDelete.png b/spec/diagrams/notification_diagrams_before_change/021_NotificationBasedDeviceListSyncDelete.png new file mode 100644 index 00000000..93f2324c Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/021_NotificationBasedDeviceListSyncDelete.png differ diff --git a/spec/diagrams/022_NotificationBasedAlarmListUpdate.plantuml b/spec/diagrams/notification_diagrams_before_change/022_NotificationBasedAlarmListUpdate.plantuml similarity index 100% rename from spec/diagrams/022_NotificationBasedAlarmListUpdate.plantuml rename to spec/diagrams/notification_diagrams_before_change/022_NotificationBasedAlarmListUpdate.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/022_NotificationBasedAlarmListUpdate.png b/spec/diagrams/notification_diagrams_before_change/022_NotificationBasedAlarmListUpdate.png new file mode 100644 index 00000000..ab23aba7 Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/022_NotificationBasedAlarmListUpdate.png differ diff --git a/spec/diagrams/023_NotificationBasedAttributeUpdate.plantuml b/spec/diagrams/notification_diagrams_before_change/023_NotificationBasedAttributeUpdate.plantuml similarity index 100% rename from spec/diagrams/023_NotificationBasedAttributeUpdate.plantuml rename to spec/diagrams/notification_diagrams_before_change/023_NotificationBasedAttributeUpdate.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/023_NotificationBasedAttributeUpdate.png b/spec/diagrams/notification_diagrams_before_change/023_NotificationBasedAttributeUpdate.png new file mode 100644 index 00000000..c919d844 Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/023_NotificationBasedAttributeUpdate.png differ diff --git a/spec/diagrams/024_NotificationBasedObjectCreation.plantuml b/spec/diagrams/notification_diagrams_before_change/024_NotificationBasedObjectCreation.plantuml similarity index 100% rename from spec/diagrams/024_NotificationBasedObjectCreation.plantuml rename to spec/diagrams/notification_diagrams_before_change/024_NotificationBasedObjectCreation.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/024_NotificationBasedObjectCreation.png b/spec/diagrams/notification_diagrams_before_change/024_NotificationBasedObjectCreation.png new file mode 100644 index 00000000..e09b4557 Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/024_NotificationBasedObjectCreation.png differ diff --git a/spec/diagrams/026_NotificationBasedObjectDeletion.plantuml b/spec/diagrams/notification_diagrams_before_change/026_NotificationBasedObjectDeletion.plantuml similarity index 100% rename from spec/diagrams/026_NotificationBasedObjectDeletion.plantuml rename to spec/diagrams/notification_diagrams_before_change/026_NotificationBasedObjectDeletion.plantuml diff --git a/spec/diagrams/notification_diagrams_before_change/026_NotificationBasedObjectDeletion.png b/spec/diagrams/notification_diagrams_before_change/026_NotificationBasedObjectDeletion.png new file mode 100644 index 00000000..5aeb83c6 Binary files /dev/null and b/spec/diagrams/notification_diagrams_before_change/026_NotificationBasedObjectDeletion.png differ