Mirrors/VILLASnode
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00
Code Issues Releases Wiki Activity

openapi: add more OpenAPI specs

Browse source
This commit is contained in:
Steffen Vogel 2021-11-24 10:32:25 +01:00 • committed by Steffen Vogel
parent 4fb8b78b03
commit 88bc8d33d6
72 changed files with 71 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
doc/openapi/components/schemas/config/format.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
type: object
required:
@ -10,6 +9,40 @@ required:
properties:
type:
type: string
description: The format-type
real_precission:
type: integer
default: 17
description: |
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
description: |
If set, include the origin timestamp in the output.
sequence:
type: boolean
default: true
description: |
If set, include the sequence number in the output.
data:
type: boolean
default: true
description: |
If set, include the data in the output.
offset:
type: boolean
default: true
description: |
If set, include the offset between origin and received timestamp in the output.
discriminator:
propertyName: type

1
doc/openapi/components/schemas/config/formats/column.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: line.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/csv.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: column.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/gtnet.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: raw.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/iotagent_ul.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

37
doc/openapi/components/schemas/config/formats/json.yaml
View file

@ -1,10 +1,41 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object
properties:
delimiter:
type: string
indent:
type: number
default: 0
description: |
Pretty-print the result, using newlines between array and object items, and indenting with n spaces.
The valid range for n is between 0 and 31 (inclusive), other values result in an undefined output.
If the settings is not used or is 0, no newlines are inserted between array and object items.
compact:
type: boolean
default: false
description: |
This flag enables a compact representation, i.e. sets the separator between array and object items to "," and between object keys and values to ":".
Without this flag, the corresponding separators are ", " and ": " for more readable output.
ensure_ascii:
type: boolean
default: false
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
description: |
If this flag is used, all the objects in output are sorted by key.
This is useful e.g. if two JSON texts are diffed or visually compared.
escape_slash:
type: boolean
default: false
description:
Escape the `/` characters in strings with `\/`.

1
doc/openapi/components/schemas/config/formats/json_edgeflex.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: json.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/json_kafka.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: json.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/json_reserve.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: json.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/line.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/protobuf.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/raw.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/tsv.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: column.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/value.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/villas_binary.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../format.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/villas_human.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: line.yaml
- type: object

1
doc/openapi/components/schemas/config/formats/villas_web.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: villas_binary.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/average.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/cast.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/dp.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/drop.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/dump.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/ebm.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/fix.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/gate.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/jitter_calc.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/limit_rate.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/limit_value.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/lua.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/ma.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/pmu_dft.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/pps_ts.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/restart.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/rms.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/scale.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/shift_seq.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/shift_ts.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/skip_first.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/stats.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

1
doc/openapi/components/schemas/config/hooks/ts.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../hook.yaml
- type: object

2
doc/openapi/components/schemas/config/node.yaml
View file

@ -89,7 +89,7 @@ discriminator:
signal.v2: nodes/signal_v2.yaml
signal: nodes/signal.yaml
socket: nodes/socket.yaml
stats: nodes/stats.yaml
stats: nodes/stats_node.yaml
temper: nodes/temper.yaml
test_rtt: nodes/test_rtt.yaml
uldaq: nodes/uldaq.yaml

1
doc/openapi/components/schemas/config/nodes/amqp.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/can.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/comedi.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/ethercat.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/exec.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/file.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/fpga.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/iec61850-8-1.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/iec61850-9-2.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/infiniband.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/influxdb.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/kafka.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/loopback.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/mqtt.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/nanomsg.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/ngsi.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/opal.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/redis.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/rtp.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/shmem.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/signal.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/signal_v2.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/socket.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/stats.yaml → doc/openapi/components/schemas/config/nodes/stats_node.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/temper.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/test_rtt.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/uldaq.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/websocket.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

1
doc/openapi/components/schemas/config/nodes/zeromq.yaml
View file

@ -1,7 +1,6 @@
---
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
allOf:
- $ref: ../node.yaml
- type: object

2
doc/openapi/paths/config.yaml
View file

@ -10,7 +10,7 @@ get:
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
$ref: '../openapi.yaml#/components/schemas/Config'
examples:
example1:
value:

2
doc/openapi/paths/restart.yaml
View file

@ -20,7 +20,7 @@ post:
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'
- $ref: '../openapi.yaml#/components/schemas/Config'
responses:
'200':
description: Success. The instance has been restarted.