Skip to content

Kmohr-soprasteria/issue1287 #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kmohr-soprasteria merged 2 commits into from
Jun 4, 2025
Merged

Kmohr-soprasteria/issue1287 #1291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51b123a
diagram, renamed service, rename callback
kmohr-soprasteria Jun 4, 2025
3a343b2
update service
kmohr-soprasteria Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,823 changes: 0 additions & 3,823 deletions Z_TMP/forwardings from 1.2.2.yaml
View file
Open in desktop

This file was deleted.

33,331 changes: 0 additions & 33,331 deletions Z_TMP/oas_from_1.2.2.yaml
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions spec/MicroWaveDeviceInventory+config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1468,7 +1468,7 @@
"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/provide-list-of-mwdi-devices"
"operation-name": "/v1/provide-list-of-cached-devices"
},
"operation-server-interface-configuration": {
"life-cycle-state": "operation-server-interface-1-0:LIFE_CYCLE_STATE_TYPE_OPERATIONAL",
Expand Down Expand Up @@ -17754,7 +17754,7 @@
},
{
"value-name": "ForwardingName",
"value": "RequestForListOfMwdiDevicesCausesReadingFromCache"
"value": "RequestForListOfCachedDevicesCausesReadingFromCache"
}
],
"fc-port": [
Expand All @@ -17766,7 +17766,7 @@
{
"local-id": "2000",
"port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT",
"logical-termination-point": "mwdi-2-0-0-es-c-es-1-0-0-000"
"logical-termination-point": "mwdi-1-2-2-op-c-get-es-1-0-0-000"
}
]
},
Expand Down
8 changes: 4 additions & 4 deletions spec/MicroWaveDeviceInventory+forwardings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1766,7 +1766,7 @@ forwardings:
- client-name: ElasticSearch://control-construct={mountName}?fields=top-level-equipment;equipment(uuid;actual-equipment(manufactured-thing(equipment-type(type-name))))
uuid: mwdi-2-0-0-op-c-get-es-1-0-0-100

- forwarding-name: RequestForListOfMwdiDevicesCausesReadingFromCache
- forwarding-name: RequestForListOfCachedDevicesCausesReadingFromCache
uuid: mwdi-2-0-0-op-fc-is-023
forwarding-type: InvariantProcessSnippet
management-requests:
Expand All @@ -1775,11 +1775,11 @@ forwardings:
fc-port-deletion:
operation-client-deletion:
initiating-requests:
- server-name: /v1/provide-list-of-mwdi-devices
- server-name: /v1/provide-list-of-cached-devices
uuid: mwdi-2-0-0-op-s-is-010
consequent-requests:
- client-name: ElasticSearch
uuid: mwdi-2-0-0-es-c-es-1-0-0-000
- client-name: ElasticSearch://?fields=control-construct(uuid)
uuid: mwdi-1-2-2-op-c-get-es-1-0-0-000

- forwarding-name: RequestForListOfParallelLinksCauses.ReadingEndpointsFromCache
uuid: mwdi-2-0-0-op-fc-is-030
Expand Down
2 changes: 1 addition & 1 deletion spec/MicroWaveDeviceInventory+services.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ servers:
- operation-name: /v1/provide-cache-quality-statistics
uuid: mwdi-2-0-0-op-s-is-019
operation-key: n.a.
- operation-name: /v1/provide-list-of-mwdi-devices
- operation-name: /v1/provide-list-of-cached-devices
uuid: mwdi-2-0-0-op-s-is-020
operation-key: n.a.

