mirror of
https://github.com/logos-messaging/logos-messaging-nim.git
synced 2026-01-24 16:53:10 +00:00
8b382e8ae0
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.
25 lines
923 B
Markdown
25 lines
923 B
Markdown
# Configure a REST API node
|
|
|
|
A subset of the node configuration can be used to modify the behaviour of the HTTP REST API.
|
|
|
|
These are the relevant command line options:
|
|
|
|
| CLI option | Description | Default value |
|
|
|------------|-------------|---------------|
|
|
|`--rest` | Enable Waku REST HTTP server. | `false` |
|
|
|`--rest-address` | Listening address of the REST HTTP server. | `127.0.0.1` |
|
|
|`--rest-port` | Listening port of the REST HTTP server. | `8645` |
|
|
|`--rest-relay-cache-capacity` | Capacity of the Relay REST API message cache. | `30` |
|
|
|`--rest-admin` | Enable access to REST HTTP Admin API. | `false` |
|
|
|`--rest-private` | Enable access to REST HTTP Private API. | `false` |
|
|
|
|
Note that these command line options have their counterpart option in the node configuration file.
|
|
|
|
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.
|