Skip to content

Commit e2a608f

Browse files
fix(doc): Fix OpenAPI doc for opal.orchestra node-type
Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com>
1 parent 94d82da commit e2a608f

4 files changed

Lines changed: 21 additions & 8 deletions

File tree

doc/openapi/components/schemas/config/nodes/opal_orchestra_connection.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ type: object
66
description: |
77
Configuration of the connection to the OPAL-RT Orchestra framework.
88
required:
9-
- type
9+
- type
1010
properties:
1111
type:
12+
description: The type of connection to the OPAL-RT Orchestra framework.
1213
type: string
1314
discriminator:
1415
propertyName: type

doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_dolphin.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
---
55
type: object
66
required:
7-
- node_id_framework
8-
- segment_id
7+
- node_id_framework
8+
- segment_id
99
properties:
10+
type:
11+
description: The type of connection to the OPAL-RT Orchestra framework.
12+
type: string
13+
1014
node_id_framework:
1115
type: integer
1216
min: 4

doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_local.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@
44
---
55
type: object
66
properties:
7+
type:
8+
description: The type of connection to the OPAL-RT Orchestra framework.
9+
type: string
10+
711
extcomm:
812
type: string
913
default: none
1014
enum:
11-
- udp
12-
- tcp
13-
- none
15+
- udp
16+
- tcp
17+
- none
1418
description: Type of external communication protocol helper which should be started.
1519

1620
addr_framework:

doc/openapi/components/schemas/config/nodes/opal_orchestra_connection_remote.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44
---
55
type: object
66
required:
7-
- card
8-
- pci_index
7+
- card
8+
- pci_index
99
properties:
10+
type:
11+
description: The type of connection to the OPAL-RT Orchestra framework.
12+
type: string
13+
1014
card:
1115
type: string
1216
example: VMIPCI5565-64M

0 commit comments

Comments
 (0)