Skip to content

Commit f93fedb

Browse files
author
Tihomir Surdilovic
authored
remove dataschema prop (#242)
Signed-off-by: Tihomir Surdilovic <[email protected]>
1 parent 7a34894 commit f93fedb

File tree

2 files changed

+0
-131
lines changed

2 files changed

+0
-131
lines changed

‎schema/workflow.json

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@
3030
"description": "Serverless Workflow schema version",
3131
"minLength": 1
3232
},
33-
"dataSchema": {
34-
"$ref": "#/definitions/dataschema"
35-
},
3633
"execTimeout": {
3734
"$ref": "#/definitions/exectimeout"
3835
},
@@ -126,9 +123,6 @@
126123
"description": "Serverless Workflow schema version",
127124
"minLength": 1
128125
},
129-
"dataSchema": {
130-
"$ref": "#/definitions/dataschema"
131-
},
132126
"execTimeout": {
133127
"$ref": "#/definitions/exectimeout"
134128
},
@@ -525,9 +519,6 @@
525519
"description": "Next transition of the workflow after the time delay",
526520
"$ref": "#/definitions/transition"
527521
},
528-
"dataSchema": {
529-
"$ref": "#/definitions/dataschema"
530-
},
531522
"compensatedBy": {
532523
"type": "string",
533524
"minLength": 1,
@@ -641,9 +632,6 @@
641632
"$ref": "#/definitions/error"
642633
}
643634
},
644-
"dataSchema": {
645-
"$ref": "#/definitions/dataschema"
646-
},
647635
"transition": {
648636
"description": "Next transition of the workflow after all the actions have been performed",
649637
"$ref": "#/definitions/transition"
@@ -760,9 +748,6 @@
760748
"description": "Next transition of the workflow after all the actions have been performed",
761749
"$ref": "#/definitions/transition"
762750
},
763-
"dataSchema": {
764-
"$ref": "#/definitions/dataschema"
765-
},
766751
"compensatedBy": {
767752
"type": "string",
768753
"minLength": 1,
@@ -896,9 +881,6 @@
896881
"description": "Next transition of the workflow after all branches have completed execution",
897882
"$ref": "#/definitions/transition"
898883
},
899-
"dataSchema": {
900-
"$ref": "#/definitions/dataschema"
901-
},
902884
"compensatedBy": {
903885
"type": "string",
904886
"minLength": 1,
@@ -1025,9 +1007,6 @@
10251007
"description": "Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition",
10261008
"$ref": "#/definitions/defaultdef"
10271009
},
1028-
"dataSchema": {
1029-
"$ref": "#/definitions/dataschema"
1030-
},
10311010
"compensatedBy": {
10321011
"type": "string",
10331012
"minLength": 1,
@@ -1124,9 +1103,6 @@
11241103
"description": "Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition",
11251104
"$ref": "#/definitions/defaultdef"
11261105
},
1127-
"dataSchema": {
1128-
"$ref": "#/definitions/dataschema"
1129-
},
11301106
"compensatedBy": {
11311107
"type": "string",
11321108
"minLength": 1,
@@ -1346,9 +1322,6 @@
13461322
"description": "Next transition of the workflow after SubFlow has completed execution",
13471323
"$ref": "#/definitions/transition"
13481324
},
1349-
"dataSchema": {
1350-
"$ref": "#/definitions/dataschema"
1351-
},
13521325
"compensatedBy": {
13531326
"type": "string",
13541327
"minLength": 1,
@@ -1453,9 +1426,6 @@
14531426
"description": "Next transition of the workflow after subflow has completed",
14541427
"$ref": "#/definitions/transition"
14551428
},
1456-
"dataSchema": {
1457-
"$ref": "#/definitions/dataschema"
1458-
},
14591429
"compensatedBy": {
14601430
"type": "string",
14611431
"minLength": 1,
@@ -1594,9 +1564,6 @@
15941564
"description": "Next transition of the workflow after state has completed",
15951565
"$ref": "#/definitions/transition"
15961566
},
1597-
"dataSchema": {
1598-
"$ref": "#/definitions/dataschema"
1599-
},
16001567
"compensatedBy": {
16011568
"type": "string",
16021569
"minLength": 1,
@@ -1762,9 +1729,6 @@
17621729
"$ref": "#/definitions/error"
17631730
}
17641731
},
1765-
"dataSchema": {
1766-
"$ref": "#/definitions/dataschema"
1767-
},
17681732
"transition": {
17691733
"description": "Next transition of the workflow after all the actions have been performed",
17701734
"$ref": "#/definitions/transition"
@@ -2016,29 +1980,6 @@
20161980
}
20171981
},
20181982
"required": []
2019-
},
2020-
"dataschema": {
2021-
"type": "object",
2022-
"properties": {
2023-
"input": {
2024-
"type": "string",
2025-
"format": "uri",
2026-
"description": "URI to JSON Schema that workflow/state data input should adhere to"
2027-
},
2028-
"output": {
2029-
"type": "string",
2030-
"format": "uri",
2031-
"description": "URI to JSON Schema that workflow/state data output should adhere to"
2032-
}
2033-
},
2034-
"anyOf": [
2035-
{
2036-
"required": ["input"]
2037-
},
2038-
{
2039-
"required": ["output"]
2040-
}
2041-
]
20421983
}
20431984
}
20441985
}

