From f03579df2fe44b49413904b87047be703013bb54 Mon Sep 17 00:00:00 2001 From: Philipp Jungkamp Date: Tue, 29 Aug 2023 13:32:57 +0200 Subject: [PATCH] hook-reorder-ts: Add OpenAPI specification Signed-off-by: Philipp Jungkamp --- .../components/schemas/config/hook_obj.yaml | 1 + .../schemas/config/hooks/_reorder_ts.yaml | 3 +++ .../schemas/config/hooks/reorder_ts.yaml | 14 ++++++++++++++ 3 files changed, 18 insertions(+) create mode 100644 doc/openapi/components/schemas/config/hooks/_reorder_ts.yaml create mode 100644 doc/openapi/components/schemas/config/hooks/reorder_ts.yaml diff --git a/doc/openapi/components/schemas/config/hook_obj.yaml b/doc/openapi/components/schemas/config/hook_obj.yaml index 240e23f44..81d1cd117 100644 --- a/doc/openapi/components/schemas/config/hook_obj.yaml +++ b/doc/openapi/components/schemas/config/hook_obj.yaml @@ -30,6 +30,7 @@ discriminator: pmu_dft: hooks/_pmu_dft.yaml pps_ts: hooks/_pps_ts.yaml print: hooks/_print.yaml + reorder_ts: hooks/_reorder_ts.yaml restart: hooks/_restart.yaml rms: hooks/_rms.yaml round: hooks/_round.yaml diff --git a/doc/openapi/components/schemas/config/hooks/_reorder_ts.yaml b/doc/openapi/components/schemas/config/hooks/_reorder_ts.yaml new file mode 100644 index 000000000..a562b1945 --- /dev/null +++ b/doc/openapi/components/schemas/config/hooks/_reorder_ts.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../hook_obj.yaml +- $ref: reorder_ts.yaml diff --git a/doc/openapi/components/schemas/config/hooks/reorder_ts.yaml b/doc/openapi/components/schemas/config/hooks/reorder_ts.yaml new file mode 100644 index 000000000..7d284700f --- /dev/null +++ b/doc/openapi/components/schemas/config/hooks/reorder_ts.yaml @@ -0,0 +1,14 @@ +# yaml-language-server: $schema=http://json-schema.org/draft-07/schema +--- + +allOf: +- type: object + properties: + window_size: + description: | + The size of the window in which samples will be reordered. + This also represents the latency in number of samples introduced by this hook. + type: integer + default: 16 + +- $ref: ../hook.yaml