chore:lack of info for REST APIs #3135
Labels
effort/hours
Estimated to be completed in a few hours
Comments
vishwamartur
added a commit
to vishwamartur/nwaku
that referenced
this issue
Dec 14, 2024
Related to waku-org#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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Background
lack of info in REST APIs documentation [...]
Details
Accroding to the Documentation for APIs usage here
page_size flag has no default or max value despite that default value is 20 and max is 100
Acceptance criteria
default and max value shall be mentioned in the REST APIs guide for better user experience and testing
The text was updated successfully, but these errors were encountered: