Merge pull request #79 from OAI/frankkilcommins/issue74

Settle on "Workflows Description"
OAI · Nov 8, 2023 · 7df0fcd · 7df0fcd
2 parents faef8dc + def94e2
commit 7df0fcd
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 44 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.vscode/settings.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
-        "ruleset"
+        "ruleset",
+        "Templating"
     ]
 }
diff --git a/examples/1.0.0/FAPI-PAR.workflow.yaml b/examples/1.0.0/FAPI-PAR.workflow.yaml
@@ -4,7 +4,7 @@ info:
   version: 1.0.0
   description: >-
     A workflow describing how to obtain a token from an OAuth2 and OpenID Connect Financial Grade authorization server which can be common for PSD2 API journeys
-sourceDocuments:
+sourceDescriptions:
   - name: auth-api
     url: ./FAPI-PAR.openapi.yaml
     type: openapi

diff --git a/examples/1.0.0/LoginAndRetrievePets.workflow.yaml b/examples/1.0.0/LoginAndRetrievePets.workflow.yaml
@@ -5,8 +5,8 @@ info:
     description: |
         This workflow walks you through the steps of `searching` for, `selecting`, and `purchasing` an available pet.
     version: 1.0.1
-sourceDocuments:
-- name: petStoreDefinition
+sourceDescriptions:
+- name: petStoreDescription
   url: https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml
   type: openapi
 
@@ -24,7 +24,7 @@ workflows:
   steps:
   - stepId: loginStep
     description: This step demonstrates the user login step
-    operationId: petStoreDefinition.loginUser
+    operationId: petStoreDescription.loginUser
     parameters:
       # parameters to inject into the loginUser operation (parameter name must be resolvable at the referenced operation and the value is determined using {expression} syntax)
       - name: username

diff --git a/examples/1.0.0/oauth.workflow.yaml b/examples/1.0.0/oauth.workflow.yaml
@@ -4,7 +4,7 @@ info:
   version: 1.0.0
   description: >-
     APImetrics OAuth service
-sourceDocuments:
+sourceDescriptions:
   - name: apim-auth
     url: ./oauth.openapi.yaml
     type: openapi

diff --git a/examples/1.0.0/pet-coupons.workflow.yaml b/examples/1.0.0/pet-coupons.workflow.yaml
@@ -6,7 +6,7 @@ info:
     Illustrates a workflow whereby a client a) finds a pet in the petstore, 
     b) finds coupons for that pet, and finally
     c) orders the pet while applying the coupons from step b.
-sourceDocuments:
+sourceDescriptions:
   - name: pet-coupons
     url: ./pet-coupons.openapi.yaml
     type: openapi

diff --git a/versions/1.0.0.md b/versions/1.0.0.md