diff --git a/doc/openapi/components/schemas/config.yaml b/doc/openapi/components/schemas/config.yaml index f79ccb389..6c0299399 100644 --- a/doc/openapi/components/schemas/config.yaml +++ b/doc/openapi/components/schemas/config.yaml @@ -37,4 +37,4 @@ allOf: logging: $ref: config/logging.yaml -- $ref: config/global.yaml +- $ref: config/global.yaml diff --git a/doc/openapi/components/schemas/config/format.yaml b/doc/openapi/components/schemas/config/format.yaml index 85ba3fc4c..90ad2a2f6 100644 --- a/doc/openapi/components/schemas/config/format.yaml +++ b/doc/openapi/components/schemas/config/format.yaml @@ -3,7 +3,7 @@ # SPDX-License-Identifier: Apache-2.0 --- type: object -properties: +properties: real_precision: type: integer @@ -12,7 +12,7 @@ properties: Output all real numbers with at most n digits of precision. The valid range for this setting is between 0 and 31 (inclusive), and other values result in an undefined behavior. By default, the precision is 17, to correctly and losslessly encode all IEEE 754 double precision floating point numbers. - + ts_origin: type: boolean default: true diff --git a/doc/openapi/components/schemas/config/formats/json.yaml b/doc/openapi/components/schemas/config/formats/json.yaml index 0603c0f03..613cad40b 100644 --- a/doc/openapi/components/schemas/config/formats/json.yaml +++ b/doc/openapi/components/schemas/config/formats/json.yaml @@ -26,7 +26,7 @@ allOf: description: | If this flag is used, the output is guaranteed to consist only of ASCII characters. This is achieved by escaping all Unicode characters outside the ASCII range. - + sort_keys: type: boolean default: false @@ -37,7 +37,7 @@ allOf: escape_slash: type: boolean default: false - description: + description: Escape the `/` characters in strings with `\/`. - $ref: ../format.yaml diff --git a/doc/openapi/components/schemas/config/global.yaml b/doc/openapi/components/schemas/config/global.yaml index 8195462cf..96673a5b8 100644 --- a/doc/openapi/components/schemas/config/global.yaml +++ b/doc/openapi/components/schemas/config/global.yaml @@ -14,7 +14,7 @@ properties: The number of hugepages which will be reservered by the system. See: https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt - + A value of zero will disable the use of huge pages. stats: @@ -25,9 +25,9 @@ properties: Specifies the rate at which statistics about the active paths will be periodically printed to the screen. Setting this value to 5, will print 5 lines per second. - + A line includes information such as: - + - Source and Destination of path - Messages received - Messages sent @@ -65,6 +65,6 @@ properties: Each VILLASnode instance is identified by a globally unique indentifier / UUID. This UUID can be queried by the API. - + If the setting is not provided, a UUID will be generated by hashing the active VILLASnode configuration. This ensures that restarting the VILLASnode instance with the identical configuration will yield always the same UUID. diff --git a/doc/openapi/components/schemas/config/hook.yaml b/doc/openapi/components/schemas/config/hook.yaml index f6014aefa..2579fa158 100644 --- a/doc/openapi/components/schemas/config/hook.yaml +++ b/doc/openapi/components/schemas/config/hook.yaml @@ -8,7 +8,7 @@ properties: type: boolean default: true description: An optional field which can be used to disable a hook. - + priority: type: integer default: 99 diff --git a/doc/openapi/components/schemas/config/hook_multi.yaml b/doc/openapi/components/schemas/config/hook_multi.yaml index 983db59fe..4fdd258b4 100644 --- a/doc/openapi/components/schemas/config/hook_multi.yaml +++ b/doc/openapi/components/schemas/config/hook_multi.yaml @@ -8,7 +8,7 @@ allOf: signals: type: array description: A list of signal names to which this hook should be applied - example: + example: - busA.V - busB.V - busC.V diff --git a/doc/openapi/components/schemas/config/hooks/_rms.yaml b/doc/openapi/components/schemas/config/hooks/_rms.yaml index 5da6ec15b..7d55c37d1 100644 --- a/doc/openapi/components/schemas/config/hooks/_rms.yaml +++ b/doc/openapi/components/schemas/config/hooks/_rms.yaml @@ -8,7 +8,7 @@ allOf: - type: object required: - window_size - properties: + properties: window_size: type: integer min: 1 diff --git a/doc/openapi/components/schemas/config/hooks/cast.yaml b/doc/openapi/components/schemas/config/hooks/cast.yaml index 38af5fad2..176092ac4 100644 --- a/doc/openapi/components/schemas/config/hooks/cast.yaml +++ b/doc/openapi/components/schemas/config/hooks/cast.yaml @@ -16,7 +16,7 @@ allOf: example: integer new_name: type: string - description: The new name of the casted signal. + description: The new name of the casted signal. example: BusA.V new_unit: type: string diff --git a/doc/openapi/components/schemas/config/hooks/ebm.yaml b/doc/openapi/components/schemas/config/hooks/ebm.yaml index 9dedcbca0..e39cfa1df 100644 --- a/doc/openapi/components/schemas/config/hooks/ebm.yaml +++ b/doc/openapi/components/schemas/config/hooks/ebm.yaml @@ -6,7 +6,7 @@ allOf: - type: object required: - phases - properties: + properties: phases: description: Signal indices for voltage & current values for each phase. example: diff --git a/doc/openapi/components/schemas/config/hooks/gate.yaml b/doc/openapi/components/schemas/config/hooks/gate.yaml index 49b6af027..bb5c54315 100644 --- a/doc/openapi/components/schemas/config/hooks/gate.yaml +++ b/doc/openapi/components/schemas/config/hooks/gate.yaml @@ -4,7 +4,7 @@ --- allOf: - type: object - properties: + properties: mode: description: The triggering condition at which the gate opens. type: string diff --git a/doc/openapi/components/schemas/config/hooks/limit_value.yaml b/doc/openapi/components/schemas/config/hooks/limit_value.yaml index de89d1448..53a447175 100644 --- a/doc/openapi/components/schemas/config/hooks/limit_value.yaml +++ b/doc/openapi/components/schemas/config/hooks/limit_value.yaml @@ -7,7 +7,7 @@ allOf: required: - min - max - properties: + properties: min: description: The smallest value which will pass through the hook before getting clipped. type: number diff --git a/doc/openapi/components/schemas/config/hooks/lua.yaml b/doc/openapi/components/schemas/config/hooks/lua.yaml index a6abb38c2..168fb6c2b 100644 --- a/doc/openapi/components/schemas/config/hooks/lua.yaml +++ b/doc/openapi/components/schemas/config/hooks/lua.yaml @@ -9,7 +9,7 @@ allOf: The Lua hook will pass the complete hook configuration to the `prepare()` Lua function. So you can add arbitrary settings here which are then consumed by the Lua script. - properties: + properties: use_names: type: boolean default: true @@ -50,7 +50,7 @@ allOf: |:-- |:-- | | 0 | seconds | | 1 | nanoseconds | - + - `ts_received` The receive timestamp a Lua table containing the following keys: | Index | Description | |:-- |:-- | @@ -71,7 +71,7 @@ allOf: items: allOf: - type: object - properties: + properties: expression: type: string example: "math.sqrt(smp.data[0] ^ 2 + smp.data[1] ^ 2)" diff --git a/doc/openapi/components/schemas/config/hooks/pmu_dft.yaml b/doc/openapi/components/schemas/config/hooks/pmu_dft.yaml index c86e7d1c3..21424cf03 100644 --- a/doc/openapi/components/schemas/config/hooks/pmu_dft.yaml +++ b/doc/openapi/components/schemas/config/hooks/pmu_dft.yaml @@ -10,7 +10,7 @@ allOf: - end_frequency - frequency_resolution - dft_rate - properties: + properties: sample_rate: type: integer default: 0 diff --git a/doc/openapi/components/schemas/config/hooks/pps_ts.yaml b/doc/openapi/components/schemas/config/hooks/pps_ts.yaml index 17899eb56..5fb82e231 100644 --- a/doc/openapi/components/schemas/config/hooks/pps_ts.yaml +++ b/doc/openapi/components/schemas/config/hooks/pps_ts.yaml @@ -6,7 +6,7 @@ allOf: - type: object required: - expected_smp_rate - properties: + properties: mode: type: string enum: diff --git a/doc/openapi/components/schemas/config/hooks/print.yaml b/doc/openapi/components/schemas/config/hooks/print.yaml index de90bc800..53f2af846 100644 --- a/doc/openapi/components/schemas/config/hooks/print.yaml +++ b/doc/openapi/components/schemas/config/hooks/print.yaml @@ -15,5 +15,5 @@ allOf: type: string default: '' description: An optional prefix which will be prepended to each line written by this hook to the output - + - $ref: ../hook.yaml diff --git a/doc/openapi/components/schemas/config/hooks/round.yaml b/doc/openapi/components/schemas/config/hooks/round.yaml index 9822f8b19..70f0fb40f 100644 --- a/doc/openapi/components/schemas/config/hooks/round.yaml +++ b/doc/openapi/components/schemas/config/hooks/round.yaml @@ -4,7 +4,7 @@ --- allOf: - type: object - properties: + properties: precision: type: integer default: 0 diff --git a/doc/openapi/components/schemas/config/hooks/scale.yaml b/doc/openapi/components/schemas/config/hooks/scale.yaml index 1349048f2..bb9e9ffbe 100644 --- a/doc/openapi/components/schemas/config/hooks/scale.yaml +++ b/doc/openapi/components/schemas/config/hooks/scale.yaml @@ -4,7 +4,7 @@ --- allOf: - type: object - properties: + properties: offset: type: number default: 0.0 diff --git a/doc/openapi/components/schemas/config/hooks/shift_seq.yaml b/doc/openapi/components/schemas/config/hooks/shift_seq.yaml index 8ec50b6d8..88e63c8fe 100644 --- a/doc/openapi/components/schemas/config/hooks/shift_seq.yaml +++ b/doc/openapi/components/schemas/config/hooks/shift_seq.yaml @@ -6,7 +6,7 @@ allOf: - type: object required: - offset - properties: + properties: offset: type: integer description: The offset which is added to the sequence number of each processed sample. diff --git a/doc/openapi/components/schemas/config/hooks/skip_first.yaml b/doc/openapi/components/schemas/config/hooks/skip_first.yaml index 58046aa64..db26d1a9a 100644 --- a/doc/openapi/components/schemas/config/hooks/skip_first.yaml +++ b/doc/openapi/components/schemas/config/hooks/skip_first.yaml @@ -4,7 +4,7 @@ --- allOf: - type: object - properties: + properties: samples: type: integer description: The number of samples which should be dropped by this hook after a start or restart of the node/path. diff --git a/doc/openapi/components/schemas/config/hooks/stats.yaml b/doc/openapi/components/schemas/config/hooks/stats.yaml index 43911fe98..9cf3765be 100644 --- a/doc/openapi/components/schemas/config/hooks/stats.yaml +++ b/doc/openapi/components/schemas/config/hooks/stats.yaml @@ -4,7 +4,7 @@ --- allOf: - type: object - properties: + properties: format: $ref: ../format_spec.yaml buckets: diff --git a/doc/openapi/components/schemas/config/logging.yaml b/doc/openapi/components/schemas/config/logging.yaml index d82471689..2d948b5bc 100644 --- a/doc/openapi/components/schemas/config/logging.yaml +++ b/doc/openapi/components/schemas/config/logging.yaml @@ -50,7 +50,7 @@ properties: required: - name - level - properties: + properties: name: type: string title: Logger name filter diff --git a/doc/openapi/components/schemas/config/netem.yaml b/doc/openapi/components/schemas/config/netem.yaml index 1ce51addb..fe33abedc 100644 --- a/doc/openapi/components/schemas/config/netem.yaml +++ b/doc/openapi/components/schemas/config/netem.yaml @@ -16,7 +16,7 @@ properties: enabled: type: boolean default: true - + delay: type: number default: 0 diff --git a/doc/openapi/components/schemas/config/node.yaml b/doc/openapi/components/schemas/config/node.yaml index fc6c6bf64..d62e75182 100644 --- a/doc/openapi/components/schemas/config/node.yaml +++ b/doc/openapi/components/schemas/config/node.yaml @@ -12,7 +12,7 @@ properties: description: | This setting allows to send multiple samples in a single message to the destination nodes. - The value of this setting determines how many samples will be combined into one packet. + The value of this setting determines how many samples will be combined into one packet. hooks: $ref: hook_list.yaml diff --git a/doc/openapi/components/schemas/config/node_signals.yaml b/doc/openapi/components/schemas/config/node_signals.yaml index a594cec8a..7730aa872 100644 --- a/doc/openapi/components/schemas/config/node_signals.yaml +++ b/doc/openapi/components/schemas/config/node_signals.yaml @@ -3,9 +3,9 @@ # SPDX-License-Identifier: Apache-2.0 --- type: object -properties: +properties: in: type: object - properties: + properties: signals: $ref: ./signal_list.yaml diff --git a/doc/openapi/components/schemas/config/nodes/amqp.yaml b/doc/openapi/components/schemas/config/nodes/amqp.yaml index 396a2ec8c..b05d9a365 100644 --- a/doc/openapi/components/schemas/config/nodes/amqp.yaml +++ b/doc/openapi/components/schemas/config/nodes/amqp.yaml @@ -30,7 +30,7 @@ allOf: Note: These settings are only used if the `uri` setting is using the `amqps://` schema. type: object - properties: + properties: verify_hostname: default: true, diff --git a/doc/openapi/components/schemas/config/nodes/exec.yaml b/doc/openapi/components/schemas/config/nodes/exec.yaml index ac3bcf143..8e6198308 100644 --- a/doc/openapi/components/schemas/config/nodes/exec.yaml +++ b/doc/openapi/components/schemas/config/nodes/exec.yaml @@ -23,7 +23,7 @@ allOf: The program which should be executed in the sub-process. The option is passed to the system shell for execution. - + oneOf: - type: array items: diff --git a/doc/openapi/components/schemas/config/nodes/file.yaml b/doc/openapi/components/schemas/config/nodes/file.yaml index 187efcbf1..463c6dd17 100644 --- a/doc/openapi/components/schemas/config/nodes/file.yaml +++ b/doc/openapi/components/schemas/config/nodes/file.yaml @@ -31,7 +31,7 @@ allOf: in: type: object - properties: + properties: epoch: type: number @@ -108,7 +108,7 @@ allOf: description: | With this setting enabled, the outgoing file is flushed whenever new samples have been written to it. - buffer_size: + buffer_size: type: integer default: 0 min: 0 diff --git a/doc/openapi/components/schemas/config/nodes/iec61850-9-2.yaml b/doc/openapi/components/schemas/config/nodes/iec61850-9-2.yaml index fa6a64d5c..8ed2b0f11 100644 --- a/doc/openapi/components/schemas/config/nodes/iec61850-9-2.yaml +++ b/doc/openapi/components/schemas/config/nodes/iec61850-9-2.yaml @@ -25,7 +25,7 @@ allOf: type: array items: $ref: ./signals/iec61850_signal.yaml - + svid: type: string diff --git a/doc/openapi/components/schemas/config/nodes/kafka.yaml b/doc/openapi/components/schemas/config/nodes/kafka.yaml index e98fb4f32..a86024f8f 100644 --- a/doc/openapi/components/schemas/config/nodes/kafka.yaml +++ b/doc/openapi/components/schemas/config/nodes/kafka.yaml @@ -70,7 +70,7 @@ allOf: produce: type: string description: The Kafka topic to which this node-type will publish messages. - + timeout: type: number description: A timeout in seconds for the broker connection. diff --git a/doc/openapi/components/schemas/config/nodes/loopback.yaml b/doc/openapi/components/schemas/config/nodes/loopback.yaml index 70e76fb55..35d629ebb 100644 --- a/doc/openapi/components/schemas/config/nodes/loopback.yaml +++ b/doc/openapi/components/schemas/config/nodes/loopback.yaml @@ -5,7 +5,7 @@ allOf: - type: object properties: - + queuelen: type: integer min: 0 diff --git a/doc/openapi/components/schemas/config/nodes/mqtt.yaml b/doc/openapi/components/schemas/config/nodes/mqtt.yaml index d2cc3a6b8..b96b0387c 100644 --- a/doc/openapi/components/schemas/config/nodes/mqtt.yaml +++ b/doc/openapi/components/schemas/config/nodes/mqtt.yaml @@ -12,14 +12,14 @@ allOf: in: type: object - properties: + properties: subscribe: type: string description: Topic to which this node subscribes. out: type: object - properties: + properties: publish: type: string description: Topic to which this node publishes. @@ -59,7 +59,7 @@ allOf: ssl: type: object - properties: + properties: enabled: type: boolean @@ -92,9 +92,9 @@ allOf: type: boolean default: true description: | - Configure verification of the server hostname in the server certificate. + Configure verification of the server hostname in the server certificate. If value is set to true, it is impossible to guarantee that the host you are connecting to is not impersonating your server. - This can be useful in initial server testing, but makes it possible for a malicious third party to impersonate your server through DNS spoofing, for example. + This can be useful in initial server testing, but makes it possible for a malicious third party to impersonate your server through DNS spoofing, for example. Do not use this function in a real system. Setting value to true makes the connection encryption pointless. diff --git a/doc/openapi/components/schemas/config/nodes/ngsi.yaml b/doc/openapi/components/schemas/config/nodes/ngsi.yaml index d6db7fc49..76a986df7 100644 --- a/doc/openapi/components/schemas/config/nodes/ngsi.yaml +++ b/doc/openapi/components/schemas/config/nodes/ngsi.yaml @@ -10,7 +10,7 @@ allOf: endpoint: type: string format: uri - + entity_id: type: string description: ID of NGSI entity. diff --git a/doc/openapi/components/schemas/config/nodes/opal.yaml b/doc/openapi/components/schemas/config/nodes/opal.yaml index 6266dc69e..2146c1479 100644 --- a/doc/openapi/components/schemas/config/nodes/opal.yaml +++ b/doc/openapi/components/schemas/config/nodes/opal.yaml @@ -7,7 +7,7 @@ allOf: properties: send_id: type: integer - + recv_id: type: integer diff --git a/doc/openapi/components/schemas/config/nodes/redis.yaml b/doc/openapi/components/schemas/config/nodes/redis.yaml index 47432bef1..e75b13493 100644 --- a/doc/openapi/components/schemas/config/nodes/redis.yaml +++ b/doc/openapi/components/schemas/config/nodes/redis.yaml @@ -71,7 +71,7 @@ allOf: timeout: type: object - properties: + properties: connect: type: number description: The timeout in seconds for the initial connection establishment. @@ -83,7 +83,7 @@ allOf: keepalive: type: boolean default: false - description: Enable periodic keepalive packets. + description: Enable periodic keepalive packets. key: type: string @@ -104,7 +104,7 @@ allOf: ssl: type: object - properties: + properties: enabled: type: boolean default: true diff --git a/doc/openapi/components/schemas/config/nodes/rtp.yaml b/doc/openapi/components/schemas/config/nodes/rtp.yaml index e3970527d..4c39e69d4 100644 --- a/doc/openapi/components/schemas/config/nodes/rtp.yaml +++ b/doc/openapi/components/schemas/config/nodes/rtp.yaml @@ -14,7 +14,7 @@ allOf: aimd: type: object - properties: + properties: a: type: number default: 10 @@ -50,7 +50,7 @@ allOf: out: type: object - properties: + properties: netem: $ref: ../netem.yaml diff --git a/doc/openapi/components/schemas/config/nodes/shmem.yaml b/doc/openapi/components/schemas/config/nodes/shmem.yaml index c67b9ca7a..60e561942 100644 --- a/doc/openapi/components/schemas/config/nodes/shmem.yaml +++ b/doc/openapi/components/schemas/config/nodes/shmem.yaml @@ -35,7 +35,7 @@ allOf: in: type: object - properties: + properties: name: type: string description: | @@ -45,7 +45,7 @@ allOf: out: type: object - properties: + properties: name: type: string description: | diff --git a/doc/openapi/components/schemas/config/nodes/signal_node.yaml b/doc/openapi/components/schemas/config/nodes/signal_node.yaml index 988b57acf..61a08341d 100644 --- a/doc/openapi/components/schemas/config/nodes/signal_node.yaml +++ b/doc/openapi/components/schemas/config/nodes/signal_node.yaml @@ -50,8 +50,8 @@ allOf: frequency: type: number description: The frequency of the signal when the `signal` setting is one of `sine`, `square`, `triangle`,`pulse` or `ramp`. - default: 1.0 - + default: 1.0 + phase: type: number default: 0.0 diff --git a/doc/openapi/components/schemas/config/nodes/signals/signal_v2_signal.yaml b/doc/openapi/components/schemas/config/nodes/signals/signal_v2_signal.yaml index e9ab4a1a1..6491c1ec8 100644 --- a/doc/openapi/components/schemas/config/nodes/signals/signal_v2_signal.yaml +++ b/doc/openapi/components/schemas/config/nodes/signals/signal_v2_signal.yaml @@ -40,8 +40,8 @@ allOf: frequency: type: number description: The frequency of the signal when the `signal` setting is one of `sine`, `square`, `triangle`,`pulse` or `ramp`. - default: 1.0 - + default: 1.0 + phase: type: number default: 0.0 diff --git a/doc/openapi/components/schemas/config/nodes/signals/uldaq_signal.yaml b/doc/openapi/components/schemas/config/nodes/signals/uldaq_signal.yaml index 5200ae976..ce48c4404 100644 --- a/doc/openapi/components/schemas/config/nodes/signals/uldaq_signal.yaml +++ b/doc/openapi/components/schemas/config/nodes/signals/uldaq_signal.yaml @@ -13,7 +13,7 @@ allOf: type: string description: The input mode for a specific channel. See `input_mode` for allowed values - channel: + channel: type: integer example: 5 description: The channel input number of the device. diff --git a/doc/openapi/components/schemas/config/nodes/socket.yaml b/doc/openapi/components/schemas/config/nodes/socket.yaml index 49c9b1ec7..6330d3d89 100644 --- a/doc/openapi/components/schemas/config/nodes/socket.yaml +++ b/doc/openapi/components/schemas/config/nodes/socket.yaml @@ -49,7 +49,7 @@ allOf: multicast: type: object - properties: + properties: enabled: type: boolean default: true diff --git a/doc/openapi/components/schemas/config/nodes/stats_node.yaml b/doc/openapi/components/schemas/config/nodes/stats_node.yaml index e69b5e8f1..373e774dc 100644 --- a/doc/openapi/components/schemas/config/nodes/stats_node.yaml +++ b/doc/openapi/components/schemas/config/nodes/stats_node.yaml @@ -13,7 +13,7 @@ allOf: type: object required: - signals - properties: + properties: signals: type: array items: diff --git a/doc/openapi/components/schemas/config/nodes/test_rtt.yaml b/doc/openapi/components/schemas/config/nodes/test_rtt.yaml index 03a03355d..d76a08f63 100644 --- a/doc/openapi/components/schemas/config/nodes/test_rtt.yaml +++ b/doc/openapi/components/schemas/config/nodes/test_rtt.yaml @@ -71,5 +71,5 @@ allOf: This setting is exclusive with the `limit` setting. type: number example: 60.0 - + - $ref: ../node.yaml diff --git a/doc/openapi/components/schemas/config/nodes/uldaq.yaml b/doc/openapi/components/schemas/config/nodes/uldaq.yaml index e6189b659..dc82a7fbe 100644 --- a/doc/openapi/components/schemas/config/nodes/uldaq.yaml +++ b/doc/openapi/components/schemas/config/nodes/uldaq.yaml @@ -6,7 +6,7 @@ allOf: - type: object required: - sample_rate - properties: + properties: interface_type: type: string diff --git a/doc/openapi/components/schemas/config/nodes/webrtc.yaml b/doc/openapi/components/schemas/config/nodes/webrtc.yaml index 64c10373b..9255b645d 100644 --- a/doc/openapi/components/schemas/config/nodes/webrtc.yaml +++ b/doc/openapi/components/schemas/config/nodes/webrtc.yaml @@ -42,7 +42,7 @@ allOf: ice: type: object title: ICE configuration settings - properties: + properties: servers: title: ICE Servers description: A list of ICE servers used for connection establishment diff --git a/doc/openapi/components/schemas/config/nodes/zeromq.yaml b/doc/openapi/components/schemas/config/nodes/zeromq.yaml index aafa81243..f263689be 100644 --- a/doc/openapi/components/schemas/config/nodes/zeromq.yaml +++ b/doc/openapi/components/schemas/config/nodes/zeromq.yaml @@ -39,8 +39,8 @@ allOf: You can use the [`villas zmq-keygen`](../usage/villas-zmq-keygen.md) command to create a new keypair for the following configuration options: type: object - properties: - enabled: + properties: + enabled: type: boolean description: Whether or not the encryption is enabled. diff --git a/doc/openapi/components/schemas/config/path.yaml b/doc/openapi/components/schemas/config/path.yaml index 5483c6c2e..bfaf5edb6 100644 --- a/doc/openapi/components/schemas/config/path.yaml +++ b/doc/openapi/components/schemas/config/path.yaml @@ -31,7 +31,7 @@ properties: - type: array items: type: string - + enabled: type: boolean default: true @@ -124,4 +124,4 @@ properties: If you see queue or pool underrun warnings, try to increase this value. type: number - + diff --git a/doc/openapi/components/schemas/formats/edgeflex.yaml b/doc/openapi/components/schemas/formats/edgeflex.yaml index 58c283c01..2826cbb02 100644 --- a/doc/openapi/components/schemas/formats/edgeflex.yaml +++ b/doc/openapi/components/schemas/formats/edgeflex.yaml @@ -11,7 +11,7 @@ type: object required: - created -properties: +properties: created: title: Sampling timestamp description: A timestamps in miliseconds since 1970-01-01 00:00:00 @@ -26,7 +26,7 @@ additionalProperties: - type: boolean - type: object description: A complex number represented in real and imaginary components - properties: + properties: real: type: number imag: @@ -40,4 +40,3 @@ example: signal3: real: 1234.4556 imag: 23232.12312 - \ No newline at end of file diff --git a/doc/openapi/components/schemas/formats/igor.yaml b/doc/openapi/components/schemas/formats/igor.yaml index 12bd23a9d..a83e390b4 100644 --- a/doc/openapi/components/schemas/formats/igor.yaml +++ b/doc/openapi/components/schemas/formats/igor.yaml @@ -55,7 +55,7 @@ required: - timestamp - readings -properties: +properties: device: description: ID for measurement device type: string @@ -64,13 +64,13 @@ properties: description: Timestamp of measurement in ISO 8601 format type: string pattern: '^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$' - + readings: type: array items: type: object - properties: - + properties: + channel: type: string description: Name of the monitored bus @@ -78,11 +78,11 @@ properties: magnitude: type: number description: Amplitude of the measured signal [V] - + phase: type: number description: Phase of the measured signal [radian] - + frequency: type: number description: Frequency of the line signal [Hz] diff --git a/doc/openapi/components/schemas/formats/sogno-old.yaml b/doc/openapi/components/schemas/formats/sogno-old.yaml index f5badb87c..34f8ade7d 100644 --- a/doc/openapi/components/schemas/formats/sogno-old.yaml +++ b/doc/openapi/components/schemas/formats/sogno-old.yaml @@ -13,7 +13,7 @@ required: - phase - data -properties: +properties: device: description: ID for measurement device type: string @@ -22,12 +22,12 @@ properties: description: Timestamp of measurement in ISO 8601 format type: string pattern: '^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$' - + component: description: ID (uuid) from CIM document type: string format: uuid - + measurand: type: string enum: @@ -39,14 +39,14 @@ properties: - reactivepower - apparentpower - frequency - + phase: type: string enum: - A - B - C - + data: type: number description: | @@ -58,7 +58,7 @@ properties: - activepower: single phase power, unit watts - reactivepower: single phase power, unit voltampere reactive - apparentpower: single phase power, unit voltampere - - frequency: unit hertz + - frequency: unit hertz example: device: pmu-abc0 diff --git a/doc/openapi/components/schemas/formats/sogno.yaml b/doc/openapi/components/schemas/formats/sogno.yaml index e12862ba8..a7279277e 100644 --- a/doc/openapi/components/schemas/formats/sogno.yaml +++ b/doc/openapi/components/schemas/formats/sogno.yaml @@ -23,7 +23,7 @@ required: - timestamp - readings -properties: +properties: device: description: ID for measurement device type: string @@ -32,17 +32,17 @@ properties: description: Timestamp of measurement in ISO 8601 format type: string pattern: '^\d{4}(-\d\d(-\d\d(T\d\d:\d\d(:\d\d)?(\.\d+)?(([+-]\d\d:\d\d)|Z)?)?)?)?$' - + readings: type: array items: type: object - properties: + properties: component: description: ID (uuid) from CIM document type: string format: uuid - + measurand: type: string enum: @@ -54,14 +54,14 @@ properties: - reactivepower - apparentpower - frequency - + phase: type: string enum: - A - B - C - + data: type: number description: | @@ -73,4 +73,4 @@ properties: - activepower: single phase power, unit watts - reactivepower: single phase power, unit voltampere reactive - apparentpower: single phase power, unit voltampere - - frequency: unit hertz + - frequency: unit hertz diff --git a/doc/openapi/openapi.yaml b/doc/openapi/openapi.yaml index d5aa52d0c..857fd7fd5 100644 --- a/doc/openapi/openapi.yaml +++ b/doc/openapi/openapi.yaml @@ -79,7 +79,7 @@ x-tagGroups: - super-node - nodes - paths - + - name: Configuration Files tags: - config @@ -135,11 +135,11 @@ paths: '/graph.{format}': $ref: 'paths/graph.{format}.yaml' -components: - schemas: +components: + schemas: Config: $ref: components/schemas/config.yaml - + TypeField: type: object required: diff --git a/doc/openapi/paths/config.yaml b/doc/openapi/paths/config.yaml index 7f5a19f2d..2dc10836d 100644 --- a/doc/openapi/paths/config.yaml +++ b/doc/openapi/paths/config.yaml @@ -13,7 +13,7 @@ get: description: Success content: application/json: - schema: + schema: $ref: ../components/schemas/config.yaml examples: example1: diff --git a/doc/openapi/paths/restart.yaml b/doc/openapi/paths/restart.yaml index cd2bbf621..8862e3a4f 100644 --- a/doc/openapi/paths/restart.yaml +++ b/doc/openapi/paths/restart.yaml @@ -22,7 +22,7 @@ post: description: | An optional path or URI to a new configuration file which should be loaded after restarting the node. - + The file referenced by the URL must be a [VILLASnode configuration file](#tag/config) - $ref: ../components/schemas/config.yaml responses: