chore: suggest multilevel parameters (#155)

* chore: suggest multilevel parameters * Update versions/1.0.0.md Co-authored-by: Frank Kilcommins <[email protected]> * Update examples/1.0.0/ExtendedParametersExample.workflow.yaml Co-authored-by: Frank Kilcommins <[email protected]> * Update versions/1.0.0.md Co-authored-by: Frank Kilcommins <[email protected]> --------- Co-authored-by: Frank Kilcommins <[email protected]>
OAI · Mar 27, 2024 · 6e2769f · 6e2769f
1 parent 3ec4dc0
commit 6e2769f
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/examples/1.0.0/ExtendedParametersExample.workflow.yaml b/examples/1.0.0/ExtendedParametersExample.workflow.yaml
@@ -0,0 +1,26 @@
+workflowsSpec: 1.0.0
+info:
+  title: Public Zoo API
+  version: '1.0'
+sourceDescriptions:
+  - name: animals
+    type: openapi
+    url: ./animals.yaml
+workflows:
+  - workflowId: animal-workflow
+    parameters:
+      - in: cookie
+        name: workflowLevelParamOne
+        value: someValue
+      - in: header
+        name: workflowLevelParamTwo
+        value: someValue
+    steps:
+      - stepId: post-step
+        parameters:
+          - in: cookie
+            name: authentication
+            value: SUPER_SECRET
+        operationId: animals.postAnimal
+      - stepId: get-step
+        operationId: animals.getRandomAnimal
diff --git a/versions/1.0.0.md b/versions/1.0.0.md
@@ -272,6 +272,8 @@ Field Name | Type | Description
 <a name="workflowInputs"></a>inputs | `JSON Schema` | A JSON Schema 2020-12 object representing the input parameters used by this workflow.
 <a name="workflowSteps"></a>steps | [[Step Object](#step-object)] | **REQUIRED**. An ordered list of steps where each step represents a call to an API operation or to another workflow.
 <a name="workflowOutputs"></a>outputs | Map[`string`, {expression}] |  A map between a friendly name and a dynamic output value. The name MUST use keys that match the regular expression: `^[a-zA-Z0-9\.\-_]+$`.
+<a name="workflowParameters"></a>parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for all steps described under this workflow. These parameters can be overridden at the step level but cannot be removed there. Each parameter MUST be passed to an operation or workflow as referenced by `operationId`, `operationPath`, or `workflowId` as specified within each step. If a Reference Object is provided, it MUST link to parameters defined in [components/parameters](#components-object). The list MUST NOT include duplicate parameters.
+
 
 This object MAY be extended with [Specification Extensions](#specification-extensions).