From e9be876d36c561446ead14c983ce602b3a78bdf6 Mon Sep 17 00:00:00 2001 From: pipeacosta Date: Fri, 25 Aug 2023 08:18:20 +0000 Subject: [PATCH] Added the configuration schema for the api_client node type Signed-off-by: pipeacosta --- .../components/schemas/config/node_obj.yaml | 1 + .../schemas/config/nodes/_api_client.yaml | 3 ++ .../schemas/config/nodes/api_client.yaml | 51 +++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 doc/openapi/components/schemas/config/nodes/_api_client.yaml create mode 100644 doc/openapi/components/schemas/config/nodes/api_client.yaml diff --git a/doc/openapi/components/schemas/config/node_obj.yaml b/doc/openapi/components/schemas/config/node_obj.yaml index 43729e15b..e3f502649 100644 --- a/doc/openapi/components/schemas/config/node_obj.yaml +++ b/doc/openapi/components/schemas/config/node_obj.yaml @@ -20,6 +20,7 @@ discriminator: mapping: amqp: nodes/_amqp.yaml api: nodes/_api.yaml + api_client: nodes/_api_client.yaml can: nodes/_can.yaml comedi: nodes/_comedi.yaml ethercat: nodes/_ethercat.yaml diff --git a/doc/openapi/components/schemas/config/nodes/_api_client.yaml b/doc/openapi/components/schemas/config/nodes/_api_client.yaml new file mode 100644 index 000000000..5ff7496ef --- /dev/null +++ b/doc/openapi/components/schemas/config/nodes/_api_client.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../node_obj.yaml +- $ref: api_client.yaml diff --git a/doc/openapi/components/schemas/config/nodes/api_client.yaml b/doc/openapi/components/schemas/config/nodes/api_client.yaml new file mode 100644 index 000000000..f7985bc45 --- /dev/null +++ b/doc/openapi/components/schemas/config/nodes/api_client.yaml @@ -0,0 +1,51 @@ +# yaml-language-server: $schema=http://json-schema.org/draft-07/schema +--- + +allOf: +- $ref: ../node.yaml +- type: object + required: + - endpoint + + properties: + endpoint: + type: string + format: uri + + ssl_verify: + type: boolean + description: Verify SSL certificate against local trust store. + + timeout: + description: Timeout in seconds for HTTP requests. + type: number + default: 1.0 + + rate: + description: Polling rate in Hz for requesting entity updates from broker. + type: number + default: 1.0 + + access_token: + type: string + description: Send 'Auth-Token' header with every HTTP request. + + in: + type: object + required: + - signals + properties: + signals: + type: array + items: + $ref: ./signals/api_signal.yaml + + out: + type: object + required: + - signals + properties: + signals: + type: array + items: + $ref: ./signals/api_signal.yaml