Skip to content

Commit

Permalink
Merge pull request #357 from iotaledger/chore/gendoc
Browse files Browse the repository at this point in the history 
chore(gendoc): update docs
  • Loading branch information
@karimodm
karimodm authored Sep 21, 2023
2 parents b920858 + 982b617 commit de5a03c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
2 changes: 2 additions & 0 deletions config_defaults.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
"debugRequestLoggerEnabled": false,
"allowIncompleteBlock": false,
"maxPageSize": 100,
"requestsMemoryCacheGranularity": 10,
"maxRequestedSlotAge": 10,
"jwtAuth": {
"salt": "IOTA"
},
Expand Down
30 changes: 17 additions & 13 deletions documentation/docs/references/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,19 +176,21 @@ Example:

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

| Name | Description | Type | Default value |
| --------------------------- | ---------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | Whether the REST API plugin is enabled | boolean | true |
| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:8080" |
| 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/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 |
| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* |
| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false |
| allowIncompleteBlock | Whether the node allows to fill in incomplete block and issue it for user | boolean | false |
| maxPageSize | The maximum number of results per page | uint | 100 |
| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | |
| [limits](#restapi_limits) | Configuration for limits | object | |
| blockIssuerAccount | The accountID of the account that will issue the blocks | string | "" |
| blockIssuerPrivateKey | The private key of the account that will issue the blocks | string | "" |
| Name | Description | Type | Default value |
| ------------------------------ | ---------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | Whether the REST API plugin is enabled | boolean | true |
| bindAddress | The bind address on which the REST API listens on | string | "0.0.0.0:8080" |
| 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/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 |
| protectedRoutes | The HTTP REST routes which need to be called with authorization. Wildcards using \* are allowed | array | /api/\* |
| debugRequestLoggerEnabled | Whether the debug logging for requests should be enabled | boolean | false |
| allowIncompleteBlock | Whether the node allows to fill in incomplete block and issue it for user | boolean | false |
| maxPageSize | The maximum number of results per page | uint | 100 |
| requestsMemoryCacheGranularity | Defines per how many slots a cache is created for big API requests | uint | 10 |
| maxRequestedSlotAge | The maximum age of a request that will be processed | uint | 10 |
| [jwtAuth](#restapi_jwtauth) | Configuration for jwtAuth | object | |
| [limits](#restapi_limits) | Configuration for limits | object | |
| blockIssuerAccount | The accountID of the account that will issue the blocks | string | "" |
| blockIssuerPrivateKey | The private key of the account that will issue the blocks | string | "" |

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

Expand Down Expand Up @@ -232,6 +234,8 @@ Example:
"debugRequestLoggerEnabled": false,
"allowIncompleteBlock": false,
"maxPageSize": 100,
"requestsMemoryCacheGranularity": 10,
"maxRequestedSlotAge": 10,
"jwtAuth": {
"salt": "IOTA"
},
Expand Down

0 comments on commit de5a03c

Please sign in to comment.