From 28380d4e734371edd8766e6de7be921e2816c7ac Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Thu, 24 Feb 2022 07:03:02 -0500 Subject: [PATCH] openapi: add documentation for new OPAL format --- doc/openapi/components/schemas/config/format.yaml | 6 ++++++ doc/openapi/components/schemas/config/format_obj.yaml | 1 + doc/openapi/components/schemas/config/format_spec.yaml | 1 + .../components/schemas/config/formats/_opal_asyncip.yaml | 3 +++ .../components/schemas/config/formats/opal_asyncip.yaml | 9 +++++++++ 5 files changed, 20 insertions(+) create mode 100644 doc/openapi/components/schemas/config/formats/_opal_asyncip.yaml create mode 100644 doc/openapi/components/schemas/config/formats/opal_asyncip.yaml diff --git a/doc/openapi/components/schemas/config/format.yaml b/doc/openapi/components/schemas/config/format.yaml index e8d330580..3c5ff4d7d 100644 --- a/doc/openapi/components/schemas/config/format.yaml +++ b/doc/openapi/components/schemas/config/format.yaml @@ -18,6 +18,12 @@ properties: description: | If set, include the origin timestamp in the output. + ts_received: + type: boolean + default: true + description: | + If set, include the received timestamp in the output. + sequence: type: boolean default: true diff --git a/doc/openapi/components/schemas/config/format_obj.yaml b/doc/openapi/components/schemas/config/format_obj.yaml index 571a3dfc7..061f5898e 100644 --- a/doc/openapi/components/schemas/config/format_obj.yaml +++ b/doc/openapi/components/schemas/config/format_obj.yaml @@ -18,6 +18,7 @@ discriminator: json.edgeflex: formats/_json_edgeflex.yaml json.kafka: formats/_json_kafka.yaml json.reserve: formats/_json_reserve.yaml + opal.asyncip: formats/_opal_asyncip.yaml protobuf: formats/_protobuf.yaml raw: formats/_raw.yaml tsv: formats/_tsv.yaml diff --git a/doc/openapi/components/schemas/config/format_spec.yaml b/doc/openapi/components/schemas/config/format_spec.yaml index c889a34d8..70c56ffe4 100644 --- a/doc/openapi/components/schemas/config/format_spec.yaml +++ b/doc/openapi/components/schemas/config/format_spec.yaml @@ -16,6 +16,7 @@ oneOf: - json.edgeflex - json.kafka - json.reserve + - opal.asyncip - protobuf - raw - tsv diff --git a/doc/openapi/components/schemas/config/formats/_opal_asyncip.yaml b/doc/openapi/components/schemas/config/formats/_opal_asyncip.yaml new file mode 100644 index 000000000..988eb6c98 --- /dev/null +++ b/doc/openapi/components/schemas/config/formats/_opal_asyncip.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../format_obj.yaml +- $ref: opal_asyncip.yaml diff --git a/doc/openapi/components/schemas/config/formats/opal_asyncip.yaml b/doc/openapi/components/schemas/config/formats/opal_asyncip.yaml new file mode 100644 index 000000000..1d635f985 --- /dev/null +++ b/doc/openapi/components/schemas/config/formats/opal_asyncip.yaml @@ -0,0 +1,9 @@ +# yaml-language-server: $schema=http://json-schema.org/draft-07/schema +--- + +allOf: +- type: object + properties: + dev_id: + type: integer +- $ref: ../format.yaml