Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

Commit 417f372

Browse files
daria305daria305
committed
Update gendoc
1 parent 6d2f501 commit 417f372

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

‎config_defaults.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,7 @@
6464
],
6565
"debugRequestLoggerEnabled": false,
6666
"maxPageSize": 100,
67-
"requestsMemoryCacheGranularity": 10,
68-
"maxRequestedSlotAge": 10,
67+
"maxCacheSize": "50MB",
6968
"jwtAuth": {
7069
"salt": "IOTA"
7170
},

‎documentation/configuration.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -166,17 +166,16 @@ Example:
166166

167167
## <a id="restapi"></a> 5. RestAPI
168168

169-
| Name | Description | Type | Default value |
170-
| ------------------------------ | ---------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
171-
| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:14265" |
172-
| publicRoutes | The HTTP REST routes which can be called without authorization. Wildcards using \* are allowed | array | /health<br/>/api/routes<br/>/api/core/v3/info<br/>/api/core/v3/network\*<br/>/api/core/v3/blocks\*<br/>/api/core/v3/transactions\*<br/>/api/core/v3/commitments\*<br/>/api/core/v3/outputs\*<br/>/api/core/v3/accounts\*<br/>/api/core/v3/validators\*<br/>/api/core/v3/rewards\*<br/>/api/core/v3/committee\*<br/>/api/debug/v2/\*<br/>/api/indexer/v2/\*<br/>/api/mqtt/v2<br/>/api/blockissuer/v1/\* |
173-
| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* |
174-
| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false |
175-
| maxPageSize | The maximum number of results per page | uint | 100 |
176-
| requestsMemoryCacheGranularity | Defines per how many slots a cache is created for big API requests | uint | 10 |
177-
| maxRequestedSlotAge | The maximum age of a request that will be processed | uint | 10 |
178-
| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | |
179-
| [limits](#restapi_limits) | Configuration for limits | object | |
169+
| Name | Description | Type | Default value |
170+
| --------------------------- | ---------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
171+
| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:14265" |
172+
| publicRoutes | The HTTP REST routes which can be called without authorization. Wildcards using \* are allowed | array | /health<br/>/api/routes<br/>/api/core/v3/info<br/>/api/core/v3/network\*<br/>/api/core/v3/blocks\*<br/>/api/core/v3/transactions\*<br/>/api/core/v3/commitments\*<br/>/api/core/v3/outputs\*<br/>/api/core/v3/accounts\*<br/>/api/core/v3/validators\*<br/>/api/core/v3/rewards\*<br/>/api/core/v3/committee\*<br/>/api/debug/v2/\*<br/>/api/indexer/v2/\*<br/>/api/mqtt/v2<br/>/api/blockissuer/v1/\* |
173+
| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* |
174+
| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false |
175+
| maxPageSize | The maximum number of results per page | uint | 100 |
176+
| maxCacheSize | The maximum size of cache for results | string | "50MB" |
177+
| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | |
178+
| [limits](#restapi_limits) | Configuration for limits | object | |
180179

181180
### <a id="restapi_jwtauth"></a> JwtAuth
182181

@@ -220,8 +219,7 @@ Example:
220219
],
221220
"debugRequestLoggerEnabled": false,
222221
"maxPageSize": 100,
223-
"requestsMemoryCacheGranularity": 10,
224-
"maxRequestedSlotAge": 10,
222+
"maxCacheSize": "50MB",
225223
"jwtAuth": {
226224
"salt": "IOTA"
227225
},

0 commit comments

Comments
 (0)