From 3d8f42d4576ecf9702ded1352dd040a41a56dbce Mon Sep 17 00:00:00 2001 From: Franck R Date: Fri, 25 Feb 2022 12:21:22 +1100 Subject: [PATCH] Fix markdown links (#493) --- content/docs/rfcs/16/README.md | 40 +++++++++++++++++----------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/content/docs/rfcs/16/README.md b/content/docs/rfcs/16/README.md index dec5e838..052084f9 100644 --- a/content/docs/rfcs/16/README.md +++ b/content/docs/rfcs/16/README.md @@ -89,7 +89,7 @@ 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 +- [**`WakuInfo`**](#wakuinfo) - information about a Waku v2 node ## Relay API @@ -110,7 +110,7 @@ The following structured types are defined for use on the Relay API: | `timestamp` | `Number` | optional | The time at which the message is generated by its sender. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. | - > **_NOTE:_** `WakuRelayMessage` maps directly to a [`WakuMessage`](#WakuMessage), except that the latter contains an explicit message `version`. For `WakuRelay` purposes, the versioning is handled by the API. + > **_NOTE:_** `WakuRelayMessage` maps directly to a [`WakuMessage`](#wakumessage), except that the latter contains an explicit message `version`. For `WakuRelay` purposes, the versioning is handled by the API. ### `post_waku_v2_relay_v1_message` @@ -121,7 +121,7 @@ The `post_waku_v2_relay_v1_message` method publishes a message to be relayed on | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | | `topic` | `String` | mandatory | The [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being published on | -| `message` | [`WakuRelayMessage`](#WakuRelayMessage) | mandatory | The `message` being relayed | +| `message` | [`WakuRelayMessage`](#wakurelaymessage) | mandatory | The `message` being relayed | #### Response @@ -167,7 +167,7 @@ The `get_waku_v2_relay_v1_messages` method returns a list of messages that were #### Response -- **`Array`[[`WakuMessage`](#WakuMessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. +- **`Array`[[`WakuMessage`](#wakumessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ## Store API @@ -183,8 +183,8 @@ The following structured types are defined for use on the Store API: | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `messages` | `Array`[[`WakuMessage`](#WakuMessage)] | mandatory | Array of retrieved historical messages | -| `pagingOptions` | [`PagingOptions`](#PagingOptions) | [conditional](#get_waku_v2_store_v1_messages) | Paging information from which to resume further historical queries | +| `messages` | `Array`[[`WakuMessage`](#wakumessage)] | mandatory | Array of retrieved historical messages | +| `pagingOptions` | [`PagingOptions`](#pagingOptions) | [conditional](#get_waku_v2_store_v1_messages) | Paging information from which to resume further historical queries | #### PagingOptions @@ -212,25 +212,25 @@ The following structured types are defined for use on the Store API: | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `contentTopic` | `String` | mandatory | The content topic of a [`WakuMessage`](#WakuMessage) | +| `contentTopic` | `String` | mandatory | The content topic of a [`WakuMessage`](#wakumessage) | ### `get_waku_v2_store_v1_messages` -The `get_waku_v2_store_v1_messages` method retrieves historical messages on specific content topics. This method MAY be called with [`PagingOptions`](#PagingOptions), to retrieve historical messages on a per-page basis. If the request included [`PagingOptions`](#PagingOptions), the node MUST return messages on a per-page basis and include [`PagingOptions`](#PagingOptions) in the response. These [`PagingOptions`](#PagingOptions) MUST contain a `cursor` pointing to the [`Index`](#Index) from which a new page can be requested. +The `get_waku_v2_store_v1_messages` method retrieves historical messages on specific content topics. This method MAY be called with [`PagingOptions`](#pagingoptions), to retrieve historical messages on a per-page basis. If the request included [`PagingOptions`](#pagingoptions), the node MUST return messages on a per-page basis and include [`PagingOptions`](#pagingoptions) in the response. These [`PagingOptions`](#pagingoptions) MUST contain a `cursor` pointing to the [`Index`](#Index) from which a new page can be requested. #### Parameters | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `pubsubTopic` | `String` | optional | The pubsub topic on which a [`WakuMessage`](#WakuMessage) is published | +| `pubsubTopic` | `String` | optional | The pubsub topic on which a [`WakuMessage`](#wakumessage) is published | | `contentFilters` | `Array`[[`ContentFilter`](#contentfilter)] | optional | Array of content filters to query for historical messages | -| `startTime` | `Number`| optional | The inclusive lower bound on the [`timestamp`](/spec/14#Payloads) of queried [`WakuMessage`s](#WakuMessage). This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. | -| `endTime` | `Number` | optional | The inclusive upper bound on the [`timestamp`](/spec/14#Payloads) of queried [`WakuMessage`s](#WakuMessage). This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. | -| `pagingOptions` | [`PagingOptions`](#PagingOptions) | optional | Pagination information | +| `startTime` | `Number`| optional | The inclusive lower bound on the [`timestamp`](/spec/14#Payloads) of queried [`WakuMessage`s](#wakumessage). This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. | +| `endTime` | `Number` | optional | The inclusive upper bound on the [`timestamp`](/spec/14#Payloads) of queried [`WakuMessage`s](#wakumessage). This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. | +| `pagingOptions` | [`PagingOptions`](#pagingoptions) | optional | Pagination information | #### Response -- [**`StoreResponse`**](#StoreResponse) - the response to a `query` for historical messages. +- [**`StoreResponse`**](#storeresponse) - the response to a `query` for historical messages. ## Filter API @@ -256,7 +256,7 @@ The `post_waku_v2_filter_v1_subscription` method creates a subscription in a [li | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `contentFilters` | `Array`[[`ContentFilter`](#ContentFilter)] | mandatory | Array of content filters being subscribed to | +| `contentFilters` | `Array`[[`ContentFilter`](#contentfilter)] | mandatory | Array of content filters being subscribed to | | `topic` | `String` | optional | Message topic | #### Response @@ -271,7 +271,7 @@ The `delete_waku_v2_filter_v1_subscription` method removes subscriptions in a [l | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `contentFilters` | `Array`[[`ContentFilter`](#ContentFilter)] | mandatory | Array of content filters being unsubscribed from | +| `contentFilters` | `Array`[[`ContentFilter`](#contentfilter)] | mandatory | Array of content filters being unsubscribed from | | `topic` | `String` | optional | Message topic | #### Response @@ -290,7 +290,7 @@ The `get_waku_v2_filter_v1_messages` method returns a list of messages that were #### Response -- **`Array`[[`WakuMessage`](#WakuMessage)]** - the latest `messages` on the polled content `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. +- **`Array`[[`WakuMessage`](#wakumessage)]** - the latest `messages` on the polled content `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ## Admin API @@ -387,7 +387,7 @@ Before being relayed, the message payload is encrypted using the supplied symmet | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | | `topic` | `String` | mandatory | The [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being published on | -| `message` | [`WakuRelayMessage`](#WakuRelayMessage) | mandatory | The (unencrypted) `message` being relayed | +| `message` | [`WakuRelayMessage`](#wakurelaymessage) | mandatory | The (unencrypted) `message` being relayed | | `symkey` | `String` | mandatory | The hex encoded symmetric key to use for payload encryption. This field MUST be included if symmetric key cryptography is selected | #### Response @@ -405,7 +405,7 @@ Before being relayed, the message payload is encrypted using the supplied public | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | | `topic` | `String` | mandatory | The [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being published on | -| `message` | [`WakuRelayMessage`](#WakuRelayMessage) | mandatory | The (unencrypted) `message` being relayed | +| `message` | [`WakuRelayMessage`](#wakurelaymessage) | mandatory | The (unencrypted) `message` being relayed | | `publicKey` | `String` | mandatory | The hex encoded public key to use for payload encryption. This field MUST be included if asymmetric key cryptography is selected | #### Response @@ -427,7 +427,7 @@ Before returning the messages, the server decrypts the message payloads using th #### Response -- **`Array`[[`WakuRelayMessage`](#WakuRelayMessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. +- **`Array`[[`WakuRelayMessage`](#wakurelaymessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ### `get_waku_v2_private_v1_asymmetric_messages` @@ -444,7 +444,7 @@ Before returning the messages, the server decrypts the message payloads using th #### Response -- **`Array`[[`WakuRelayMessage`](#WakuRelayMessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. +- **`Array`[[`WakuRelayMessage`](#wakurelaymessage)]** - the latest `messages` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. # Example usage