From c456e204066dc4de831b209022f69d1eb5a9463c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 3 Jul 2026 06:17:21 +0000 Subject: [PATCH] Update JSON Ledger API AsyncAPI reference Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../ledger-api-asyncapi/source-artifacts.json | 2 +- docs-main/docs.json | 8 + .../operations/details.mdx | 37 ++- .../details.mdx | 146 +++++++++++ .../publish.mdx | 248 ++++++++++++++++++ .../subscribe.mdx | 236 +++++++++++++++++ .../v2-commands-completions/details.mdx | 6 +- 7 files changed, 679 insertions(+), 4 deletions(-) create mode 100644 docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/details.mdx create mode 100644 docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/publish.mdx create mode 100644 docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/subscribe.mdx diff --git a/config/x2mdx/ledger-api-asyncapi/source-artifacts.json b/config/x2mdx/ledger-api-asyncapi/source-artifacts.json index ad11aedd7..2835e8cf4 100644 --- a/config/x2mdx/ledger-api-asyncapi/source-artifacts.json +++ b/config/x2mdx/ledger-api-asyncapi/source-artifacts.json @@ -11,7 +11,7 @@ }, { "version": "3.5", - "canton_version": "3.5.6" + "canton_version": "3.5.7" } ] } diff --git a/docs-main/docs.json b/docs-main/docs.json index e219a699a..126584b7d 100644 --- a/docs-main/docs.json +++ b/docs-main/docs.json @@ -758,6 +758,14 @@ { "group": "AsyncAPI", "pages": [ + { + "group": "/v2/commands/command-completions", + "pages": [ + "reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/publish", + "reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/subscribe", + "reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/details" + ] + }, { "group": "/v2/commands/completions", "pages": [ diff --git a/docs-main/reference/json-api-asyncapi-reference/operations/details.mdx b/docs-main/reference/json-api-asyncapi-reference/operations/details.mdx index 63c6f50b9..92d7a890a 100644 --- a/docs-main/reference/json-api-asyncapi-reference/operations/details.mdx +++ b/docs-main/reference/json-api-asyncapi-reference/operations/details.mdx @@ -60,12 +60,47 @@ Use the channel page to choose a specific `publish` or `subscribe` action. Actio
+ + +
+

/v2/commands/command-completions

+
+

Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``.

+
+ + WebSocket + + Since 3.5 + +
+ + + +
+ +
+
Actions
+
publish, subscribe
+
+ +
+
Last seen
+
3.5
+
+ +
+ + + + + +

/v2/commands/completions

-

Subscribe to command completion events.

+

Deprecated: please use ``GetCompletions`` instead. Subscribe to command completion events.

WebSocket diff --git a/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/details.mdx b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/details.mdx new file mode 100644 index 000000000..1cba1a4ab --- /dev/null +++ b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/details.mdx @@ -0,0 +1,146 @@ +--- +title: "Details and history" +description: "Subscribe to command completion events. +This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``." +--- + +

Back to overview

+ +
+ +

AsyncAPI Channel

+ + +

/v2/commands/command-completions

+ + +

Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``.

+ + +
+ + WebSocket + + Since 3.5 + +
+ + +
+ +
+
Channel
+
/v2/commands/command-completions
+
+ +
+
Actions
+
publish, subscribe
+
+ +
+
Introduced
+
3.5
+
+ +
+
Removed
+
-
+
+ +
+ +
+ + +## Actions + + +Subscribe to command completion events. +This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``. + + + +
+ + + + +
+

publish /v2/commands/command-completions

+
+

Publish GetCompletionsRequest messages from the client to /v2/commands/command-completions.

+
+ + WebSocket + + Since 3.5 + +
+ + + +
+ +
+
Operation ID
+
sendV2CommandsCommand-completions
+
+ +
+
Method
+
-
+
+ +
+
Payload
+
object
+
+ +
+ + + + + + + + +
+

subscribe /v2/commands/command-completions

+
+

Receive Either_JsCantonError_CompletionStreamResponse messages from /v2/commands/command-completions on the subscription stream.

+
+ + WebSocket + + Since 3.5 + +
+ + + +
+ +
+
Operation ID
+
onV2CommandsCommand-completions
+
+ +
+
Method
+
-
+
+ +
+
Payload
+
oneOf
+
+ +
+ + + + + +
diff --git a/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/publish.mdx b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/publish.mdx new file mode 100644 index 000000000..b4d84482a --- /dev/null +++ b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/publish.mdx @@ -0,0 +1,248 @@ +--- +title: "Publish command completions" +--- + +
+ +
+
+ + + + + +
+ +

/v2/commands/command-completions

+ + +

Publish command completions

+ + + +
+ + WebSocket + + Since 3.5 + +
+ + +
+ +
+ + PUBLISH + + /v2/commands/command-completions +
+ +## Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/commands/command-completions
+
+ +
+
Action
+
publish
+
+ +
+
Operation ID
+
sendV2CommandsCommand-completions
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
object
+
+ +
+ + +## Inputs + + +
+
+

GetCompletionsRequest

+ +
+ + + +
+ +
+
Direction
+
Client -> Server
+
+ +
+
Message
+
GetCompletionsRequest
+
+ +
+ + + + +
+ +
+
+ parties + array[string] + +
+ +
+ +
+
+ beginExclusive + string + +
+ +
+ +
+ + + + + +
+ + +## Outputs + + + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ parties + array[string] + +
+ +
+ +
+
+ beginExclusive + string + +
+ +
+ +
+ + + +
+ + + + + +
+ +
+ +
+
+
+ wscat + +
+ +```bash wscat +npx wscat \ + -c \ + -x '{"parties": [""], "beginExclusive": ""}' \ + -w -1 +``` + +
+
+ +
+
+
+ message + + application/json + +
+ +```json message +{ + "parties": [ + "" + ], + "beginExclusive": "" +} +``` + +
+
+ +
+ +
diff --git a/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/subscribe.mdx b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/subscribe.mdx new file mode 100644 index 000000000..8886097d5 --- /dev/null +++ b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-command-completions/subscribe.mdx @@ -0,0 +1,236 @@ +--- +title: "Subscribe command completions" +--- + +
+ +
+
+ + + + + +
+ +

/v2/commands/command-completions

+ + +

Subscribe command completions

+ + + +
+ + WebSocket + + Since 3.5 + +
+ + +
+ +
+ + + + /v2/commands/command-completions +
+ +## Protocol Details + + +
+ +
+
Protocol
+
WebSocket
+
+ +
+
Channel
+
/v2/commands/command-completions
+
+ +
+
Action
+
subscribe
+
+ +
+
Operation ID
+
onV2CommandsCommand-completions
+
+ +
+
Content type
+
application/json
+
+ +
+
Payload
+
oneOf
+
+ +
+ + +## Inputs + + + +## Outputs + + +
+
+

Either_JsCantonError_CompletionStreamResponse

+ +
+ + + +
+ +
+
Direction
+
Server -> Client
+
+ +
+
Message
+
Either_JsCantonError_CompletionStreamResponse
+
+ +
+ + + + +
+ +
+
+ completionResponse + object + +
+ +
+ +
+ + + + + +
+ + + + + + + +## Related Schemas + + + + +
+ + +
+ +
+
+ completionResponse + object + +
+ +
+ +
+ + + +
+ + + + + +
+ +
+ +
+
+
+ wscat + +
+ +```bash wscat +npx wscat -c +``` + +
+
+ +
+
+
+ message + + application/json + +
+ +```json message +{ + "completionResponse": { + "Completion": { + "value": { + "commandId": "", + "userId": "", + "actAs": [ + "" + ], + "offset": "", + "synchronizerTime": "" + } + } + } +} +``` + + + + + + + diff --git a/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-completions/details.mdx b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-completions/details.mdx index 8cc06eb9e..459858f3d 100644 --- a/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-completions/details.mdx +++ b/docs-main/reference/json-api-asyncapi-reference/operations/v2-commands-completions/details.mdx @@ -1,6 +1,7 @@ --- title: "Details and history" -description: "Subscribe to command completion events." +description: "Deprecated: please use ``GetCompletions`` instead. +Subscribe to command completion events." ---

Back to overview

@@ -13,7 +14,7 @@ description: "Subscribe to command completion events."

/v2/commands/completions

-

Subscribe to command completion events.

+

Deprecated: please use ``GetCompletions`` instead. Subscribe to command completion events.

@@ -57,6 +58,7 @@ description: "Subscribe to command completion events." ## Actions +Deprecated: please use ``GetCompletions`` instead. Subscribe to command completion events.