Skip to content

Commit

Permalink
Merge branch 'main' into draft-version-minor-enrichment
Browse files Browse the repository at this point in the history
  • Loading branch information
frankkilcommins authored Mar 22, 2023
2 parents b348ad2 + d05ea07 commit 7c89588
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 4 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/use-case-template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: "Workflow-SIG Usecase Create Form"
description: "Request form to describe a Workflow-SIG use case. Inorder to create a comprehensive solution Please provide a brief title, description, and fill out the details below and we'll get back to you ASAP."
title: "[Workflow-SIG Usecases, draft version]: "
labels: use-case
assignees: @OAI/sig-workflows-admins
-
body:
- type: markdown
attributes:
value: Thank you for contributing to the OAI work-flow SIG, please use this issue form to describe use cases in your industry.
- type: input
id: contact
attributes:
label: Contact Details
description: Please share the name(s) / handle(s) so we can followup with any additional questions comments.
validations:
required: true
- type: textarea
id: Title
attributes:
label: Give your usecase a unique name so we may refer to it in discussions
description: Each usecase needs a unique name starting with "USECASE-"
validations:
required: true
- type: textarea
id: description
attributes:
label: Give an overview of your use case.
description: A brief description that outlines your usecase.
validations:
required: true
- type: textarea
id: Industry
attributes:
label: Industry
description: Let us know if this is an industry specific usecase and any specific circumstances such as regulations that restrict the use case.
validations:
required: true
- type: textarea
id: Documentation
attributes:
label: Documentation
description: Share any existing documention, examples, or any other materials that will help the SIG understand the requirements.
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OAI/OpenAPI-Specification/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
8 changes: 4 additions & 4 deletions versions/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,8 +391,8 @@ Describes a single step parameter. A unique parameter is defined by the combinat
Field Name | Type | Description
---|:---:|---
<a name="parameterName"></a> name | string | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
<a name="parameterIn"></a> in | string | **REQUIRED**. The name location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, `"cookie"`, or `"body"`.
<a name="parameterStyle"></a> style | string | Describes how the parameter value will be serialized depending on the location of parameter value. This fixed field is predominately used to express how a _request body_ is to be serialized. For example, when request data (`in` with value `"body"`) is to be serialized as `x-www-form-urlencoded`, the style SHOULD be `"form"`. `in` parameters with values of `"query"`, `"header"`, or `"cookie"` MUST derive their style from the referenced `source` when applicable.
<a name="parameterIn"></a> in | string | **REQUIRED**. The name location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, `"cookie"`, `"body"`, or `"workflow"`.
<a name="parameterStyle"></a> style | string | Describes how the parameter value will be serialized depending on the location of parameter value. This fixed field is predominately used to express how a _request body_ is to be serialized. For example, when request data (`in` with value `"body"`) is to be serialized as `x-www-form-urlencoded`, the style SHOULD be `"form"`. `in` parameters with values of `"query"`, `"header"`, or "`cookie`" MUST derive their style from the referenced `source` when applicable.
<a name="parameterTarget"></a> target | {JSON Pointer} | A [JSON Pointer](https://tools.ietf.org/html/rfc6901) expression identifying locations to inject the value. Can be useful for targeting specific request body part.
<a name="parameterValue"></a> value | Any \| {expression} | **REQUIRED**. The value to pass in the parameter. The value can be a constant or an [expression](#runtime-expressions) to be evaluated and passed to the referenced operation or workflow.

Expand Down Expand Up @@ -444,7 +444,7 @@ Field Name | Type | Description
<a name="successStepId"></a> stepId | string | The `stepId` to jump to based on the success of the step. This field is only relevant when the `type` field value is `goto`. The value of the `stepId` MAY be within any workflow defined in the Workflows document. For convenience, the value MAY be formatted as _workflowId.stepId_.
<a name="successCriteria"></a> criteria | [{expression}] | A list of assertions to determine if this action SHALL be executed.

**Note -** should multiple success actions have similar successCriteria, the first sequential action matching the criteria SHALL be the action executed.
**Note -** should multiple success actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed.

##### Success Action Object Example
```
Expand All @@ -468,7 +468,7 @@ Field Name | Type | Description
<a name="failureRetryLimit"></a> retryLimit | integer | A non-negative integer indicating how many attempts to retry the step MAY be attempted before failing the overall step. If not specified then a single retry SHALL be attempted. This field only applies when the `type` field value is `retry`. The `retryLimit` MUST be exhausted prior to executing subsequent failure actions.
<a name="failureCriteria"></a> criteria | [{expression}] | A list of assertions to determine if this action SHALL be executed.

**Note -** should multiple success actions have similar successCriteria, the first sequential action matching the criteria SHALL be the action executed.
**Note -** should multiple success actions have similar `criteria`, the first sequential action matching the criteria SHALL be the action executed.

##### Failure Action Object Example
```
Expand Down

0 comments on commit 7c89588

Please sign in to comment.