Skip to content

Commit

Permalink
chore(gendoc): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@muXxer
muXxer authored Sep 20, 2023
1 parent 4a310a3 commit b342f12
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
3 changes: 2 additions & 1 deletion config_defaults.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@
"/api/core/v3/rewards*",
"/api/core/v3/committee",
"/api/debug/v2/*",
"/api/indexer/v2/*"
"/api/indexer/v2/*",
"/api/mqtt/v2"
],
"protectedRoutes": [
"/api/*"
Expand Down
29 changes: 15 additions & 14 deletions documentation/docs/references/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,19 +176,19 @@ 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/\* |
| 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 |
| [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 @@ -223,7 +223,8 @@ Example:
"/api/core/v3/rewards*",
"/api/core/v3/committee",
"/api/debug/v2/*",
"/api/indexer/v2/*"
"/api/indexer/v2/*",
"/api/mqtt/v2"
],
"protectedRoutes": [
"/api/*"
Expand Down

0 comments on commit b342f12

Please sign in to comment.