Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ A sample configuration file for two participant nodes and a single synchronizer

## Configuration reference

The Canton configuration file for static properties is based on [PureConfig](https://pureconfig.github.io/). PureConfig maps Scala case classes and their class structure into analogue configuration options (see e.g. the [PureConfig quick start](https://pureconfig.github.io/docs/#quick-start) for an example). Therefore, the ultimate source of truth for all available configuration options and the configuration file syntax is given by the [CantonConfig Scala reference](/reference/scala/com-digitalasset-canton-config/cantonconfig) and the related types in `com.digitalasset.canton.config`.
The Canton configuration file for static properties is based on [PureConfig](https://pureconfig.github.io/). PureConfig maps Scala case classes and their class structure into analogue configuration options (see e.g. the [PureConfig quick start](https://pureconfig.github.io/docs/#quick-start) for an example). For the supported configuration options and syntax, see the [Canton configuration reference](/global-synchronizer/reference/configuration-reference).

When understanding the mapping from scaladocs to configuration, please keep in mind that:

- CamelCase Scala names are mapped to lowercase-with-dashes names in configuration files, e.g. `synchronizerParameters` in the scaladocs becomes `synchronizer-parameters` in a configuration file (dash, not underscore).
- `Option[<scala-class>]` means that the configuration can be specified but doesn't need to be, e.g. you can specify a JWT token via `token=token` in [RemoteParticipantConfig](/reference/scala/com-digitalasset-canton-participant-config/remoteparticipantconfig), but not specifying `token` is also valid.
- `Option[<scala-class>]` means that the configuration can be specified but doesn't need to be. For example, a JWT token can be specified via `token=token`, but not specifying `token` is also valid.

## Configuration Compatibility

Expand Down
2 changes: 1 addition & 1 deletion docs-main/openapi/splice/validator/ans-external.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ components:
securitySchemes:
userAuth:
description: |
JWT token as described in [spliceAppBearerAuth](../../../../common/src/main/openapi/common-external.yaml#/components/securitySchemes/spliceAppBearerAuth).
JWT token using the `spliceAppBearerAuth` security scheme.
The subject of the token must be ledger API user of the user affected by the endpoint.
type: http
scheme: bearer
Expand Down
4 changes: 2 additions & 2 deletions docs-main/openapi/splice/validator/validator-internal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -525,14 +525,14 @@ components:
securitySchemes:
userAuth:
description: |
JWT token as described in [spliceAppBearerAuth](../../../../common/src/main/openapi/common-external.yaml#/components/securitySchemes/spliceAppBearerAuth).
JWT token using the `spliceAppBearerAuth` security scheme.
The subject of the token must be ledger API user of the user affected by the endpoint.
type: http
scheme: bearer
bearerFormat: JWT
adminAuth:
description: |
JWT token as described in [spliceAppBearerAuth](../../../../common/src/main/openapi/common-external.yaml#/components/securitySchemes/spliceAppBearerAuth).
JWT token using the `spliceAppBearerAuth` security scheme.
The subject of the token must be ledger API user of the validator operator.
type: http
scheme: bearer
Expand Down
2 changes: 1 addition & 1 deletion docs-main/openapi/splice/validator/wallet-external.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ components:
securitySchemes:
walletUserAuth:
description: |
JWT token as described in [spliceAppBearerAuth]("../../../../common/src/main/openapi/common-external.yaml#/components/securitySchemes/spliceAppBearerAuth").
JWT token using the `spliceAppBearerAuth` security scheme.
The subject of the token must be ledger API user of the user whose wallet the endpoint affects.
type: http
scheme: bearer
Expand Down