From d942b3bf4de787e1e0aa33a57a0d0d4c2599a32d Mon Sep 17 00:00:00 2001 From: Daniel Kaiser Date: Wed, 22 Jun 2022 17:40:12 +0200 Subject: [PATCH] RFC16: add version call (#505) --- content/docs/rfcs/16/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/content/docs/rfcs/16/README.md b/content/docs/rfcs/16/README.md index 99d7720c..d3a1ebea 100644 --- a/content/docs/rfcs/16/README.md +++ b/content/docs/rfcs/16/README.md @@ -81,6 +81,8 @@ The following structured types are defined for use on the Debug API: | `listenAddresses` | `Array`[`String`] | mandatory | Listening addresses of the node | | `enrUri` | `String` | optional | ENR URI of the node | +#### WakuInfo + ### `get_waku_v2_debug_v1_info` The `get_waku_v2_debug_v1_info` method retrieves information about a Waku v2 node @@ -90,8 +92,26 @@ The `get_waku_v2_debug_v1_info` method retrieves information about a Waku v2 nod none #### Response + - [**`WakuInfo`**](#wakuinfo) - information about a Waku v2 node + +### `get_waku_v2_debug_v1_version` + +The `get_waku_v2_debug_v1_version` method retrieves the version of a Waku v2 node as a string. +The version SHOULD follow [semantic versioning](https://semver.org/). +In case the node's current build is based on a git commit between semantic versions, +the retrieved version string MAY contain the git commit hash alone or in combination with the latest semantic version. + +#### Parameters + +none + +#### Response + +- **`string`** - represents the version of a Waku v2 node + + ## Relay API Refer to the [Waku Relay specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-relay.md) for more information on the relaying of messages.