From c52df4f560e6fc7c2c2bdcbb423adc101f9405d3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 3 Jul 2026 11:25:11 +0000 Subject: [PATCH] Update gRPC Ledger API reference Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- docs-main/docs.json | 3 +- .../com-daml-ledger-api-v2-admin.mdx | 26 +- ...dger-api-v2-interactive-transaction-v1.mdx | 2 +- .../com-daml-ledger-api-v2-interactive.mdx | 6 +- .../com-daml-ledger-api-v2-testing.mdx | 4 +- .../com-daml-ledger-api-v2.mdx | 156 +++-- .../getcompletions.mdx | 575 ++++++++++++++++++ .../grpc-ledger-api-reference/details.mdx | 54 +- 8 files changed, 762 insertions(+), 64 deletions(-) create mode 100644 docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/getcompletions.mdx diff --git a/docs-main/docs.json b/docs-main/docs.json index e219a699a..64022a73e 100644 --- a/docs-main/docs.json +++ b/docs-main/docs.json @@ -813,7 +813,8 @@ "pages": [ { "pages": [ - "reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/completionstream" + "reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/completionstream", + "reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/getcompletions" ], "group": "CommandCompletionService" }, diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-admin.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-admin.mdx index 680347370..cf1a70eeb 100644 --- a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-admin.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-admin.mdx @@ -92,7 +92,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
@@ -131,7 +131,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
@@ -170,7 +170,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/object_meta.proto
@@ -209,7 +209,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/package_management_service.proto
@@ -248,7 +248,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/participant_pruning_service.proto
@@ -287,7 +287,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/party_management_service.proto
@@ -326,7 +326,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/user_management_service.proto
@@ -349,7 +349,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source file
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/command_inspection_service.proto
@@ -423,7 +423,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
Source file
-
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
+
community/ledger-api/src/main/protobuf/com/daml/ledger/api/v2/admin/identity_provider_config_service.proto
@@ -685,7 +685,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
@@ -900,7 +900,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
@@ -974,7 +974,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
@@ -1377,7 +1377,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.admin."
diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive-transaction-v1.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive-transaction-v1.mdx index b6f9166ac..8ae39bb92 100644 --- a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive-transaction-v1.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive-transaction-v1.mdx @@ -92,7 +92,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.interactive.tran diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive.mdx index 9bd4a7f29..d9524a9a0 100644 --- a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-interactive.mdx @@ -92,7 +92,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.interactive." @@ -131,7 +131,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.interactive." @@ -154,7 +154,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.interactive."
diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-testing.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-testing.mdx index e253390af..cf6ab6c70 100644 --- a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-testing.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2-testing.mdx @@ -92,7 +92,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.testing." @@ -115,7 +115,7 @@ description: "Package-level overview for com.daml.ledger.api.v2.testing."
diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2.mdx index 6307c5c25..80b4e2b63 100644 --- a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2.mdx @@ -13,7 +13,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."

v2

-

9 services, 22 endpoints, 120 messages, 8 enums

+

9 services, 23 endpoints, 121 messages, 8 enums

@@ -37,12 +37,12 @@ description: "Package-level overview for com.daml.ledger.api.v2."
Endpoints
-
22
+
23
Messages
-
120
+
121
@@ -92,7 +92,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -121,7 +121,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
Messages
-
2
+
3
@@ -131,7 +131,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -170,7 +170,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -209,7 +209,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -248,7 +248,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -287,7 +287,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -326,7 +326,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -365,7 +365,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -404,7 +404,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -443,7 +443,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -482,7 +482,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -521,7 +521,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -560,7 +560,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -599,7 +599,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -638,7 +638,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -677,7 +677,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -716,7 +716,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -755,7 +755,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -794,7 +794,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -833,7 +833,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -872,7 +872,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -911,7 +911,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -950,7 +950,7 @@ description: "Package-level overview for com.daml.ledger.api.v2." @@ -973,12 +973,12 @@ description: "Package-level overview for com.daml.ledger.api.v2."
Operations
-
1
+
2
@@ -1033,6 +1033,53 @@ description: "Package-level overview for com.daml.ledger.api.v2." + + + +
+

CommandCompletionService.GetCompletions

+ +
+ + gRPC + + Since 3.5.7 + +
+ +
+ +

rpc CommandCompletionService.GetCompletions(com.daml.ledger.api.v2.GetCompletionsRequest) returns (stream com.daml.ledger.api.v2.CompletionStreamResponse);

+ + +
+ +
+
Request
+
com.daml.ledger.api.v2.GetCompletionsRequest
+
+ +
+
Response
+
com.daml.ledger.api.v2.CompletionStreamResponse
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +
+ +
@@ -1047,7 +1094,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1215,7 +1262,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1336,7 +1383,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1410,7 +1457,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1484,7 +1531,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1699,7 +1746,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -1961,7 +2008,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -2176,7 +2223,7 @@ description: "Package-level overview for com.daml.ledger.api.v2."
@@ -5214,6 +5261,41 @@ These are the package-level message and enum shapes in the publish-version snaps +
+ +
+
+

com.daml.ledger.api.v2.GetCompletionsRequest

+ +

2 fields

+ +
+ + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
+ +
+ + +
diff --git a/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/getcompletions.mdx b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/getcompletions.mdx new file mode 100644 index 000000000..a1aa7c0a3 --- /dev/null +++ b/docs-main/reference/grpc-ledger-api-reference/com-daml-ledger-api-v2/commandcompletionservice/getcompletions.mdx @@ -0,0 +1,575 @@ +--- +title: "GetCompletions" +--- + +
+ +
+
+ + + + + +
+ +

com.daml.ledger.api.v2

+ + +

GetCompletions

+ + + +
+ + gRPC + + Since 3.5.7 + +
+ + +
+ +
+ + RPC + + /com.daml.ledger.api.v2.CommandCompletionService/GetCompletions +
+ +## Protocol Details + + +
+ +
+
Protocol
+
gRPC
+
+ +
+
Service
+
CommandCompletionService
+
+ +
+
RPC
+
GetCompletions
+
+ +
+
Client stream
+
No
+
+ +
+
Server stream
+
Yes
+
+ +
+ + +## Inputs + + +
+
+

GetCompletionsRequest

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.GetCompletionsRequest
+
+ +
+
Client stream
+
No
+
+ +
+ + + + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + +
+
+

CompletionStreamResponse

+ +
+ + + +
+ +
+
Message
+
com.daml.ledger.api.v2.CompletionStreamResponse
+
+ +
+
Server stream
+
Yes
+
+ +
+ + + + +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+ + + + + +
+ + + + + +## Lifecycle Changes + +
+ +
+ 3.5.7 + introduced +
+ +
+ + + +## Related Schemas + + + + +
+ + +
+ +
+
+ parties + repeated string + +
+ +
+ +
+
+ begin_exclusive + int64 + +
+ +
+ +
+ + + +
+
+ + +
+ + +
+ +
+
+ completion + Completion + +
+ +
+ +
+
+ offset_checkpoint + OffsetCheckpoint + +
+ +
+ +
+ + + +
+
+ + +
+ + +
+ +
+
+ command_id + string + +
+ +
+ +
+
+ status + Status + +
+ +
+ +
+
+ update_id + string + +
+ +
+ +
+
+ user_id + string + +
+ +
+ +
+
+ act_as + repeated string + +
+ +
+ +
+
+ submission_id + string + +
+ +
+ +
+
+ deduplication_offset + int64 + +
+ +
+ +
+
+ deduplication_duration + Duration + +
+ +
+ +
+
+ trace_context + TraceContext + +
+ +
+ +
+
+ offset + int64 + +
+ +
+ +
+
+ synchronizer_time + SynchronizerTime + +
+ +
+ +
+
+ paid_traffic_cost + int64 + +
+ +
+ +
+ + + +
+
+ + +
+ + +
+ +
+
+ traceparent + string + +
+ +
+ +
+
+ tracestate + string + +
+ +
+ +
+ + + +
+
+ + +
+ + +
+ +
+
+ synchronizer_id + string + +
+ +
+ +
+
+ record_time + Timestamp + +
+ +
+ +
+ + + +
+
+ + +
+ + +
+ +
+
+ offset + int64 + +
+ +
+ +
+
+ synchronizer_times + repeated SynchronizerTime + +
+ +
+ +
+ + + +
+
+ +
+ + +
+ +
+ +
+
+
+ grpcurl + +
+ +```bash grpcurl +# Add -plaintext if the server is not using TLS. +# This RPC uses streaming semantics. Send additional JSON messages on stdin as needed. +grpcurl \ + -d @ \ + \ + com.daml.ledger.api.v2.CommandCompletionService/GetCompletions <<'EOF' +{ + "parties": [ + "string" + ], + "beginExclusive": "0" +} +EOF +``` + +
+
+ +
+
+
+ OK + + application/json + +
+ +```json OK +{ + "completion": { + "commandId": "string", + "status": "string", + "updateId": "string", + "userId": "string", + "actAs": [ + "string" + ], + "submissionId": "string", + "deduplicationOffset": "0" + } +} +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/grpc-ledger-api-reference/details.mdx b/docs-main/reference/grpc-ledger-api-reference/details.mdx index 66c5b46df..3d1e742db 100644 --- a/docs-main/reference/grpc-ledger-api-reference/details.mdx +++ b/docs-main/reference/grpc-ledger-api-reference/details.mdx @@ -18,7 +18,7 @@ description: "Generated Ledger API gRPC reference grouped by package." gRPC - v3.5.6 + v3.5.7
@@ -37,7 +37,7 @@ description: "Generated Ledger API gRPC reference grouped by package."
Latest release
-
v3.5.6
+
v3.5.7
@@ -47,12 +47,12 @@ description: "Generated Ledger API gRPC reference grouped by package."
Endpoints
-
58
+
59
Messages
-
237
+
238
@@ -549,6 +549,46 @@ Counts are shown as added / changed / removed within each release slice.
+ +
+ +
+

3.5.7

+ +
+ + Release + +
+ +
+ +

Endpoint / message / enum deltas for this release.

+ + +
+ +
+
Endpoints
+
1 / 0 / 0
+
+ +
+
Messages
+
1 / 0 / 0
+
+ +
+
Enums
+
0 / 0 / 0
+
+ +
+ + +
+ +
@@ -576,7 +616,7 @@ Counts are shown as added / changed / removed within each release slice.
-

9 services, 22 endpoints, 120 messages, 8 enums

+

9 services, 23 endpoints, 121 messages, 8 enums

@@ -588,12 +628,12 @@ Counts are shown as added / changed / removed within each release slice.
Endpoints
-
22
+
23
Messages
-
120
+
121