‎specification.md

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,6 @@ which would set the workflow version to `1.0.0`.
467467
| description | Workflow description | string | no |
468468
| version | Workflow version | string | no |
469469
| schemaVersion | Workflow schema version | string | no |
470-
| [dataSchema](#DataSchema-Definition) | Workflow data schema. Allows to set expected structure of workflow data input and output | object | no |
471470
| [execTimeout](#ExecTimeout-Definition) | Defines the execution timeout for a workflow instance | object | no |
472471
| keepActive | If "true", workflow instances is not terminated when there are no active execution paths. Instance can be terminated with "terminate end definition" or reaching defined "execTimeout" | boolean | no |
473472
| [events](#Event-Definition) | Workflow event definitions. | array or string | no |
@@ -971,53 +970,6 @@ says that these events must all have a context attribute named "department" with
971970
This allows developers to write orchestration workflows that are specifically targeted to patients that are in the hospital urgent care unit,
972971
for example.
973972

974-
#### DataSchema Definition
975-
976-
| Parameter | Description | Type | Required |
977-
| --- | --- | --- | --- |
978-
| input | URI to JSON Schema that workflow/state data input should adhere to | string | no |
979-
| output | URI to JSON Schema that workflow/state data output should adhere to | string | no |
980-
981-
<details><summary><strong>Click to view example definition</strong></summary>
982-
<p>
983-
984-
<table>
985-
<tr>
986-
<th>JSON</th>
987-
<th>YAML</th>
988-
</tr>
989-
<tr>
990-
<td valign="top">
991-
992-
```json
993-
{
994-
"input": "http://myschemas.io/inputschema.json",
995-
"output": "http://myschemas.io/outputschema.json"
996-
}
997-
```
998-
999-
</td>
1000-
<td valign="top">
1001-
1002-
```yaml
1003-
input: http://myschemas.io/inputschema.json
1004-
output: http://myschemas.io/outputschema.json
1005-
```
1006-
1007-
</td>
1008-
</tr>
1009-
</table>
1010-
1011-
</details>
1012-
1013-
DataSchema definition allows you to reference an input and/or output [JSON Schema](https://json-schema.org/).
1014-
It can be used to describe the expected structure of workflow data input and data output.
1015-
If used within a workflow state, it can be used to describe the expected structure of the state
1016-
data input and data output.
1017-
1018-
The `input` property is an URI to a JSON Schema describing the expected structure of the data input.
1019-
The `output` property is an URI to a JSON Schema describing the expected structure of the data output.
1020-
1021973
#### Correlation Definition
1022974

1023975
| Parameter | Description | Type | Required |
@@ -1100,7 +1052,6 @@ The following is a detailed description of each of the defined states.
11001052
| [onEvents](#eventstate-onevents) | Define the events to be consumed and one or more actions to be performed | array | yes |
11011053
| [timeout](#eventstate-timeout) | Time period to wait for incoming events (ISO 8601 format). For example: "PT15M" (wait 15 minutes), or "P2DT3H4M" (wait 2 days, 3 hours and 4 minutes)| string | no |
11021054
| [stateDataFilter](#state-data-filter) | State data filter definition| object | no |
1103-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
11041055
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes |
11051056
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
11061057
| [start](#Start-Definition) | Is this state a starting state | object | no |
@@ -1833,7 +1784,6 @@ Transitions allow you to move from one state (control-logic block) to another. F
18331784
| [stateDataFilter](#state-data-filter) | State data filter | object | no |
18341785
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
18351786
| [transition](#Transitions) | Next transition of the workflow after all the actions have been performed | object | yes (if end is not defined) |
1836-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
18371787
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
18381788
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
18391789
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -1906,7 +1856,6 @@ Once all actions have been performed, a transition to another state can occur.
19061856
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
19071857
| eventTimeout | If eventConditions is used, defines the time period to wait for events (ISO 8601 format). For example: "PT15M" (15 minutes), or "P2DT3H4M" (2 days, 3 hours and 4 minutes)| string | yes only if eventConditions is defined |
19081858
| default | Default transition of the workflow if there is no matching data conditions or event timeout is reached. Can be a transition or end definition | object | yes |
1909-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
19101859
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
19111860
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
19121861
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -2104,7 +2053,6 @@ The `eventDataFilter` property can be used to filter event when it is received.
21042053
| [stateDataFilter](#state-data-filter) | State data filter | object | no |
21052054
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
21062055
| [transition](#Transitions) | Next transition of the workflow after the delay | object | yes (if end is not defined) |
2107-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
21082056
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
21092057
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
21102058
| [start](#Start-Definition) | Is this state a starting state | object | no |
@@ -2161,7 +2109,6 @@ Delay state waits for a certain amount of time before transitioning to a next st
21612109
| [stateDataFilter](#state-data-filter) | State data filter | object | no |
21622110
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
21632111
| [transition](#Transitions) | Next transition of the workflow after all branches have completed execution | object | yes (if end is not defined) |
2164-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
21652112
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
21662113
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
21672114
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -2364,7 +2311,6 @@ For more information, see the [Workflow Error Handling](#Workflow-Error-Handling
23642311
| [stateDataFilter](#state-data-filter) | State data filter | object | no |
23652312
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
23662313
| [transition](#Transitions) | Next transition of the workflow after subflow has completed | object | yes (if end is not defined) |
2367-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
23682314
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
23692315
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
23702316
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -2440,7 +2386,6 @@ Referenced workflows must declare their own [function](#Function-Definition) and
24402386
| data | JSON object which can be set as state's data input and can be manipulated via filter | object | yes |
24412387
| [stateDataFilter](#state-data-filter) | State data filter | object | no |
24422388
| [transition](#Transitions) | Next transition of the workflow after subflow has completed | object | yes (if end is set to false) |
2443-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
24442389
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
24452390
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
24462391
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
@@ -2656,7 +2601,6 @@ This allows you to test if your workflow behaves properly for cases when there a
26562601
| [stateDataFilter](#state-data-filter) | State data filter definition | object | no |
26572602
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
26582603
| [transition](#Transitions) | Next transition of the workflow after state has completed | object | yes (if end is not defined) |
2659-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
26602604
| [compensatedBy](#Workflow-Compensation) | Unique name of a workflow state which is responsible for compensation of this state | String | no |
26612605
| [usedForCompensation](#Workflow-Compensation) | If true, this state is used to compensate another state. Default is "false" | boolean | no |
26622606
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
@@ -2886,7 +2830,6 @@ The results of each parallel action execution are stored as elements in the stat
28862830
| [eventDataFilter](#event-data-filter) | Callback event data filter definition | object | no |
28872831
| [stateDataFilter](#state-data-filter) | State data filter definition | object | no |
28882832
| [onErrors](#Error-Definition) | States error handling and retries definitions | array | no |
2889-
| [dataSchema](#DataSchema-Definition) | State data schema. Allows to set expected structure of the states data input and output | object | no |
28902833
| [transition](#Transitions) | Next transition of the workflow after callback event has been received | object | yes |
28912834
| [start](#Start-Definition) | Is this state a starting state | object | no |
28922835
| [end](#End-Definition) | Is this state an end state | object | no |
@@ -3473,11 +3416,6 @@ Workflow data input is passed to the workflow's [start state](#Start-Definition)
34733416
<img src="media/spec/workflowdatainput.png" height="350px" alt="Workflow data input"/>
34743417
</p>
34753418

3476-
In order to define the structure of expected workflow data input you can use the workflow
3477-
[`dataSchema`](#DataSchema-Definition) `input` property. This property allows you to link to a [JSON Schema](https://json-schema.org/) definition
3478-
that describes the expected workflow data input. It can be used for documentation purposes or implementations may
3479-
decide to strictly enforce it.
3480-
34813419
#### Event Data
34823420

34833421
[Event states](#Event-State) wait for arrival of defined CloudEvents, and when consumed perform a number of defined actions.
@@ -3520,11 +3458,6 @@ There are two of rules to consider here:
35203458
<img src="media/spec/basic-state-data-passing.png" height="350px" alt="Basic state data passing"/>
35213459
</p>
35223460

3523-
In order to define the structure of expected state data input and output you can use the workflow
3524-
["dataSchema"](#DataSchema-Definition) property. It allows you to link to [JSON Schema](https://json-schema.org/) definitions
3525-
that describe the expected states data input/output. It can be used for documentation purposes or implementations may
3526-
decide to strictly enforce it.
3527-
35283461
#### State Data Filtering
35293462

35303463
Data filters allow you to select and extract specific data that is useful and needed during workflow execution.
@@ -3987,11 +3920,6 @@ Once a workflow instance reaches an end state (where the `end` property is defin
39873920
the data output of that result state becomes the workflow data output. This output can be logged or indexed depending on the
39883921
implementation details.
39893922

3990-
In order to define the structure of expected workflow data output you can use the workflow
3991-
[`dataSchema`](#DataSchema-Definition) `output` property. This property allows you to link to [JSON Schema](https://json-schema.org/) definition
3992-
that describes the expected workflow data output. It can be used for documentation purposes or implementations may
3993-
decide to strictly enforce it.
3994-
39953923
### Workflow Error Handling
39963924

39973925
Serverless Workflow language allows you to define `explicit` error handling, meaning you can define what should happen

0 commit comments

Comments
 (0)