mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
update OpenAPI docs
This commit is contained in:
parent
a98ab9f172
commit
938a65ebda
7 changed files with 31 additions and 4 deletions
|
@ -2,5 +2,10 @@
|
|||
---
|
||||
|
||||
type: array
|
||||
title: Hook List
|
||||
example:
|
||||
- "print"
|
||||
- type: limit_rate
|
||||
rate: 1000
|
||||
items:
|
||||
$ref: hook_spec.yaml
|
||||
|
|
|
@ -78,4 +78,4 @@ allOf:
|
|||
description: |
|
||||
An arbitrary Lua expression which will be evaluated and used for the value of the signal.
|
||||
Note you can access the current sample using the global Lua variable `smp`.
|
||||
- $ref: ../signaldef.yaml
|
||||
- $ref: ../signal_spec.yaml
|
||||
|
|
|
@ -1,5 +1,14 @@
|
|||
---
|
||||
|
||||
description: |
|
||||
The netem configuration allows the user to apply network impairments to packets send out by the nodes.
|
||||
|
||||
Please note, that the network emulation feature is currently supported by the following node-types:
|
||||
- [`socket`](/docs/node/nodes/socket)
|
||||
- [`nanomsg`](/docs/node/nodes/nanomsg)
|
||||
- [`zeromq`](/docs/node/nodes/zeromq)
|
||||
- [`rtp`](/docs/node/nodes/rtp)
|
||||
|
||||
type: object
|
||||
properties:
|
||||
enabled:
|
||||
|
|
|
@ -25,19 +25,21 @@ properties:
|
|||
|
||||
in:
|
||||
type: object
|
||||
title: Input configuration (received by VILLASnode)
|
||||
properties:
|
||||
vectorize:
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
signals:
|
||||
$ref: signallist.yaml
|
||||
$ref: signal_list.yaml
|
||||
|
||||
hooks:
|
||||
$ref: hook_list.yaml
|
||||
|
||||
out:
|
||||
type: object
|
||||
title: Output configuration (sent out by VILLASnode)
|
||||
properties:
|
||||
|
||||
vectorize:
|
||||
|
|
|
@ -13,6 +13,8 @@ properties:
|
|||
description: |
|
||||
The in settings expects the name of one or more source nodes or mapping expressions.
|
||||
|
||||
Checkout the [input mapping section](/docs/node/config/paths#input-mapping) for more details.
|
||||
|
||||
oneOf:
|
||||
- type: string
|
||||
- type: array
|
||||
|
|
|
@ -8,13 +8,22 @@ description: |
|
|||
oneOf:
|
||||
- type: array
|
||||
title: List of signal definition objects
|
||||
example:
|
||||
- name: tap_position
|
||||
type: integer
|
||||
init: 0
|
||||
- name: voltage
|
||||
type: float
|
||||
unit: V
|
||||
init: 230.0
|
||||
|
||||
items:
|
||||
$ref: signaldef.yaml
|
||||
$ref: signal_spec.yaml
|
||||
|
||||
- type: object
|
||||
title: Signal definition with `count`
|
||||
allOf:
|
||||
- $ref: signaldef.yaml
|
||||
- $ref: signal_spec.yaml
|
||||
- type: object
|
||||
required:
|
||||
- count
|
Loading…
Add table
Reference in a new issue