From 42fb7520ce07062785ab0a1107d6292fd097258b Mon Sep 17 00:00:00 2001 From: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com> Date: Wed, 5 May 2021 11:26:23 -0700 Subject: [PATCH] Makes the arguments of the store jsonrpc api optional (#361) * makes contentFilters and pubsubtopic optional * revision * correction on the query examples * converts content filter to an object --- content/docs/rfcs/16/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/rfcs/16/README.md b/content/docs/rfcs/16/README.md index 0433793d..500c9de0 100644 --- a/content/docs/rfcs/16/README.md +++ b/content/docs/rfcs/16/README.md @@ -218,8 +218,8 @@ The `get_waku_v2_store_v1_messages` method retrieves historical messages on spec | Field | Type | Inclusion | Description | | ----: | :---: | :---: |----------- | -| `pubsubTopic` | `String` | mandatory | The pubsub topic on which a [`WakuMessage`](#WakuMessage) is published | -| `contentFilters` | `Array`[[`ContentFilter`](#contentfilter)] | mandatory | Array of content filters to query for historical messages | +| `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 | | `pagingOptions` | [`PagingOptions`](#PagingOptions) | optional | Pagination information | #### Response @@ -452,7 +452,7 @@ This method is part of the `store` API and the specific resources to retrieve ar #### Request -```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":["", ["/waku/2/default-content/proto"]]}' --header "Content-Type: application/json" http://localhost:8545``` +```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":["", [{"contentTopic":"/waku/2/default-content/proto"}]]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc { @@ -510,7 +510,7 @@ This method is part of the `store` API and the specific resources to retrieve ar #### Request -```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[ "", ["/waku/2/default-content/proto"],{"pageSize":2,"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` +```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[ "", [{"contentTopic":"/waku/2/default-content/proto"}],{"pageSize":2,"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc { @@ -572,7 +572,7 @@ This method is part of the `store` API and the specific resources to retrieve ar #### Request -```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[ "", ["/waku/2/default-content/proto"],{"pageSize":2,"cursor":{"digest":"abcdef","receivedTime":1605887187.00},"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` +```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[ "", [{"contentTopic":"/waku/2/default-content/proto"}],{"pageSize":2,"cursor":{"digest":"abcdef","receivedTime":1605887187.00},"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc {