1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

Fix OpenAPI docs

This commit is contained in:
Philipp Jungkamp 2022-07-27 12:10:18 +00:00
parent e82a8dde36
commit 2bdf1fae8e
2 changed files with 18 additions and 11 deletions

View file

@ -5,7 +5,7 @@ allOf:
- type: object
properties:
in: unsupported
in:
type: object
properties:
signals:
@ -14,7 +14,8 @@ allOf:
out:
type: object
properties:
duplicate_ioa_is_sequence: Treat consecutive signals with the same IOA as a sequence by assigning subsequent IOAs
duplicate_ioa_is_sequence:
description: Treat consecutive signals with the same IOA as a sequence by assigning subsequent IOAs.
type: boolean
default: false
signals:
@ -23,25 +24,27 @@ allOf:
$ref: ./signals/iec60870_signal.yaml
address:
description: Hostname or IP address for the IEC60870 slave to listen on
description: Hostname or IP address for the IEC60870 slave to listen on.
type: string
default: localhost
port:
description: Port number of the IEC60870 slave
description: Port number of the IEC60870 slave.
type: number
default: 2404
ca:
description: Common Address of the IEC60870 slave
description: Common Address of the IEC60870 slave.
type: number
default: 1
low_priority_queue: Message queue size for the periodic messages (increase on dropped simulation data messages)
low_priority_queue:
description: Message queue size for the periodic messages (increase on dropped simulation data messages).
type: number
default: 100
high_priority_queue: Message queue size for interrogation responses (increase on missing signals in interrogation response)
high_priority_queue:
description: Message queue size for interrogation responses (increase on missing signals in interrogation response).
type: number
default: 100

View file

@ -4,7 +4,8 @@
allOf:
- type: object
properties:
asdu_type: human readable names for the supported IEC60870 message types
asdu_type:
description: Human readable names for the supported IEC60870 message types.
type: string
enum:
- single-point
@ -13,7 +14,8 @@ allOf:
- normalized-float
- short-float
asdu_type_id: the IEC60870 standard type id
asdu_type_id:
descrition: The IEC60870 standard type id.
type: string
enum:
- M_SP_NA_1
@ -27,11 +29,13 @@ allOf:
- M_ME_NC_1
- M_ME_TC_1
with_timestamp: (only for use with the human readable asdu_type)
with_timestamp:
description: (only for use with the human readable asdu_type)
type: boolean
default: false
ioa: The IEC60870 information object address associated with this signal
ioa:
description: The IEC60870 information object address associated with this signal.
type: number
min: 1