From ed1f9ab68e37acd42f1fd80221d72c5bac0971bc Mon Sep 17 00:00:00 2001 From: Jeff EF Date: Wed, 13 Apr 2022 11:44:43 -0700 Subject: [PATCH 1/5] Create CODE_OF_CONDUCT.md. --- CODE_OF_CONDUCT.md. | 1 + 1 file changed, 1 insertion(+) create mode 100644 CODE_OF_CONDUCT.md. diff --git a/CODE_OF_CONDUCT.md. b/CODE_OF_CONDUCT.md. new file mode 100644 index 0000000..71418be --- /dev/null +++ b/CODE_OF_CONDUCT.md. @@ -0,0 +1 @@ +The Workflows Special Interest Group follows the Conduct of Conduct guidelines outlined by the OpenAPI Initiatives' Technical Steering Committee. Please review [here](https://github.com/OAI/OpenAPI-Specification/blob/main/CODE_OF_CONDUCT.md) From e35104fc89c2e9461a3fbee9929b61d44dd5d929 Mon Sep 17 00:00:00 2001 From: Jeff EF Date: Wed, 13 Apr 2022 12:19:44 -0700 Subject: [PATCH 2/5] Create use-case-template.yml --- .github/ISSUE_TEMPLATE/use-case-template.yml | 53 ++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/use-case-template.yml diff --git a/.github/ISSUE_TEMPLATE/use-case-template.yml b/.github/ISSUE_TEMPLATE/use-case-template.yml new file mode 100644 index 0000000..66d1059 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/use-case-template.yml @@ -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 From b56ecfc170515b367c4c775c72e2342e4a3d9de2 Mon Sep 17 00:00:00 2001 From: Jeff EF Date: Fri, 15 Apr 2022 11:12:25 -0700 Subject: [PATCH 3/5] Rename CODE_OF_CONDUCT.md. to CODE_OF_CONDUCT.md There was a trailing "." in the name that was causing some issues. --- CODE_OF_CONDUCT.md. => CODE_OF_CONDUCT.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CODE_OF_CONDUCT.md. => CODE_OF_CONDUCT.md (100%) diff --git a/CODE_OF_CONDUCT.md. b/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md. rename to CODE_OF_CONDUCT.md From bb2c9aba0fa2648b730e3117777119ef73ab7b7b Mon Sep 17 00:00:00 2001 From: Jeff EF Date: Wed, 20 Apr 2022 09:36:53 -0700 Subject: [PATCH 4/5] Delete CODE_OF_CONDUCT.md Ron was able to make the CoC universal across all SIGs so we can erase our specific one. --- CODE_OF_CONDUCT.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 71418be..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -The Workflows Special Interest Group follows the Conduct of Conduct guidelines outlined by the OpenAPI Initiatives' Technical Steering Committee. Please review [here](https://github.com/OAI/OpenAPI-Specification/blob/main/CODE_OF_CONDUCT.md) From d05ea073e6dd66fd6bba837c29bd6a5644917237 Mon Sep 17 00:00:00 2001 From: Frank Kilcommins Date: Mon, 13 Mar 2023 22:05:08 +0000 Subject: [PATCH 5/5] Add missing parameter.in option --- versions/1.0.0.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 2c59ba8..ebc8af7 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -391,7 +391,7 @@ Describes a single step parameter. A unique parameter is defined by the combinat Field Name | Type | Description ---|:---:|--- name | string | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_. - in | string | **REQUIRED**. The name location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, "`cookie`", or `"body"`. + in | string | **REQUIRED**. The name location of the parameter. Possible values are `"path"`, `"query"`, `"header"`, "`cookie`", `"body"`, or `"workflow"`. 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. 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. 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. @@ -444,7 +444,7 @@ Field Name | Type | Description 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_. 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 ``` @@ -468,7 +468,7 @@ Field Name | Type | Description 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. 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 ```