mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
docs: restructured OpenAPI docs
This commit is contained in:
parent
88bc8d33d6
commit
c313246ddd
95 changed files with 468 additions and 206 deletions
|
|
@ -11,7 +11,7 @@ allOf:
|
|||
|
||||
additionalProperties: false
|
||||
|
||||
properties:
|
||||
properties:
|
||||
nodes:
|
||||
type: object
|
||||
title: Node list
|
||||
|
|
@ -19,7 +19,7 @@ allOf:
|
|||
A list of nodes to/from which this instance sends/receives sample data.
|
||||
additionalProperties:
|
||||
x-additionalPropertiesName: node-name
|
||||
$ref: ./config/node.yaml
|
||||
$ref: ./config/node_obj.yaml
|
||||
|
||||
paths:
|
||||
title: Path list
|
||||
|
|
|
|||
24
doc/openapi/components/schemas/config/format_obj.yaml
Normal file
24
doc/openapi/components/schemas/config/format_obj.yaml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
type: object
|
||||
title: Format Object
|
||||
required:
|
||||
- type
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
csv: formats/_csv.yaml
|
||||
gtnet: formats/_gtnet.yaml
|
||||
iotagent_ul: formats/_iotagent_ul.yaml
|
||||
json: formats/_json.yaml
|
||||
json.edgeflex: formats/_json_edgeflex.yaml
|
||||
json.kafka: formats/_json_kafka.yaml
|
||||
json.reserve: formats/_json_reserve.yaml
|
||||
protobuf: formats/_protobuf.yaml
|
||||
raw: formats/_raw.yaml
|
||||
tsv: formats/_tsv.yaml
|
||||
value: formats/_value.yaml
|
||||
villas.binary: formats/_villas_binary.yaml
|
||||
villas.human: formats/_villas_human.yaml
|
||||
villas.web: formats/_villas_web.yaml
|
||||
|
|
@ -1,8 +1,11 @@
|
|||
---
|
||||
|
||||
description: |
|
||||
The payload format which is used to encode and decode exchanged messages.
|
||||
oneOf:
|
||||
- $ref: format.yaml
|
||||
- type: string
|
||||
- $ref: format_obj.yaml
|
||||
- title: Format Name
|
||||
type: string
|
||||
enum:
|
||||
- csv
|
||||
- gtnet
|
||||
3
doc/openapi/components/schemas/config/formats/_csv.yaml
Normal file
3
doc/openapi/components/schemas/config/formats/_csv.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: csv.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: gtnet.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: iotagent_ul.yaml
|
||||
3
doc/openapi/components/schemas/config/formats/_json.yaml
Normal file
3
doc/openapi/components/schemas/config/formats/_json.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: json.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: json_edgeflex.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: json_kafka.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: json_reserve.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: protobuf.yaml
|
||||
3
doc/openapi/components/schemas/config/formats/_raw.yaml
Normal file
3
doc/openapi/components/schemas/config/formats/_raw.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: raw.yaml
|
||||
3
doc/openapi/components/schemas/config/formats/_tsv.yaml
Normal file
3
doc/openapi/components/schemas/config/formats/_tsv.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: tsv.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: value.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: villas_binary.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: villas_human.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../format_obj.yaml
|
||||
- $ref: villas_web.yaml
|
||||
|
|
@ -2,14 +2,7 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
type: object
|
||||
|
||||
required:
|
||||
- type
|
||||
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: The format-type
|
||||
|
||||
real_precission:
|
||||
type: integer
|
||||
|
|
@ -43,21 +36,3 @@ properties:
|
|||
description: |
|
||||
If set, include the offset between origin and received timestamp in the output.
|
||||
|
||||
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
csv: formats/csv.yaml
|
||||
iotagent_ul: formats/iotagent_ul.yaml
|
||||
json: formats/json.yaml
|
||||
json.reserve: formats/json_reserve.yaml
|
||||
json.kafka: formats/json_kafka.yaml
|
||||
json.edgeflex: formats/json_edgeflex.yaml
|
||||
gtnet: formats/gtnet.yaml
|
||||
protobuf: formats/protobuf.yaml
|
||||
raw: formats/raw.yaml
|
||||
tsv: formats/tsv.yaml
|
||||
value: formats/value.yaml
|
||||
villas.binary: formats/villas_binary.yaml
|
||||
villas.human: formats/villas_human.yaml
|
||||
villas.web: formats/villas_web.yaml
|
||||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: column.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: column.yaml
|
||||
|
|
|
|||
|
|
@ -3,7 +3,3 @@
|
|||
|
||||
allOf:
|
||||
- $ref: raw.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
indent:
|
||||
|
|
@ -39,3 +38,4 @@ allOf:
|
|||
default: false
|
||||
description:
|
||||
Escape the `/` characters in strings with `\/`.
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: json.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: json.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: json.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: json.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: json.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: json.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
separator:
|
||||
type: string
|
||||
- type: object
|
||||
properties:
|
||||
separator:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: column.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: column.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../format.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: line.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: line.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: villas_binary.yaml
|
||||
- type: object
|
||||
properties:
|
||||
delimiter:
|
||||
type: string
|
||||
- $ref: villas_binary.yaml
|
||||
|
|
|
|||
|
|
@ -1,97 +0,0 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
type: object
|
||||
|
||||
title: Node
|
||||
|
||||
required:
|
||||
- type
|
||||
|
||||
properties:
|
||||
|
||||
type:
|
||||
type: string
|
||||
description: |
|
||||
Specifies which protocol should be used by this node.
|
||||
|
||||
For a complete list of supported node-types run `villas node --help`.
|
||||
|
||||
In addition to the node settings described in this section, every node type has its own specific settings
|
||||
|
||||
vectorize:
|
||||
type: integer
|
||||
default: 1
|
||||
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.
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
builtin:
|
||||
type: boolean
|
||||
default: true
|
||||
title: Builtin hook functions
|
||||
description: |
|
||||
By default, each node and paths has a couple of default hooks attached to them. With this setting the attachment of built-in hooks can be disabled.
|
||||
|
||||
in:
|
||||
type: object
|
||||
properties:
|
||||
vectorize:
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
signals:
|
||||
$ref: signallist.yaml
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
out:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
vectorize:
|
||||
type: integer
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
netem:
|
||||
$ref: netem.yaml
|
||||
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
amqp: nodes/amqp.yaml
|
||||
can: nodes/can.yaml
|
||||
comedi: nodes/comedi.yaml
|
||||
ethercat: nodes/ethercat.yaml
|
||||
exec: nodes/exec.yaml
|
||||
file: nodes/file.yaml
|
||||
fpga: nodes/fpga.yaml
|
||||
iec61850-8-1: nodes/iec61850-8-1.yaml
|
||||
iec61850-9-2: nodes/iec61850-9-2.yaml
|
||||
infiniband: nodes/infiniband.yaml
|
||||
influxdb: nodes/influxdb.yaml
|
||||
kafka: nodes/kafka.yaml
|
||||
loopback: nodes/loopback.yaml
|
||||
mqtt: nodes/mqtt.yaml
|
||||
nanomsg: nodes/nanomsg.yaml
|
||||
ngsi: nodes/ngsi.yaml
|
||||
opal: nodes/opal.yaml
|
||||
redis: nodes/redis.yaml
|
||||
rtp: nodes/rtp.yaml
|
||||
shmem: nodes/shmem.yaml
|
||||
signal.v2: nodes/signal_v2.yaml
|
||||
signal: nodes/signal.yaml
|
||||
socket: nodes/socket.yaml
|
||||
stats: nodes/stats_node.yaml
|
||||
temper: nodes/temper.yaml
|
||||
test_rtt: nodes/test_rtt.yaml
|
||||
uldaq: nodes/uldaq.yaml
|
||||
websocket: nodes/websocket.yaml
|
||||
zeromq: nodes/zeromq.yaml
|
||||
48
doc/openapi/components/schemas/config/node_obj.yaml
Normal file
48
doc/openapi/components/schemas/config/node_obj.yaml
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
type: object
|
||||
title: Format Object
|
||||
required:
|
||||
- type
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
description: |
|
||||
Specifies which protocol should be used by this node.
|
||||
|
||||
For a complete list of supported node-types run `villas node --help`.
|
||||
|
||||
In addition to the node settings described in this section, every node type has its own specific settings
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
amqp: nodes/_amqp.yaml
|
||||
can: nodes/_can.yaml
|
||||
comedi: nodes/_comedi.yaml
|
||||
ethercat: nodes/_ethercat.yaml
|
||||
exec: nodes/_exec.yaml
|
||||
file: nodes/_file.yaml
|
||||
fpga: nodes/_fpga.yaml
|
||||
iec61850-8-1: nodes/_iec61850-8-1.yaml
|
||||
iec61850-9-2: nodes/_iec61850-9-2.yaml
|
||||
infiniband: nodes/_infiniband.yaml
|
||||
influxdb: nodes/_influxdb.yaml
|
||||
kafka: nodes/_kafka.yaml
|
||||
loopback: nodes/_loopback.yaml
|
||||
mqtt: nodes/_mqtt.yaml
|
||||
nanomsg: nodes/_nanomsg.yaml
|
||||
ngsi: nodes/_ngsi.yaml
|
||||
opal: nodes/_opal.yaml
|
||||
redis: nodes/_redis.yaml
|
||||
rtp: nodes/_rtp.yaml
|
||||
shmem: nodes/_shmem.yaml
|
||||
signal.v2: nodes/_signal_v2.yaml
|
||||
signal: nodes/_signal.yaml
|
||||
socket: nodes/_socket.yaml
|
||||
stats_node: nodes/_stats_node.yaml
|
||||
temper: nodes/_temper.yaml
|
||||
test_rtt: nodes/_test_rtt.yaml
|
||||
uldaq: nodes/_uldaq.yaml
|
||||
websocket: nodes/_websocket.yaml
|
||||
zeromq: nodes/_zeromq.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_amqp.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_amqp.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: amqp.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_can.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_can.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: _amqp.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_comedi.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_comedi.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: comedi.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: ethercat.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_exec.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_exec.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: exec.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_file.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_file.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: file.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_fpga.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_fpga.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: fpga.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: iec61850-8-1.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: iec61850-9-2.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: infiniband.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: influxdb.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_kafka.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_kafka.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: kafka.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: loopback.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_mqtt.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_mqtt.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: mqtt.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: nanomsg.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_ngsi.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_ngsi.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: ngsi.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_opal.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_opal.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: opal.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_redis.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_redis.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: redis.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_rtp.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_rtp.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: rtp.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_shmem.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_shmem.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: shmem.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_signal.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_signal.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: signal.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: signal_v2.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_socket.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_socket.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: socket.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: stats_node.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_temper.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_temper.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: temper.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: test_rtt.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_uldaq.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_uldaq.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: uldaq.yaml
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: websocket.yaml
|
||||
3
doc/openapi/components/schemas/config/nodes/_zeromq.yaml
Normal file
3
doc/openapi/components/schemas/config/nodes/_zeromq.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../node_obj.yaml
|
||||
- $ref: zeromq.yaml
|
||||
|
|
@ -1,9 +1,48 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
title: Advanced Messaging & Queuing Protocol (AMQP)
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
uri:
|
||||
type: string
|
||||
format: uri
|
||||
description: |
|
||||
See also: https://www.rabbitmq.com/uri-spec.html
|
||||
|
||||
exchange:
|
||||
type: string
|
||||
description: |
|
||||
The name of the AMQP exchange the node will publish the messages to.
|
||||
|
||||
routing_key:
|
||||
type: string
|
||||
description: |
|
||||
The routing key of published messages as well as the routing key which is used to bind the subcriber queue.
|
||||
|
||||
ssl:
|
||||
description: |
|
||||
Note: These settings are only used if the `uri` setting is using the `amqps://` schema.
|
||||
|
||||
type: object
|
||||
properties:
|
||||
verify_hostname:
|
||||
default: true,
|
||||
|
||||
verify_peer:
|
||||
default: true,
|
||||
|
||||
ca_cert:
|
||||
default: "/path/to/ca.crt"
|
||||
|
||||
client_cert:
|
||||
default: "/path/to/client.crt"
|
||||
|
||||
client_key:
|
||||
default: "/path/to/client.key"
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
50
doc/openapi/components/schemas/config/nodes/common.yaml
Normal file
50
doc/openapi/components/schemas/config/nodes/common.yaml
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
type: object
|
||||
title: Node
|
||||
properties:
|
||||
|
||||
vectorize:
|
||||
type: integer
|
||||
default: 1
|
||||
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.
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
builtin:
|
||||
type: boolean
|
||||
default: true
|
||||
title: Builtin hook functions
|
||||
description: |
|
||||
By default, each node and paths has a couple of default hooks attached to them. With this setting the attachment of built-in hooks can be disabled.
|
||||
|
||||
in:
|
||||
type: object
|
||||
properties:
|
||||
vectorize:
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
signals:
|
||||
$ref: signallist.yaml
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
out:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
vectorize:
|
||||
type: integer
|
||||
|
||||
hooks:
|
||||
$ref: hooklist.yaml
|
||||
|
||||
netem:
|
||||
$ref: netem.yaml
|
||||
|
|
@ -2,8 +2,8 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,48 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
shell:
|
||||
type: boolean
|
||||
default: false
|
||||
description: |
|
||||
If set, the `exec` setting gets passed the shell (`/usr/bin`).
|
||||
In this case the `exec` setting must be given as a string.
|
||||
|
||||
If not set, we will directly execute the sub-process via `execvpe(2)`.
|
||||
In this case the exec setting must be given as an array (`argv[]`).
|
||||
|
||||
exec:
|
||||
description: |
|
||||
The program which should be execed in the sub-process.
|
||||
|
||||
The option is passed to the system shell for execution.
|
||||
|
||||
oneOf:
|
||||
- type: array
|
||||
items:
|
||||
type: string
|
||||
- type: string
|
||||
|
||||
flush:
|
||||
type: boolean
|
||||
default: true
|
||||
description: |
|
||||
Flush stream every time VILLASnode passes data the sub-process.
|
||||
|
||||
working_directory:
|
||||
type: string
|
||||
description: |
|
||||
If set, the working directory for the sub-process will be changed.
|
||||
|
||||
environment:
|
||||
type: object
|
||||
description: |
|
||||
A object of key/value pairs of environemnt variables which should be passed to the sub-process in addition to the parent environment.
|
||||
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,31 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
uri:
|
||||
type: string
|
||||
format: uri
|
||||
description: |
|
||||
Specifies the URI to a file from which is written to or read from depending in which group (`in`or `out`) is used.
|
||||
|
||||
This setting allows to add special paceholders for time and date values.
|
||||
See [strftime(3)](http://man7.org/linux/man-pages/man3/strftime.3.html) for a list of supported placeholder.
|
||||
|
||||
**Example**:
|
||||
|
||||
```
|
||||
uri = "logs/measurements_%Y-%m-%d_%H-%M-%S.log"
|
||||
```
|
||||
|
||||
will create a file called:
|
||||
|
||||
```
|
||||
./logs/measurements_2015-08-09_22-20-50.log
|
||||
```
|
||||
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -2,8 +2,9 @@
|
|||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../formatspec.yaml
|
||||
$ref: ../format_spec.yaml
|
||||
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -136,6 +136,15 @@ components:
|
|||
schemas:
|
||||
Config:
|
||||
$ref: components/schemas/config.yaml
|
||||
|
||||
TypeField:
|
||||
type: object
|
||||
required:
|
||||
- type
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
|
||||
FormatEdgeflex:
|
||||
$ref: components/schemas/formats/edgeflex.yaml
|
||||
FormatIgor:
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue