Skip to content

Commit

Permalink
Clarify the distinction between local and fully qualified IDs.
Browse files Browse the repository at this point in the history
This is currently only relevant to the workflows and exchanges APIs
so it is added to that section.
  • Loading branch information
jrhender committed Jan 27, 2025
1 parent ace3da6 commit fdf8d87
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,12 @@ <h3>Workflows and Exchanges</h3>
<table class="simple api-summary-table"
data-api-path="/workflows /workflows/{localWorkflowId} /workflows/{localWorkflowId}/exchanges /workflows/{localWorkflowId}/exchanges/{localExchangeId}"></table>

<p>
In the workflow and exchanges APIs, a "local" ID refers to an ID that is local to a service instance.
In other words, an `exchangeId` or `workflowId` refers to a fully qualified URL
while a `localExchangeId` or `localWorkflowId` refers to a fragment of the URL.
</p>

<section>
<h4>Create Workflow</h4>
<p>
Expand Down

0 comments on commit fdf8d87

Please sign in to comment.