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

openapi: Remove trailing whitespaces

Signed-off-by: Steffen Vogel <post@steffenvogel.de>
This commit is contained in:
Steffen Vogel 2024-02-28 00:12:39 +01:00
parent 7fe56a3341
commit db170e1590
53 changed files with 94 additions and 95 deletions

View file

@ -37,4 +37,4 @@ allOf:
logging:
$ref: config/logging.yaml
- $ref: config/global.yaml
- $ref: config/global.yaml

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -8,7 +8,7 @@ allOf:
- type: object
required:
- window_size
properties:
properties:
window_size:
type: integer
min: 1

View file

@ -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

View file

@ -6,7 +6,7 @@ allOf:
- type: object
required:
- phases
properties:
properties:
phases:
description: Signal indices for voltage & current values for each phase.
example:

View file

@ -4,7 +4,7 @@
---
allOf:
- type: object
properties:
properties:
mode:
description: The triggering condition at which the gate opens.
type: string

View file

@ -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

View file

@ -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)"

View file

@ -10,7 +10,7 @@ allOf:
- end_frequency
- frequency_resolution
- dft_rate
properties:
properties:
sample_rate:
type: integer
default: 0

View file

@ -6,7 +6,7 @@ allOf:
- type: object
required:
- expected_smp_rate
properties:
properties:
mode:
type: string
enum:

View file

@ -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

View file

@ -4,7 +4,7 @@
---
allOf:
- type: object
properties:
properties:
precision:
type: integer
default: 0

View file

@ -4,7 +4,7 @@
---
allOf:
- type: object
properties:
properties:
offset:
type: number
default: 0.0

View file

@ -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.

View file

@ -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.

View file

@ -4,7 +4,7 @@
---
allOf:
- type: object
properties:
properties:
format:
$ref: ../format_spec.yaml
buckets:

View file

@ -50,7 +50,7 @@ properties:
required:
- name
- level
properties:
properties:
name:
type: string
title: Logger name filter

View file

@ -16,7 +16,7 @@ properties:
enabled:
type: boolean
default: true
delay:
type: number
default: 0

View file

@ -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

View file

@ -3,9 +3,9 @@
# SPDX-License-Identifier: Apache-2.0
---
type: object
properties:
properties:
in:
type: object
properties:
properties:
signals:
$ref: ./signal_list.yaml

View file

@ -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,

View file

@ -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:

View file

@ -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

View file

@ -25,7 +25,7 @@ allOf:
type: array
items:
$ref: ./signals/iec61850_signal.yaml
svid:
type: string

View file

@ -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.

View file

@ -5,7 +5,7 @@
allOf:
- type: object
properties:
queuelen:
type: integer
min: 0

View file

@ -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.

View file

@ -10,7 +10,7 @@ allOf:
endpoint:
type: string
format: uri
entity_id:
type: string
description: ID of NGSI entity.

View file

@ -7,7 +7,7 @@ allOf:
properties:
send_id:
type: integer
recv_id:
type: integer

View file

@ -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

View file

@ -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

View file

@ -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: |

View file

@ -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

View file

@ -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

View file

@ -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.

View file

@ -49,7 +49,7 @@ allOf:
multicast:
type: object
properties:
properties:
enabled:
type: boolean
default: true

View file

@ -13,7 +13,7 @@ allOf:
type: object
required:
- signals
properties:
properties:
signals:
type: array
items:

View file

@ -71,5 +71,5 @@ allOf:
This setting is exclusive with the `limit` setting.
type: number
example: 60.0
- $ref: ../node.yaml

View file

@ -6,7 +6,7 @@ allOf:
- type: object
required:
- sample_rate
properties:
properties:
interface_type:
type: string

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -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]

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -13,7 +13,7 @@ get:
description: Success
content:
application/json:
schema:
schema:
$ref: ../components/schemas/config.yaml
examples:
example1:

View file

@ -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: