Add links to component tables

index.html

@@ -991,6 +991,8 @@ <h3>Issuing</h3>
           /credentials/issue /credentials/status"></table>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Issue Credential</h4>
         <p>
 This endpoint is used to issue a [=verifiable credential=].
@@ -1042,6 +1044,8 @@ <h4>Issue Credential</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get a Specific Credential</h4>
         <p>
         </p>
@@ -1051,6 +1055,8 @@ <h4>Get a Specific Credential</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Update Status</h4>
         <p>
         </p>
@@ -1088,6 +1094,8 @@ <h3>Verifying</h3>
         data-api-path="/credentials/verify /presentations/verify /challenges"></table>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Verify Credential</h4>
         <p>
 This endpoint is used to verify a [=verifiable credential=].
@@ -1106,6 +1114,8 @@ <h4>Verify Credential</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Verify Presentation</h4>
         <p>
 This endpoint is used to verify a [=verifiable presentation=] and, by default,
@@ -1168,6 +1178,8 @@ <h3>Requesting a Presentation</h3>
       </p>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Verifiable Presentation Request</h4>
 
         <p>
@@ -1671,6 +1683,8 @@ <h3>Presenting</h3>
         </p>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Derive Credential</h4>
         <p>
         </p>
@@ -1680,6 +1694,8 @@ <h4>Derive Credential</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Create Presentation</h4>
         <p>
         </p>
@@ -1695,6 +1711,8 @@ <h4>Create Presentation</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Exchange Discovery</h4>
         <p>
 Discovery is an optional call for the [=holder coordinator=] to ensure the [=holder coordinator=] can support
@@ -1706,6 +1724,8 @@ <h4>Exchange Discovery</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also update the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get Presentations</h4>
         <p>
         </p>
@@ -1716,6 +1736,8 @@ <h4>Get Presentations</h4>
 
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get a Specific Presentation</h4>
         <p>
         </p>
@@ -1947,6 +1969,8 @@ <h3>Workflows and Exchanges</h3>
       </p>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Create Workflow</h4>
         <p>
         </p>
@@ -2242,6 +2266,8 @@ <h4>Create Workflow</h4>
         </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get Workflow Configuration</h4>
         <p>
         </p>
@@ -2259,6 +2285,8 @@ <h4>Get Workflow Configuration</h4>
       </p>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Create Exchange</h4>
         <p>
         </p>
@@ -2268,6 +2296,8 @@ <h4>Create Exchange</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get Exchange Protocols</h4>
         <p>
 This endpoint provides a mechanism for a client to query an exchange for all of
@@ -2315,6 +2345,8 @@ <h4>Get Exchange Protocols</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Participate in an Exchange</h4>
         <p>
         </p>
@@ -2324,6 +2356,8 @@ <h4>Participate in an Exchange</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Get Exchange State</h4>
         <p>
         </p>
@@ -2333,6 +2367,8 @@ <h4>Get Exchange State</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Exchange Step Callbacks</h4>
         <p>
         </p>
@@ -2541,6 +2577,8 @@ <h3>Initiating Interactions</h3>
       </figure>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Interaction URL Format</h4>
         <p>
 The format of the <dfn>interaction URL</dfn> MUST conform to the syntax for the
@@ -2634,6 +2672,8 @@ <h4>Interaction Scheme Format</h4>
       </section>
 
       <section>
+        <!--If this header is changed, also updated the x-componentTableLink parameter for this endpoint in the oas.yaml file.
+            If the x-componentTableLink isn't updated to match the corresponding Component Table link will break.-->
         <h4>Interaction Protocols Response</h4>
         <p>
 Performing a retrieval of the [=interaction URL=] results in instructions

oas.yaml

@@ -26,6 +26,7 @@ paths:
       x-expectedCaller: 
         - Issuer Coordinator
         - Workflow Service
+      x-componentTableLink: "issue-credential"
       description: Issues a credential and returns it in the response body.
       requestBody:
         content:
@@ -56,6 +57,7 @@ paths:
         - zCap: []
       operationId: updateCredentialStatus
       x-expectedCaller: Issuer Service
+      x-componentTableLink: "update-status"
       description: Updates the status of an issued credential.
       requestBody:
         content:
@@ -82,6 +84,7 @@ paths:
       operationId: createWorkflow
       description: Creates a new workflow and returns location of workflow metadata in a response header.
       x-expectedCaller: Administrators
+      x-componentTableLink: "create-workflow"
       requestBody:
         content:
           application/json:
@@ -124,6 +127,7 @@ paths:
       operationId: getWorkflowConfiguration
       description: Gets the configuration of an existing workflow and returns it in the response body.
       x-expectedCaller: Administrators
