From ec1a66c4cf5faf52a5a9fecc1a123b0beff0b81d Mon Sep 17 00:00:00 2001
From: jrhender <vcapi@j-henderson.com>
Date: Mon, 27 Jan 2025 14:58:44 -0800
Subject: [PATCH] Clarify the distinction between local and fully qualified
 IDs.

This is currently only relevant to the workflows and exchanges APIs
so it is added to that section.
---
 index.html | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/index.html b/index.html
index 5d260b7..729d992 100644
--- a/index.html
+++ b/index.html
@@ -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 workflows 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>