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

Commit

Permalink
Make all blockissuer routes public
Browse files Browse the repository at this point in the history
  • Loading branch information
@muXxer
muXxer committed Feb 6, 2024
1 parent 725aa94 commit dfaea54
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion components/restapi/params.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ var ParamsRestAPI = &ParametersRestAPI{
"/api/debug/v2/*",
"/api/indexer/v2/*",
"/api/mqtt/v2",
"/api/blockissuer/v1",
"/api/blockissuer/v1/*",
},
ProtectedRoutes: []string{
"/api/*",
Expand Down
2 changes: 1 addition & 1 deletion config_defaults.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"/api/debug/v2/*",
"/api/indexer/v2/*",
"/api/mqtt/v2",
"/api/blockissuer/v1"
"/api/blockissuer/v1/*"
],
"protectedRoutes": [
"/api/*"
Expand Down
26 changes: 13 additions & 13 deletions documentation/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,18 +156,18 @@ 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:14265" |
| 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<br/>/api/blockissuer/v1 |
| 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 |
| 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 | |
| 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:14265" |
| 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<br/>/api/blockissuer/v1/\* |
| 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 |
| 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 | |

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

Expand Down Expand Up @@ -204,7 +204,7 @@ Example:
"/api/debug/v2/*",
"/api/indexer/v2/*",
"/api/mqtt/v2",
"/api/blockissuer/v1"
"/api/blockissuer/v1/*"
],
"protectedRoutes": [
"/api/*"
Expand Down

0 comments on commit dfaea54

Please sign in to comment.