+      x-componentTableLink: "get-workflow-configuration"
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
       responses:
@@ -151,6 +155,7 @@ paths:
       operationId: createExchange
       description: Creates a new exchange and returns location of exchange metadata in a response header.
       x-expectedCaller: Coordinator
+      x-componentTableLink: "create-exchange"
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
       requestBody:
@@ -195,6 +200,7 @@ paths:
       operationId: getExchangeConfiguration
       description: Gets the configuration of an existing exchange and returns it in the response body.
       x-expectedCaller: Coordinator
+      x-componentTableLink: "get-exchange-state"
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
         - $ref: "./components/parameters/path/LocalExchangeId.yml"
@@ -226,6 +232,7 @@ paths:
       operationId: participateInExchange
       description: Participate in an exchange. Posting an empty body will start the exchange or return what the exchange is expecting to complete the next step.
       x-expectedCaller: Anyone
+      x-componentTableLink: "participate-in-an-exchange"
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
         - $ref: "./components/parameters/path/LocalExchangeId.yml"
@@ -269,6 +276,7 @@ paths:
       x-expectedCaller:
         - Verifier Coordinator
         - Holder Coordinator
+      x-componentTableLink: "get-exchange-protocols"
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
         - $ref: "./components/parameters/path/LocalExchangeId.yml"
@@ -298,6 +306,7 @@ paths:
        - Issuer Coordinator
        - Holder Coordinator
        - Workflow Service
+      x-componentTableLink: "get-a-specific-credential"
       operationId: getCredential
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
@@ -330,6 +339,7 @@ paths:
       x-expectedCaller:
         - Issuer Coordinator
         - Holder Coordinator
+      x-componentTableLink: "delete-a-specific-credential"
       operationId: deleteCredential
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
@@ -358,6 +368,7 @@ paths:
       x-expectedCaller: 
        - Holder Coordinator
        - Workflow Service
+      x-componentTableLink: "derive-credential"
       requestBody:
         content:
           application/json:
@@ -387,6 +398,7 @@ paths:
       x-expectedCaller: 
        - Holder Coordinator
        - Workflow Service
+      x-componentTableLink: "get-a-specific-presentation"
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
       responses:
@@ -416,6 +428,7 @@ paths:
        - zCap: []
       operationId: deletePresentation
       x-expectedCaller: Holder Coordinator
+      x-componentTableLink: ""
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
       responses:
@@ -442,6 +455,7 @@ paths:
       x-expectedCaller: 
        - Holder Coordinator
        - Workflow Service
+      x-componentTableLink: "get-presentations"
       parameters:
         - in: query
           name: type
@@ -480,6 +494,7 @@ paths:
       x-expectedCaller: 
        - Holder Coordinator
        - Workflow Service
+      x-componentTableLink: "create-presentation"
       description: Creates a presentation and returns it in the response body.
       requestBody:
         content:
@@ -506,6 +521,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: callback
+      x-componentTableLink: "exchange-step-callbacks"
       parameters:
         - $ref: "./components/parameters/path/LocalCallbackId.yml"
       description:
@@ -538,6 +554,7 @@ paths:
       x-expectedCaller: 
        - Verifier Coordinator
        - Workflow Service
+      x-componentTableLink: "verify-credential"
       description: Verifies a verifiableCredential and returns a verificationResult in the response body.
       requestBody:
         content:
@@ -569,6 +586,7 @@ paths:
       x-expectedCaller: 
        - Verifier Coordinator
        - Workflow Service
+      x-componentTableLink: "verify-presentation"
       description: |
         Verifies a verifiablePresentation and, by default, all verifiable credentials
         contained within it.
@@ -629,6 +647,7 @@ paths:
       x-expectedCaller: 
        - Verifier Coordinator
        - Workflow Service
+      x-componentTableLink: "create-challenge"
       description: Creates a challenge to be used as `options.challenge` in future requests.
       responses:
         "200":
@@ -653,6 +672,7 @@ paths:
       operationId: startInteraction
       description: Retrieve available interaction protocols from the interaction originator.
       x-expectedCaller: Anyone with provided URL
+      x-componentTableLink: "interaction-url-format"
       parameters:
         - in: path
           name: interactionId
@@ -702,6 +722,7 @@ paths:
       operationId: receiveInvitationResponse
       description: Ths endpoint is one of the ones expected to be included as a fully formed URL in the protocols object returned by the /interactions/{interactionId} endpoint.
       x-expectedCaller: Whoever POSTed to the URL containing /interactions/{interactionId}
+      x-componentTableLink: "interaction-protocols-response"
       parameters:
         - in: path
           name: inviteId