Skip to content

(DeviceList) Modify /v1/provide-list-of-connected-devices #1237

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 1 commit into from
May 22, 2025
Merged

(DeviceList) Modify /v1/provide-list-of-connected-devices #1237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion spec/MicroWaveDeviceInventory+config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17338,7 +17338,7 @@
{
"local-id": "2000",
"port-direction": "core-model-1-4:PORT_DIRECTION_TYPE_OUTPUT",
"logical-termination-point": "mwdi-1-3-0-op-c-get-es-1-0-0-000"
"logical-termination-point": "mwdi-1-3-0-es-c-es-1-0-0-000"
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions spec/MicroWaveDeviceInventory+forwardings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1561,8 +1561,8 @@ forwardings:
- server-name: /v1/provide-list-of-connected-devices
uuid: mwdi-1-3-0-op-s-is-010
consequent-requests:
- client-name: ElasticSearch://?fields=control-construct(uuid)
uuid: mwdi-1-3-0-op-c-get-es-1-0-0-000
- client-name: ElasticSearch
uuid: mwdi-1-3-0-es-c-es-1-0-0-000

- forwarding-name: RequestForListOfDeviceInterfacesCausesReadingFromCache
uuid: mwdi-1-3-0-op-fc-is-021
Expand Down
59 changes: 4 additions & 55 deletions spec/MicroWaveDeviceInventory.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1543,8 +1543,9 @@ paths:
items:
type: string
description: >
'MountName of devices in connected state at the Controller
from {$RequestForListOfConnectedDevicesCausesReadingFromCache.response.body#/core-model-1-4:control-construct/uuid}'
'MountName of devices in connected state at the Controller,
list of devices in deviceMetadataList with connection-status==connected
from {$RequestForListOfConnectedDevicesCausesReadingFromCache}'
example:
mount-name-list:
- '305251234'
Expand Down Expand Up @@ -1573,59 +1574,7 @@ paths:
$ref: '#/components/responses/responseForErroredServiceRequests'
default:
$ref: '#/components/responses/responseForErroredServiceRequests'
callbacks:
RequestForListOfConnectedDevicesCausesReadingFromCache:
url: #[/core-model-1-4:control-construct/logical-termination-point=mwdi-1-3-0-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-3-0-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-3-0-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-3-0-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-3-0-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 connected devices provided from cache'
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/provide-list-of-device-interfaces:
parameters:
- $ref: '#/components/parameters/user'
Expand Down
6 changes: 5 additions & 1 deletion spec/diagrams/100_ProvideListOfConnectedDevices.plantuml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@ title RequestForListOfConnectedDevicesCausesReadingFromCache

participant "external" as requestor
participant "MWDI://v1/provide-list-of-connected-devices" as provideListOfConnectedDevices
participant "ElasticSearch://?fields=control-construct(uuid)" as ConnectedDeviceList
participant "ElasticSearch \n(deviceMetadataList)" as ConnectedDeviceList

requestor -> provideListOfConnectedDevices: (apiKeyAuth)
activate provideListOfConnectedDevices

provideListOfConnectedDevices -> ConnectedDeviceList
note over ConnectedDeviceList
filter for devices with
<i>connection-status</i> == connected
end note
ConnectedDeviceList --> provideListOfConnectedDevices: {mount-name-list}

provideListOfConnectedDevices --> requestor: {mount-name-list}
Expand Down
Binary file modified spec/diagrams/100_ProvideListOfConnectedDevices.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.
Loading