Skip to content

Commit 6805134

Browse files
committed
Charles' comments
Signed-off-by: Francisco Javier Tirado Sarti <[email protected]>
1 parent afdbac9 commit 6805134

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

schema/workflow.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
},
3939
"additionalItems": false
4040
},
41-
"dataInputSchema": {
41+
"inputDataSchema": {
4242
"oneOf": [
4343
{
4444
"type": "string",
@@ -76,7 +76,7 @@
7676
}
7777
]
7878
},
79-
"dataOutputSchema": {
79+
"outputDataSchema": {
8080
"oneOf": [
8181
{
8282
"type": "string",

specification.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1768,8 +1768,8 @@ definition "id" must be a constant value.
17681768
| description | Workflow description | string | no |
17691769
| version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format | string | no |
17701770
| annotations | List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities | array | no |
1771-
| dataInputSchema | Used to validate the workflow data input against a defined JSON Schema| string or object | no |
1772-
| dataOutputSchema | Used to validate the workflow data output against a defined JSON Schema| string or object | no |
1771+
| inputDataSchema | Used to validate the workflow data input against a defined JSON Schema| string or object | no |
1772+
| outputDataSchema | Used to validate the workflow data output against a defined JSON Schema| string or object | no |
17731773
| [constants](#Workflow-Constants) | Workflow constants | string or object | no |
17741774
| [secrets](#Workflow-Secrets) | Workflow secrets | string or array | no |
17751775
| [start](#Start-Definition) | Workflow start definition | string or object | no |
@@ -1860,12 +1860,12 @@ The `version` property can be used to provide a specific workflow version. It mu
18601860
The `annotations` property defines a list of helpful terms describing the workflows intended purpose, subject areas, or other important qualities,
18611861
for example "machine learning", "monitoring", "networking", etc
18621862

1863-
The `dataInputSchema` and `dataOutputSchema` properties can be used to validate model against a defined JSON Schema.
1863+
The `inputDataSchema` and `outputDataSchema` properties can be used to validate input and output data against a defined JSON Schema.
18641864

1865-
The `dataInputSchema` property validates the [workflow data input](#Workflow-Data-Input). Validation should be performed before any states are executed. In case of
1866-
a starting [Event state](#Event-state), it is not used to validate its event payloads. The `failOnValidationErrors` property determines if workflow execution should continue in case of validation errors.
1865+
The `inputDataSchema` property validates the [workflow data input](#Workflow-Data-Input). Validation should be performed before any states are executed. In case of
1866+
a start [Event state](#Event-state) the input schema is ignored, if present. The `failOnValidationErrors` property determines if workflow execution should continue in case of validation errors.
18671867

1868-
The `dataOutputSchema` property validates the [Workflow data output](#workflow-data-output). Validation should be performed after workflow execution has finished successfully. Successfully means the workflow has completed an end state without errors.
1868+
The `outputDataSchema` property validates the [Workflow data output](#workflow-data-output). Validation should be performed after workflow execution has finished successfully. Successfully means that the workflow has completed an end state without errors.
18691869
The `failOnValidationErrors` property determines what should be done when the workflow output does not match the provided schema.
18701870
If `failOnValidationErrors` is true, an error should be thrown. If executed within a subprocess, that error might be handled by the parent workflow.
18711871
If `failOnValidationErrors` is false, it is up to the implementor to warn the user about that fact using any mean, except throwing an error. For example, printing a log.
@@ -1877,7 +1877,7 @@ If using object type, their `schema` property might be an URI, which points to t
18771877
Example for Json schema reference
18781878

18791879
```json
1880-
"dataInputSchema": {
1880+
"inputDataSchema": {
18811881
"schema": "URL_to_json_schema",
18821882
"failOnValidationErrors": false
18831883
}
@@ -1886,7 +1886,7 @@ Example for Json schema reference
18861886
Example for Json schema included in the workflow file
18871887

18881888
```json
1889-
"dataOutputSchema": {
1889+
"outputDataSchema": {
18901890
"schema": {
18911891
"title": "MyJSONSchema",
18921892
"properties":{
@@ -1908,7 +1908,7 @@ If using string type, then the string value is the external schema URI and `fail
19081908
Example using string type
19091909

19101910
```json
1911-
"dataInputSchema": "URL_to_json_schema"
1911+
"inputDataSchema": "URL_to_json_schema"
19121912
```
19131913

19141914
The `secrets` property allows you to use sensitive information such as passwords, OAuth tokens, ssh keys, etc. inside your

0 commit comments

Comments
 (0)