Update REST API docs to include default and max values for page_size #3210
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted. Details:
Available types:
|
…ult and max values for `page_size` * Set default value of `page_size` to 20 and max value to 100 in `getStoreMessagesV3` function in `waku/waku_api/rest/store/client.nim` * Enforce default value of `page_size` to 20 and max value to 100 in `installStoreApiHandlers` procedure in `waku/waku_api/rest/store/handlers.nim` * Add notes in `docs/api/rest-api.md` and `docs/operators/how-to/configure-rest-api.md` mentioning the default and max values for `page_size`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #3135
Update REST APIs documentation to include default and max values for
page_sizeflagClient Code Changes
getStoreMessagesV3function inwaku/waku_api/rest/store/client.nimto set the default value ofpage_sizeto 20.Handler Code Changes
installStoreApiHandlersprocedure inwaku/waku_api/rest/store/handlers.nimto enforce the default value ofpage_sizeto 20.page_sizeto 100 ininstallStoreApiHandlersprocedure.Documentation Changes
docs/api/rest-api.mdmentioning the default value ofpage_sizeis 20 and the max value is 100.docs/operators/how-to/configure-rest-api.mdmentioning the default value ofpage_sizeis 20 and the max value is 100.