docs: restructured OpenAPI docs (2)

doc/openapi/components/schemas/config/format_obj.yaml

@@ -1,3 +1,6 @@
+---
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
+
 type: object
 title: Format Object
 required:

doc/openapi/components/schemas/config/format_spec.yaml

@@ -1,4 +1,5 @@
 ---
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
 
 description: |
   The payload format which is used to encode and decode exchanged messages.

doc/openapi/components/schemas/config/formats/iotagent_ul.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     delimiter:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/json.yaml

@@ -38,4 +38,4 @@ allOf:
       default: false
       description: 
         Escape the `/` characters in strings with `\/`.
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/line.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     separator:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/protobuf.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     delimiter:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/raw.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     delimiter:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/value.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     delimiter:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/formats/villas_binary.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     delimiter:
       type: string
-- $ref: common.yaml
+- $ref: ../format.yaml

doc/openapi/components/schemas/config/hook.yaml

@@ -2,16 +2,9 @@
 # yaml-language-server: $schema=http://json-schema.org/draft-07/schema
 
 type: object
-
 title: Hook
 
-required:
-- type
-  
 properties:
-  type:
-    type: string
-  
   enabled:
     type: boolean
     default: true

doc/openapi/components/schemas/config/hook_list.yaml

@@ -0,0 +1,6 @@
+---
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
+
+type: array
+items:
+  $ref: hook_spec.yaml

doc/openapi/components/schemas/config/hook_obj.yaml

@@ -0,0 +1,38 @@
+---
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
+
+type: object
+title: Format Object
+required:
+- type
+properties:
+  type:
+    type: string
+discriminator:
+  propertyName: type
+  mapping:
+    average: hooks/_average.yaml
+    cast: hooks/_cast.yaml
+    decimate: hooks/_decimate.yaml
+    dp: hooks/_dp.yaml
+    drop: hooks/_drop.yaml
+    dump: hooks/_dump.yaml
+    ebm: hooks/_ebm.yaml
+    fix: hooks/_fix.yaml
+    gate: hooks/_gate.yaml
+    jitter_calc: hooks/_jitter_calc.yaml
+    limit_rate: hooks/_limit_rate.yaml
+    limit_value: hooks/_limit_value.yaml
+    lua: hooks/_lua.yaml
+    ma: hooks/_ma.yaml
+    pmu_dft: hooks/_pmu_dft.yaml
+    pps_ts: hooks/_pps_ts.yaml
+    print: hooks/_print.yaml
+    restart: hooks/_restart.yaml
+    rms: hooks/_rms.yaml
+    scale: hooks/_scale.yaml
+    shift_seq: hooks/_shift_seq.yaml
+    shift_ts: hooks/_shift_ts.yaml
+    skip_first: hooks/_skip_first.yaml
+    stats: hooks/_stats.yaml
+    ts: hooks/_ts.yaml

doc/openapi/components/schemas/config/hook_spec.yaml

@@ -0,0 +1,33 @@
+---
+# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
+
+oneOf:
+- $ref: hook_obj.yaml
+- title: Hook Name
+  type: string
+  enum:
+  - average
+  - cast
+  - decimate
+  - dp
+  - drop
+  - dump
+  - ebm
+  - fix
+  - gate
+  - jitter_calc
+  - limit_rate
+  - limit_value
+  - lua
+  - ma
+  - pmu_dft
+  - pps_ts
+  - print
+  - restart
+  - rms
+  - scale
+  - shift_seq
+  - shift_ts
+  - skip_first
+  - stats
+  - ts

doc/openapi/components/schemas/config/hooklist.yaml

@@ -1,36 +0,0 @@
----
-# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
-
-type: array
-items:
-  oneOf:
-  - $ref: hook.yaml
-  - type: string
-    title: Hook Name
-    description: Only the hook type is provided. No other settings can be configured.
-    enum:
-    - average
-    - cast
-    - decimate
-    - dp
-    - drop
-    - dump
-    - ebm
-    - fix
-    - gate
-    - jitter_calc
-    - limit_rate
-    - limit_value
-    - lua
-    - ma
-    - pmu_dft
-    - pps_ts
-    - print
-    - restart
-    - rms
-    - scale
-    - shift_seq
-    - shift_ts
-    - skip_first
-    - stats
-    - ts

doc/openapi/components/schemas/config/hooks/_average.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: average.yaml

doc/openapi/components/schemas/config/hooks/_cast.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: cast.yaml

doc/openapi/components/schemas/config/hooks/_decimate.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: decimate.yaml

doc/openapi/components/schemas/config/hooks/_dp.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: dp.yaml

doc/openapi/components/schemas/config/hooks/_drop.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: drop.yaml

doc/openapi/components/schemas/config/hooks/_dump.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: dump.yaml

doc/openapi/components/schemas/config/hooks/_ebm.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: ebm.yaml

doc/openapi/components/schemas/config/hooks/_fix.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: fix.yaml

doc/openapi/components/schemas/config/hooks/_gate.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: gate.yaml

doc/openapi/components/schemas/config/hooks/_jitter_calc.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: jitter_calc.yaml

doc/openapi/components/schemas/config/hooks/_limit_rate.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: limit_rate.yaml

doc/openapi/components/schemas/config/hooks/_limit_value.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: limit_value.yaml

doc/openapi/components/schemas/config/hooks/_lua.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: lua.yaml

doc/openapi/components/schemas/config/hooks/_ma.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: ma.yaml

doc/openapi/components/schemas/config/hooks/_pmu_dft.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: pmu_dft.yaml

doc/openapi/components/schemas/config/hooks/_pps_ts.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: pps_ts.yaml

doc/openapi/components/schemas/config/hooks/_print.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: print.yaml

doc/openapi/components/schemas/config/hooks/_restart.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: restart.yaml

doc/openapi/components/schemas/config/hooks/_rms.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: rms.yaml

doc/openapi/components/schemas/config/hooks/_scale.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: scale.yaml

doc/openapi/components/schemas/config/hooks/_shift_seq.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: shift_seq.yaml

doc/openapi/components/schemas/config/hooks/_shift_ts.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: shift_ts.yaml

doc/openapi/components/schemas/config/hooks/_skip_first.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: skip_first.yaml

doc/openapi/components/schemas/config/hooks/_stats.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: stats.yaml

doc/openapi/components/schemas/config/hooks/_ts.yaml

@@ -0,0 +1,3 @@
+allOf:
+- $ref: ../hook.yaml
+- $ref: ts.yaml

doc/openapi/components/schemas/config/http.yaml

@@ -8,16 +8,20 @@ properties:
     default: 80
     title: Listening port
     description: |
-      Listening port for HTTP connections.
+      The TCP port number on which HTTP & WebSocket server.
 
   ssl_cert:
     type: string
     title: SSL Certificate Path
-    description: Path to an SSL certificate
+    description: |
+      The public x509 certificate used for server-side SSL encryption.
+
     example: /etc/ssl/certs/mycert.pem
 
   ssl_private_key:
     type: string
     title: SSL Private Key Path
-    description: Path to an SSL private key
+    description: |
+      The private x509 key used for server-side SSL encryption.
+
     example: /etc/ssl/private/mykey.pem

doc/openapi/components/schemas/config/node.yaml

@@ -14,7 +14,7 @@ properties:
       The value of this setting determines how many samples will be combined into one packet. 
 
   hooks:
-    $ref: hooklist.yaml
+    $ref: hook_list.yaml
 
   builtin:
     type: boolean
@@ -34,7 +34,7 @@ properties:
         $ref: signallist.yaml
 
       hooks:
-        $ref: hooklist.yaml
+        $ref: hook_list.yaml
 
   out:
     type: object
@@ -44,7 +44,7 @@ properties:
         type: integer
 
       hooks:
-        $ref: hooklist.yaml
+        $ref: hook_list.yaml
 
       netem:
         $ref: netem.yaml

doc/openapi/components/schemas/config/nodes/amqp.yaml

@@ -45,4 +45,4 @@ allOf:
         client_key:
           default: "/path/to/client.key"
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/can.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     format:
       $ref: ../format_spec.yaml
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/comedi.yaml

@@ -6,4 +6,4 @@ allOf:
   properties:
     format:
       $ref: ../format_spec.yaml
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/ethercat.yaml

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

doc/openapi/components/schemas/config/nodes/exec.yaml

@@ -46,4 +46,4 @@ allOf:
           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
+- $ref: ../node.yaml

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

@@ -29,4 +29,4 @@ allOf:
       ```
 
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/fpga.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

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

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

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

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/infiniband.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/influxdb.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/kafka.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/loopback.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/mqtt.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/nanomsg.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/ngsi.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/opal.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/redis.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/rtp.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/shmem.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/signal.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/signal_v2.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/socket.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/stats_node.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/temper.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/test_rtt.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/uldaq.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/websocket.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/nodes/zeromq.yaml

@@ -7,4 +7,4 @@ allOf:
     format:
       $ref: ../format_spec.yaml
 
-- $ref: common.yaml
+- $ref: ../node.yaml

doc/openapi/components/schemas/config/path.yaml

@@ -86,4 +86,4 @@ properties:
       When this flag is set, the original sequence number from the source node will be used when multiplexing the nodes.
 
   hooks:
-    $ref: hooklist.yaml
+    $ref: hook_list.yaml