Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inline help: scripts JSON API clarification #9057

Merged
merged 2 commits into from
Mar 9, 2021
Merged
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 @@ -54,12 +54,16 @@ object RunnerConfig {
opt[String]("ledger-host")
.optional()
.action((t, c) => c.copy(ledgerHost = Some(t)))
.text("Ledger hostname")
.text(
"Ledger hostname. If --json-api is specified, this is used to connect to the JSON API and must include the protocol, e.g. \"http://localhost\"."
)

opt[Int]("ledger-port")
.optional()
.action((t, c) => c.copy(ledgerPort = Some(t)))
.text("Ledger port")
.text(
"Ledger port. If --json-api is specified, this is the port used to connect to the JSON API."
)

opt[File]("participant-config")
.optional()
Expand Down Expand Up @@ -101,7 +105,7 @@ object RunnerConfig {
c.copy(accessTokenFile = Some(Paths.get(f)))
}
.text(
"File from which the access token will be read, required to interact with an authenticated ledger"
"File from which the access token will be read, required to interact with an authenticated ledger or the JSON API."
)

TlsConfigurationCli.parse(this, colSpacer = " ")((f, c) =>
Expand All @@ -112,7 +116,9 @@ object RunnerConfig {
.action { (_, c) =>
c.copy(jsonApi = true)
}
.text("Run DAML Script via the HTTP JSON API instead of via gRPC.")
.text(
"Run DAML Script via the HTTP JSON API instead of via gRPC; use --ledger-host and --ledger-port for JSON API host and port. The JSON API requires an access token."
)

opt[Int]("max-inbound-message-size")
.action((x, c) => c.copy(maxInboundMessageSize = x))
Expand Down