diff --git a/doc/openapi/components/schemas/config/hook_list.yaml b/doc/openapi/components/schemas/config/hook_list.yaml index a29b41a2c..778aba80f 100644 --- a/doc/openapi/components/schemas/config/hook_list.yaml +++ b/doc/openapi/components/schemas/config/hook_list.yaml @@ -2,5 +2,10 @@ --- type: array +title: Hook List +example: +- "print" +- type: limit_rate + rate: 1000 items: $ref: hook_spec.yaml diff --git a/doc/openapi/components/schemas/config/hooks/lua.yaml b/doc/openapi/components/schemas/config/hooks/lua.yaml index 678590c3c..b7f7b0506 100644 --- a/doc/openapi/components/schemas/config/hooks/lua.yaml +++ b/doc/openapi/components/schemas/config/hooks/lua.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 diff --git a/doc/openapi/components/schemas/config/netem.yaml b/doc/openapi/components/schemas/config/netem.yaml index 27f03cf75..bf99cd314 100644 --- a/doc/openapi/components/schemas/config/netem.yaml +++ b/doc/openapi/components/schemas/config/netem.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: diff --git a/doc/openapi/components/schemas/config/node.yaml b/doc/openapi/components/schemas/config/node.yaml index 1cfb21b08..4dca6bc4e 100644 --- a/doc/openapi/components/schemas/config/node.yaml +++ b/doc/openapi/components/schemas/config/node.yaml @@ -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: diff --git a/doc/openapi/components/schemas/config/path.yaml b/doc/openapi/components/schemas/config/path.yaml index 22bee080c..6bb9b0847 100644 --- a/doc/openapi/components/schemas/config/path.yaml +++ b/doc/openapi/components/schemas/config/path.yaml @@ -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 diff --git a/doc/openapi/components/schemas/config/signallist.yaml b/doc/openapi/components/schemas/config/signal_list.yaml similarity index 88% rename from doc/openapi/components/schemas/config/signallist.yaml rename to doc/openapi/components/schemas/config/signal_list.yaml index 5e42e32f2..b49852212 100644 --- a/doc/openapi/components/schemas/config/signallist.yaml +++ b/doc/openapi/components/schemas/config/signal_list.yaml @@ -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 diff --git a/doc/openapi/components/schemas/config/signaldef.yaml b/doc/openapi/components/schemas/config/signal_spec.yaml similarity index 100% rename from doc/openapi/components/schemas/config/signaldef.yaml rename to doc/openapi/components/schemas/config/signal_spec.yaml