From f3135dafc429af026a11e711580b2fca43ccebc6 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Mon, 14 Mar 2022 17:19:57 -0400 Subject: [PATCH] doc: add OpenAPI spec for new webrtc node --- .../components/schemas/config/node_obj.yaml | 1 + .../schemas/config/nodes/_webrtc.yaml | 3 ++ .../schemas/config/nodes/webrtc.yaml | 51 +++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 doc/openapi/components/schemas/config/nodes/_webrtc.yaml create mode 100644 doc/openapi/components/schemas/config/nodes/webrtc.yaml diff --git a/doc/openapi/components/schemas/config/node_obj.yaml b/doc/openapi/components/schemas/config/node_obj.yaml index 07295176e..34d90cb7d 100644 --- a/doc/openapi/components/schemas/config/node_obj.yaml +++ b/doc/openapi/components/schemas/config/node_obj.yaml @@ -46,3 +46,4 @@ discriminator: uldaq: nodes/_uldaq.yaml websocket: nodes/_websocket.yaml zeromq: nodes/_zeromq.yaml + webrtc: nodes/_webrtc.yaml diff --git a/doc/openapi/components/schemas/config/nodes/_webrtc.yaml b/doc/openapi/components/schemas/config/nodes/_webrtc.yaml new file mode 100644 index 000000000..ce9514c00 --- /dev/null +++ b/doc/openapi/components/schemas/config/nodes/_webrtc.yaml @@ -0,0 +1,3 @@ +allOf: +- $ref: ../node_obj.yaml +- $ref: webrtc.yaml diff --git a/doc/openapi/components/schemas/config/nodes/webrtc.yaml b/doc/openapi/components/schemas/config/nodes/webrtc.yaml new file mode 100644 index 000000000..96d507161 --- /dev/null +++ b/doc/openapi/components/schemas/config/nodes/webrtc.yaml @@ -0,0 +1,51 @@ +# yaml-language-server: $schema=http://json-schema.org/draft-07/schema +--- + +allOf: +- type: object + properties: + format: + $ref: ../format_spec.yaml + + session: + type: string + title: Session indentifier + description: A unique session identifier which must be shared between two nodes + + server: + type: string + title: Signaling Server Address + description: Address to the websocket signaling server + default: wss://ws-signal.villas.k8s.eonerc.rwth-aachen.de + + ice: + type: object + title: ICE configuration settings + properties: + servers: + title: ICE Servers + description: A list of ICE servers used for connection establishment + type: array + items: + type: object + title: ICE Server + properties: + urls: + type: array + items: + type: string + format: uri + title: STUN/TURN URI + description: | + A valid Uniform Resource Identifier (URI) indentifying a STUN or TURN server. + + See [RFC7064](https://datatracker.ietf.org/doc/html/rfc7064) and [RFC7065](https://datatracker.ietf.org/doc/html/rfc7065) for details. + + password: + type: string + description: Password for used authentication against TURN servers. + username: + type: string + description: Username for used authentication against TURN servers. + +- $ref: ../node.yaml