From e2a608f52cd8181ea971cb5e9321efb00b76d9ff Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Thu, 6 Nov 2025 15:15:16 +0100 Subject: [PATCH] fix(doc): Fix OpenAPI doc for opal.orchestra node-type Signed-off-by: Steffen Vogel --- .../config/nodes/opal_orchestra_connection.yaml | 3 ++- .../nodes/opal_orchestra_connection_dolphin.yaml | 8 ++++++-- .../config/nodes/opal_orchestra_connection_local.yaml | 10 +++++++--- .../config/nodes/opal_orchestra_connection_remote.yaml | 8 ++++++-- 4 files changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection.yaml b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection.yaml index f27b2b9f8..ac85a49a4 100644 --- a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection.yaml +++ b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection.yaml @@ -6,9 +6,10 @@ type: object description: | Configuration of the connection to the OPAL-RT Orchestra framework. required: -- type + - type properties: type: + description: The type of connection to the OPAL-RT Orchestra framework. type: string discriminator: propertyName: type diff --git a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_dolphin.yaml b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_dolphin.yaml index 18582a276..c9c7cebe2 100644 --- a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_dolphin.yaml +++ b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_dolphin.yaml @@ -4,9 +4,13 @@ --- type: object required: -- node_id_framework -- segment_id + - node_id_framework + - segment_id properties: + type: + description: The type of connection to the OPAL-RT Orchestra framework. + type: string + node_id_framework: type: integer min: 4 diff --git a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_local.yaml b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_local.yaml index 824d98c81..5d4a1da0d 100644 --- a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_local.yaml +++ b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_local.yaml @@ -4,13 +4,17 @@ --- type: object properties: + type: + description: The type of connection to the OPAL-RT Orchestra framework. + type: string + extcomm: type: string default: none enum: - - udp - - tcp - - none + - udp + - tcp + - none description: Type of external communication protocol helper which should be started. addr_framework: diff --git a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_remote.yaml b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_remote.yaml index 0a4487a4a..c0978ea23 100644 --- a/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_remote.yaml +++ b/doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_remote.yaml @@ -4,9 +4,13 @@ --- type: object required: -- card -- pci_index + - card + - pci_index properties: + type: + description: The type of connection to the OPAL-RT Orchestra framework. + type: string + card: type: string example: VMIPCI5565-64M