From e8ae22acc5725404e2bb244ac7b8e0089fbb750c Mon Sep 17 00:00:00 2001 From: Gabriel mermelstein Date: Fri, 25 Oct 2024 11:42:35 +0300 Subject: [PATCH 1/3] specifying that the messages in relay and filter endpoints come from a cache of size 50 --- api-spec/filterapi_v2_messages.yaml | 2 +- api-spec/relayapi_auto_content_topic.yaml | 2 +- api-spec/relayapi_messages.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api-spec/filterapi_v2_messages.yaml b/api-spec/filterapi_v2_messages.yaml index 59dea60..3439e76 100644 --- a/api-spec/filterapi_v2_messages.yaml +++ b/api-spec/filterapi_v2_messages.yaml @@ -1,7 +1,7 @@ # /filter/v2/messages/{contentTopic}: get: # get_waku_v2_filter_v2_messages summary: Get the latest messages on the polled content topic - description: Get a list of messages that were received on a subscribed content topic after the last time this method was called. + description: Get a list of messages that were received on a subscribed content topic after the last time this method was called. Messages are selected from the last 50 messages received by the node. operationId: getMessagesByTopic tags: - filter diff --git a/api-spec/relayapi_auto_content_topic.yaml b/api-spec/relayapi_auto_content_topic.yaml index 8cb06f0..60540a9 100644 --- a/api-spec/relayapi_auto_content_topic.yaml +++ b/api-spec/relayapi_auto_content_topic.yaml @@ -1,7 +1,7 @@ # /relay/v1/auto/messages/{contentTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_auto_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. + description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. Messages are selected from the last 50 messages received by the node. operationId: getMessagesByTopic tags: - relay diff --git a/api-spec/relayapi_messages.yaml b/api-spec/relayapi_messages.yaml index 898a1da..2ca844f 100644 --- a/api-spec/relayapi_messages.yaml +++ b/api-spec/relayapi_messages.yaml @@ -1,7 +1,7 @@ # /relay/v1/messages/{pubsubTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. + description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. Messages are selected from the last 50 messages received by the node. operationId: getMessagesByTopic tags: - relay From 13176a4c9124d8a0e57022d9b9a211228cdba990 Mon Sep 17 00:00:00 2001 From: Gabriel mermelstein Date: Fri, 25 Oct 2024 17:18:59 +0300 Subject: [PATCH 2/3] fixing description for relay --- api-spec/relayapi_auto_content_topic.yaml | 2 +- api-spec/relayapi_messages.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-spec/relayapi_auto_content_topic.yaml b/api-spec/relayapi_auto_content_topic.yaml index 60540a9..a1d34d8 100644 --- a/api-spec/relayapi_auto_content_topic.yaml +++ b/api-spec/relayapi_auto_content_topic.yaml @@ -1,7 +1,7 @@ # /relay/v1/auto/messages/{contentTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_auto_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. Messages are selected from the last 50 messages received by the node. + description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI parameter. operationId: getMessagesByTopic tags: - relay diff --git a/api-spec/relayapi_messages.yaml b/api-spec/relayapi_messages.yaml index 2ca844f..868bf4b 100644 --- a/api-spec/relayapi_messages.yaml +++ b/api-spec/relayapi_messages.yaml @@ -1,7 +1,7 @@ # /relay/v1/messages/{pubsubTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. Messages are selected from the last 50 messages received by the node. + description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI parameter. operationId: getMessagesByTopic tags: - relay From f10d247a43c7c15032720f086d0d9cd39ad085eb Mon Sep 17 00:00:00 2001 From: Gabriel mermelstein Date: Fri, 25 Oct 2024 17:21:13 +0300 Subject: [PATCH 3/3] using word argument instead of parameter --- api-spec/relayapi_auto_content_topic.yaml | 2 +- api-spec/relayapi_messages.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-spec/relayapi_auto_content_topic.yaml b/api-spec/relayapi_auto_content_topic.yaml index a1d34d8..6188201 100644 --- a/api-spec/relayapi_auto_content_topic.yaml +++ b/api-spec/relayapi_auto_content_topic.yaml @@ -1,7 +1,7 @@ # /relay/v1/auto/messages/{contentTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_auto_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI parameter. + description: Get a list of messages that were received on a subscribed Content topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI argument. operationId: getMessagesByTopic tags: - relay diff --git a/api-spec/relayapi_messages.yaml b/api-spec/relayapi_messages.yaml index 868bf4b..9251876 100644 --- a/api-spec/relayapi_messages.yaml +++ b/api-spec/relayapi_messages.yaml @@ -1,7 +1,7 @@ # /relay/v1/messages/{pubsubTopic}: # Note the plural in messages get: # get_waku_v2_relay_v1_messages summary: Get the latest messages on the polled topic - description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI parameter. + description: Get a list of messages that were received on a subscribed PubSub topic after the last time this method was called. By default, messages are selected from the last 30 messages received by the node. You can modify the number of cached messages with the --rest-relay-cache-capacity CLI argument. operationId: getMessagesByTopic tags: - relay