Skip to content

Commit 6e2769f

Browse files
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]>
1 parent 3ec4dc0 commit 6e2769f

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
workflowsSpec: 1.0.0
2+
info:
3+
title: Public Zoo API
4+
version: '1.0'
5+
sourceDescriptions:
6+
- name: animals
7+
type: openapi
8+
url: ./animals.yaml
9+
workflows:
10+
- workflowId: animal-workflow
11+
parameters:
12+
- in: cookie
13+
name: workflowLevelParamOne
14+
value: someValue
15+
- in: header
16+
name: workflowLevelParamTwo
17+
value: someValue
18+
steps:
19+
- stepId: post-step
20+
parameters:
21+
- in: cookie
22+
name: authentication
23+
value: SUPER_SECRET
24+
operationId: animals.postAnimal
25+
- stepId: get-step
26+
operationId: animals.getRandomAnimal

versions/1.0.0.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,8 @@ Field Name | Type | Description
272272
<a name="workflowInputs"></a>inputs | `JSON Schema` | A JSON Schema 2020-12 object representing the input parameters used by this workflow.
273273
<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.
274274
<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\.\-_]+$`.
275+
<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.
276+
275277

276278
This object MAY be extended with [Specification Extensions](#specification-extensions).
277279

0 commit comments

Comments
 (0)