Skip to content

Commit 00fc6c5

Browse files
committed
[Fix serverlessworkflow#742] Charles comments
Signed-off-by: Francisco Javier Tirado Sarti <[email protected]>
1 parent 77c77b2 commit 00fc6c5

File tree

6 files changed

+9
-8
lines changed

6 files changed

+9
-8
lines changed

examples/event-based-greeting.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"version": "1.0.0",
33
"specVersion": "0.8",
4-
"name": "Event Based Greeting Workflow",
4+
"name": "event-based-greeting-workflow",
55
"description": "Event Based Greeting",
66
"start": "greet",
77
"events": [

examples/finalize-college-application.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "finalizeCollegeApplication",
2+
"name": "finalize-college-application",
33
"version": "1.0.0",
44
"specVersion": "0.8",
55
"start": "finalize-application",

examples/hello-world.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"version": "1.0.0",
33
"specVersion": "0.8",
4-
"name": "Hello-World-Workflow",
4+
"name": "hello-world-workflow",
55
"description": "Inject Hello World",
66
"start": "hello-state",
77
"states": [

examples/monitor-patient-vital-signs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "patientVitalsWorkflow",
2+
"name": "patient-vitals-workflow",
33
"version": "1.0.0",
44
"specVersion": "0.8",
55
"start": "monitor-vitals",

schema/workflow.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"properties": {
77
"name": {
88
"type": "string",
9-
"description": "Workflow definition unique identifier (which must be human readable)",
9+
"description": "The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.",
10+
"pattern": "^[a-z0-9](-?[a-z0-9])*$",
1011
"minLength": 1
1112
},
1213
"version": {
@@ -20,7 +21,7 @@
2021
},
2122
"key": {
2223
"type": "string",
23-
"description": "Expression that will be used to generate a domain-specific workflow instance identifier"
24+
"description": "Optional expression that will be used to generate a domain-specific workflow instance identifier"
2425
},
2526
"annotations": {
2627
"type": "array",

specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1925,10 +1925,10 @@ definition "name" must be a constant value.
19251925

19261926
| Parameter | Description | Type | Required |
19271927
| --- | --- | --- | --- |
1928-
| name | Workflow definition unique identifier (which must be human readable) | string | yes |
1928+
| name | The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier. | string | yes |
19291929
| version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format. If not provided, latest is assumed | string | no |
19301930
| description | Workflow description | string | no |
1931-
| key | Expression that will be used to generate a domain-specific workflow instance identifier | string | no |
1931+
| key | Optional expression that will be used to generate a domain-specific workflow instance identifier | string | no |
19321932
| annotations | List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities | array | no |
19331933
| dataInputSchema | Used to validate the workflow data input against a defined JSON Schema| string or object | no |
19341934
| dataOutputSchema | Used to validate the workflow data output against a defined JSON Schema| string or object | no |

0 commit comments

Comments
 (0)