updated the expectedCaller yml to use x-expectedCaller instead of ove…

…rloading the server property, updated the respec-oas.js table generation function to match
w3c-ccg · Jun 4, 2024 · bc2197c · bc2197c
1 parent f5989ea
commit bc2197c
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 30 deletions.
diff --git a/exchanges.yml b/exchanges.yml
@@ -24,6 +24,7 @@ paths:
         - zCap: []
       operationId: createWorkflow
       description: Creates a new workflow and returns workflowId in the response body.
+      x-expectedCaller: Administrators
       requestBody:
         content:
           application/json:
@@ -53,6 +54,7 @@ paths:
         - zCap: []
       operationId: getWorkflowConfiguration
       description: Gets the configuration of an existing workflow and returns it in the response body.
+      x-expectedCaller: Administrators
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
       responses:
@@ -79,6 +81,7 @@ paths:
         - zCap: []
       operationId: createExchange
       description: Creates a new exchange and returns exchangeId and time to live in the response body.
+      x-expectedCaller: Owner Coordinator
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
       requestBody:
@@ -110,6 +113,7 @@ paths:
         - zCap: []
       operationId: getExchangeConfiguration
       description: Gets the configuration of an existing exchange and returns it in the response body.
+      x-expectedCaller: Owner Coordinator
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
         - $ref: "./components/parameters/path/LocalExchangeId.yml"
@@ -136,6 +140,7 @@ paths:
         - zCap: []
       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
       parameters:
         - $ref: "./components/parameters/path/LocalWorkflowId.yml"
         - $ref: "./components/parameters/path/LocalExchangeId.yml"

diff --git a/holder.yml b/holder.yml
@@ -22,7 +22,7 @@ paths:
        - oAuth2: []
        - zCap: []
       summary: Gets a credential or verifiable credential by ID. To get a credential that does not have credential.id set but has an associated credentialId value, pass credentialId instead.
-      servers: [{url: "Issuer Coordinator"}]
+      x-expectedCaller: "Issuer Coordinator"
       operationId: getCredential
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
@@ -57,7 +57,7 @@ paths:
        - oAuth2: []
        - zCap: []
       summary: Deletes a credential or verifiable credential by ID. To delete a credential that does not have credential.id set but has an associated credentialId value, pass credentialId instead.
-      servers: [{url: "Issuer Coordinator"}]
+      x-expectedCaller: "Issuer Coordinator"
       operationId: deleteCredential
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
@@ -86,7 +86,7 @@ paths:
        - zCap: []
       summary: Gets list of credentials or verifiable credentials
       operationId: getCredentials
-      servers: [{url: "Holder Coordinator or Issuer Coordinator"}]
+      x-expectedCaller: "Holder Coordinator or Issuer Coordinator"
       parameters:
         - in: query
           name: type
@@ -128,7 +128,7 @@ paths:
       summary: Derives a credential and returns it in the response body.
       operationId: deriveCredential
       description: Derives a credential and returns it in the response body.
-      servers: [{url: "Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       requestBody:
         content:
           application/json:
@@ -159,7 +159,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: getPresentation
-      servers: [{url: "Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
       responses:
@@ -192,7 +192,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: deletePresentation
-      servers: [{url: "Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       parameters:
         - $ref: "./components/parameters/path/ObjectId.yml"
       responses:
@@ -220,7 +220,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: getPresentations
-      servers: [{url: "Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       parameters:
         - in: query
           name: type
@@ -260,7 +260,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: createPresentation
-      servers: [{url: "Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       description: Creates a presentation and returns it in the response body.
       requestBody:
         content:

diff --git a/issuer.yml b/issuer.yml
@@ -23,7 +23,7 @@ paths:
         - oAuth2: []
         - zCap: []
       operationId: issueCredential
-      servers: [{url: "Issuer Coordinator"}]
+      x-expectedCaller: "Issuer Coordinator"
       description: Issues a credential and returns it in the response body.
       requestBody:
         content:
@@ -55,7 +55,7 @@ paths:
         - oAuth2: []
         - zCap: []
       operationId: updateCredentialStatus
-      servers: [{url: "Verifier Service"}]
+      x-expectedCaller: "Verifier Service"
       description: Updates the status of an issued credential.
       requestBody:
         content:

diff --git a/respec-oas.js b/respec-oas.js
@@ -28,18 +28,15 @@ function buildComponentTables({config, document, apis}) {
     for(const path of table.dataset.apiPath.split(/\s+/)) {
       if(path.trim().length > 0) {
         const endpoint = getEndpoint({apis, path});
-        for(const verb in endpoint) {
-          const {servers} = endpoint[verb];
-          const tableRow = document.createElement('tr');
-          var expectedCaller = "Expected Caller Undefined";
-          if(servers !== undefined)
-          {
-            expectedCaller = servers[0].url;
-          }
-          tableRow.innerHTML =
-            `<td>${verb.toUpperCase()}&nbsp;${path}</td><td>${expectedCaller}</td>`;
-          table.appendChild(tableRow);
+        const expectedCaller = endpoint['x-expectedCaller'];
+        const tableRow = document.createElement('tr');
+        if(expectedCaller === undefined)
+        {
+          expectedCaller = "Expected Caller Undefined";;
         }
+        tableRow.innerHTML =
+          `<td>${verb.toUpperCase()}&nbsp;${path}</td><td>${expectedCaller}</td>`;
+        table.appendChild(tableRow);
       }
     }
   }

diff --git a/verifier.yml b/verifier.yml
@@ -23,7 +23,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: verifyCredential
-      servers: [{url: "Verification Coordinator"}]
+      x-expectedCaller: "Verification Coordinator"
       description: Verifies a verifiableCredential and returns a verificationResult in the response body.
       requestBody:
         content:
@@ -52,7 +52,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: verifyPresentation
-      servers: [{url: "Verification Coordinator"}]
+      x-expectedCaller: "Verification Coordinator"
       description: Verifies a verifiablePresentation and returns a verificationResult in the response body.  Given the possibility of denial of service, buffer overflow, or other style attacks, an implementation is permitted to rate limit or restrict requests against this API endpoint to those requests that contain only a single credential with a 413 or 429 error code as appropriate.
       requestBody:
         content:
@@ -85,7 +85,7 @@ paths:
        - oAuth2: []
        - zCap: []
       operationId: challenge
-      servers: [{url: "Verification Coordinator"}]
+      x-expectedCaller: "Verification Coordinator"
       description: Creates a challenge to be used as `options.challenge` in future requests.
       responses:
         "200":

diff --git a/versions/v0.0.2/vc-api.yml b/versions/v0.0.2/vc-api.yml
@@ -23,7 +23,7 @@ paths:
         - Issuer
       summary: Issues a credential and returns it in the response body.
       operationId: issueCredential
-      servers: [{url:"Issuer Coordinator"}]
+      x-expectedCaller: "Issuer Coordinator"
       description: Issues a credential and returns it in the response body.
       requestBody:
         content:
@@ -48,7 +48,7 @@ paths:
         - Holder
       summary: Derives a credential and returns it in the response body.
       operationId: deriveCredential
-      servers: [{url:"Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       description: Derives a credential and returns it in the response body.
       requestBody:
         content:
@@ -75,7 +75,7 @@ paths:
         - Issuer
       summary: Updates the status of an issued credential
       operationId: updateCredentialStatus
-      servers: [{url:"Status Service"}]
+      x-expectedCaller: "Status Service"
       description: Updates the status of an issued credential.
       requestBody:
         content:
@@ -98,7 +98,7 @@ paths:
         - Holder
       summary: Proves a presentation and returns it in the response body.
       operationId: provePresentation
-      servers: [{url:"Holder Coordinator"}]
+      x-expectedCaller: "Holder Coordinator"
       description: Proves a presentation and returns it in the response body.
       requestBody:
         content:
@@ -123,7 +123,7 @@ paths:
         - Verifier
       summary: Verifies a verifiableCredential and returns a verificationResult in the response body.
       operationId: verifyCredential
-      servers: [{url:"Verification Coordinator"}]
+      x-expectedCaller: "Verification Coordinator"
       description: Verifies a verifiableCredential and returns a verificationResult in the response body.
       requestBody:
         content:
@@ -148,7 +148,7 @@ paths:
         - Verifier
       summary: Verifies a Presentation with or without proofs attached and returns a verificationResult in the response body.
       operationId: verifyPresentation
-      servers: [{url:"Verification Coordinator"}]
+      x-expectedCaller: "Verification Coordinator"
       description: Verifies a verifiablePresentation and returns a verificationResult in the response body.  Given the possibility of denial of service, buffer overflow, or other style attacks, an implementation is permitted to rate limit or restrict requests against this API endpoint to those requests that contain only a single credential with a 413 or 429 error code as appropriate.
       requestBody:
         content: