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
2 changes: 1 addition & 1 deletion config/x2mdx/ledger-api-asyncapi/source-artifacts.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
{
"version": "3.5",
"canton_version": "3.5.6"
"canton_version": "3.5.7"
}
]
}
8 changes: 8 additions & 0 deletions docs-main/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,47 @@ Use the channel page to choose a specific `publish` or `subscribe` action. Actio
<div class="x2mdx-ref-card-grid">


<a class="x2mdx-ref-card" href="./v2-commands-command-completions/details">

<div class="x2mdx-ref-card-head">
<h3>/v2/commands/command-completions</h3>
</div>
<p class="x2mdx-ref-card-summary">Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``.</p>
<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.5</span>

</div>



<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Actions</dt>
<dd>publish, subscribe</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Last seen</dt>
<dd>3.5</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="./v2-commands-completions/details">

<div class="x2mdx-ref-card-head">
<h3>/v2/commands/completions</h3>
</div>
<p class="x2mdx-ref-card-summary">Subscribe to command completion events.</p>
<p class="x2mdx-ref-card-summary">Deprecated: please use ``GetCompletions`` instead. Subscribe to command completion events.</p>
<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>
Expand Down
Original file line number Diff line number Diff line change
@@ -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``."
---

<p class="x2mdx-ref-back"><a href="../details">Back to overview</a></p>

<div class="x2mdx-ref-hero">

<p class="x2mdx-ref-eyebrow">AsyncAPI Channel</p>


<h1 class="x2mdx-ref-title">/v2/commands/command-completions</h1>


<p class="x2mdx-ref-summary">Subscribe to command completion events. This streaming endpoint provides more flexibility in filtering than the predecessor ``CompletionStream``.</p>


<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.5</span>

</div>


<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Channel</dt>
<dd>/v2/commands/command-completions</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Actions</dt>
<dd>publish, subscribe</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Introduced</dt>
<dd>3.5</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Removed</dt>
<dd>-</dd>
</div>

</dl>

</div>


## Actions


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



<div class="x2mdx-ref-card-grid">


<a class="x2mdx-ref-card" href="./publish">

<div class="x2mdx-ref-card-head">
<h3>publish /v2/commands/command-completions</h3>
</div>
<p class="x2mdx-ref-card-summary">Publish GetCompletionsRequest messages from the client to /v2/commands/command-completions.</p>
<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.5</span>

</div>



<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Operation ID</dt>
<dd>sendV2CommandsCommand-completions</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Method</dt>
<dd>-</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Payload</dt>
<dd>object</dd>
</div>

</dl>


</a>



<a class="x2mdx-ref-card" href="./subscribe">

<div class="x2mdx-ref-card-head">
<h3>subscribe /v2/commands/command-completions</h3>
</div>
<p class="x2mdx-ref-card-summary">Receive Either_JsCantonError_CompletionStreamResponse messages from /v2/commands/command-completions on the subscription stream.</p>
<div class="x2mdx-ref-badges">

<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">WebSocket</span>

<span class="x2mdx-ref-badge x2mdx-ref-badge--added">Since 3.5</span>

</div>



<dl class="x2mdx-ref-meta-grid">

<div class="x2mdx-ref-meta-item">
<dt>Operation ID</dt>
<dd>onV2CommandsCommand-completions</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Method</dt>
<dd>-</dd>
</div>

<div class="x2mdx-ref-meta-item">
<dt>Payload</dt>
<dd>oneOf</dd>
</div>

</dl>


</a>


</div>
Loading