From 8b382e8ae0e9246bb506a82ed844036cd69b678f Mon Sep 17 00:00:00 2001
From: Vishwanath Martur <64204611+vishwamartur@users.noreply.github.com>
Date: Sat, 14 Dec 2024 20:27:43 +0530
Subject: [PATCH] Update REST API docs to include default and max values for
 page_size

Related to #3135

Update REST APIs documentation to include default and max values for `page_size` flag

* **Client Code Changes**
  - Update `getStoreMessagesV3` function in `waku/waku_api/rest/store/client.nim` to set the default value of `page_size` to 20.

* **Handler Code Changes**
  - Update `installStoreApiHandlers` procedure in `waku/waku_api/rest/store/handlers.nim` to enforce the default value of `page_size` to 20.
  - Enforce the max value of `page_size` to 100 in `installStoreApiHandlers` procedure.

* **Documentation Changes**
  - Add a note in `docs/api/rest-api.md` mentioning the default value of `page_size` is 20 and the max value is 100.
  - Add a note in `docs/operators/how-to/configure-rest-api.md` mentioning the default value of `page_size` is 20 and the max value is 100.
---
 docs/api/rest-api.md                        | 3 +++
 docs/operators/how-to/configure-rest-api.md | 3 ++-
 waku/rest_api/endpoint/store/client.nim     | 2 +-
 waku/rest_api/endpoint/store/handlers.nim   | 8 ++++++++
 4 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/docs/api/rest-api.md b/docs/api/rest-api.md
index eeb90abfb..cc8e51020 100644
--- a/docs/api/rest-api.md
+++ b/docs/api/rest-api.md
@@ -38,6 +38,9 @@ A particular OpenAPI spec can be easily imported into [Postman](https://www.post
 curl http://localhost:8645/debug/v1/info -s | jq
 ```
 
+### Store API
+
+The `page_size` flag in the Store API has a default value of 20 and a max value of 100.
 
 ### Node configuration
 Find details [here](https://github.com/waku-org/nwaku/tree/master/docs/operators/how-to/configure-rest-api.md)
diff --git a/docs/operators/how-to/configure-rest-api.md b/docs/operators/how-to/configure-rest-api.md
index 3fe070aab..7a58a798c 100644
--- a/docs/operators/how-to/configure-rest-api.md
+++ b/docs/operators/how-to/configure-rest-api.md
@@ -1,4 +1,3 @@
-
 # Configure a REST API node
 
 A subset of the node configuration can be used to modify the behaviour of the HTTP REST API.
@@ -21,3 +20,5 @@ Example:
 ```shell
 wakunode2 --rest=true
 ```
+
+The `page_size` flag in the Store API has a default value of 20 and a max value of 100.
diff --git a/waku/rest_api/endpoint/store/client.nim b/waku/rest_api/endpoint/store/client.nim
index 80939ee25..71ba7610d 100644
--- a/waku/rest_api/endpoint/store/client.nim
+++ b/waku/rest_api/endpoint/store/client.nim
@@ -57,7 +57,7 @@ proc getStoreMessagesV3*(
   # Optional cursor fields
   cursor: string = "", # base64-encoded hash
   ascending: string = "",
-  pageSize: string = "",
+  pageSize: string = "20", # default value is 20
 ): RestResponse[StoreQueryResponseHex] {.
   rest, endpoint: "/store/v3/messages", meth: HttpMethod.MethodGet
 .}
diff --git a/waku/rest_api/endpoint/store/handlers.nim b/waku/rest_api/endpoint/store/handlers.nim
index 79724b9d7..a0cb403b9 100644
--- a/waku/rest_api/endpoint/store/handlers.nim
+++ b/waku/rest_api/endpoint/store/handlers.nim
@@ -129,6 +129,14 @@ proc createStoreQuery(
     except CatchableError:
       return err("page size parsing error: " & getCurrentExceptionMsg())
 
+  # Enforce default value of page_size to 20
+  if parsedPagedSize.isNone():
+    parsedPagedSize = some(20)
+
+  # Enforce max value of page_size to 100
+  if parsedPagedSize.get() > 100:
+    parsedPagedSize = some(100)
+
   return ok(
     StoreQueryRequest(
       includeData: parsedIncludeData,