Expand Down
82 changes: 61 additions & 21 deletions spec/MicroWaveDeviceInventory.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2763,23 +2763,23 @@ paths:
$ref: '#/components/responses/responseForErroredServiceRequests'
default:
$ref: '#/components/responses/responseForErroredServiceRequests'
/v1/provide-list-of-mwdi-devices:
/v1/provide-list-of-cached-devices:
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: provideListOfMwdiDevices
summary: 'Provides list of devices that are found in MWDI deviceMetadataList'
operationId: provideListOfCachedDevices
summary: 'Provides list of devices for which MWDI has a ControlConstruct in its cache'
tags:
- IndividualServices
security:
- apiKeyAuth: []
responses:
'200':
description: 'List of mwdi devices provided'
description: 'List of cached devices provided'
content:
application/json:
schema:
Expand All @@ -2795,23 +2795,12 @@ paths:
mount-name:
type: string
description: >
'MountName of the device in deviceMetadataList
from {$RequestForListOfMwdiDevicesCausesReadingFromCache}'
connection-status:
type: string
enum:
- 'connected'
- 'connecting'
- 'unable-to-connect'
description: >
'Connection-status of the device in deviceMetadataList
from {$RequestForListOfMwdiDevicesCausesReadingFromCache}'
'MountName of the device for which MWDI has a cached ControlConstruct
from {$RequestForListOfCachedDevicesCausesReadingFromCache}'
example:
mount-name-list:
- mount-name: '305251234'
connection-status: 'connected'
- mount-name: '105258888'
connection-status: 'connecting'
- '305251234'
- '105258888'
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
Expand All @@ -2836,8 +2825,59 @@ paths:
$ref: '#/components/responses/responseForErroredServiceRequests'
default:
$ref: '#/components/responses/responseForErroredServiceRequests'


callbacks:
RequestForListOfCachedDevicesCausesReadingFromCache:
url: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-2-2-tcp-c-es-1-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=mwdi-1-2-2-tcp-c-es-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=mwdi-1-2-2-tcp-c-es-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=mwdi-1-2-2-tcp-c-es-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=mwdi-1-2-2-op-c-get-es-1-0-0-000/layer-protocol=0/operation-client-interface-1-0:operation-client-interface-pac/operation-client-interface-configuration/operation-name]
get:
parameters:
- name: fields
in: query
required: true
schema:
type: string
enum:
- 'control-construct(uuid)'
responses:
'200':
description: 'List of devices with cached ControlConstructs provided'
content:
application/json:
schema:
type: object
required:
- /
properties:
/:
type: object
required:
- core-model-1-4:control-construct
properties:
core-model-1-4:control-construct:
type: array
items:
type: object
required:
- uuid
properties:
uuid:
type: string
example:
/:
core-model-1-4:control-construct:
- uuid: '305251234'
- uuid: '105258888'
'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/notify-attribute-value-changes:
parameters:
- $ref: '#/components/parameters/user'
Expand Down
22 changes: 22 additions & 0 deletions spec/diagrams/110_ProvideListOfCachedDevices.plantuml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
@startuml 110_ProvideListOfCachedDevices
skinparam responseMessageBelowArrow true

title RequestForListOfCachedDevicesCausesReadingFromCache

participant "external" as requestor
participant "MWDI://v1/provide-list-of-cached-devices" as mwdi
participant "ElasticSearch://?fields=control-construct(uuid)" as cache

requestor -> mwdi: (apiKeyAuth)
activate mwdi

mwdi -> cache
cache --> mwdi: {mount-name-list}

mwdi --> requestor: {mount-name-list}
deactivate mwdi

@enduml



Binary file added spec/diagrams/110_ProvideListOfCachedDevices.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 0 additions & 19 deletions spec/diagrams/110_ProvideListOfMwdiDevices.plantuml
View file
Open in desktop

This file was deleted.

Binary file removed spec/diagrams/110_ProvideListOfMwdiDevices.png
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion spec/diagrams/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
![RequestForCacheQualityStatisticsCausesReadingFromElasticSearch](./109_ProvideCacheQualityStatistics.png)
.
.
![RequestForListOfMwdiDevicesCausesReadingFromCache](./110_ProvideListOfMwdiDevices.png)
![RequestForListOfCachedDevicesCausesReadingFromCache](./110_ProvideListOfCachedDevices.png)
.
.
![SubscribingAtMwdiForDeviceAttributeChangesCausesSendingNotifications](./140_MwdiNotifiesAttributeChange.png)
Expand Down
Loading