[Fix #742] Charles comments

Signed-off-by: Francisco Javier Tirado Sarti <ftirados@redhat.com>
serverlessworkflow · Mar 8, 2024 · 00fc6c5 · 00fc6c5
1 parent 77c77b2
commit 00fc6c5
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 8 deletions.
diff --git a/examples/event-based-greeting.json b/examples/event-based-greeting.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "Event Based Greeting Workflow",
+    "name": "event-based-greeting-workflow",
     "description": "Event Based Greeting",
     "start": "greet",
     "events": [

diff --git a/examples/finalize-college-application.json b/examples/finalize-college-application.json
@@ -1,5 +1,5 @@
 {
-    "name": "finalizeCollegeApplication",
+    "name": "finalize-college-application",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "finalize-application",

diff --git a/examples/hello-world.json b/examples/hello-world.json
@@ -1,7 +1,7 @@
 {
    "version": "1.0.0",
    "specVersion": "0.8",
-   "name": "Hello-World-Workflow",
+   "name": "hello-world-workflow",
    "description": "Inject Hello World",
    "start": "hello-state",
    "states": [

diff --git a/examples/monitor-patient-vital-signs.json b/examples/monitor-patient-vital-signs.json
@@ -1,5 +1,5 @@
 {
-    "name": "patientVitalsWorkflow",
+    "name": "patient-vitals-workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "monitor-vitals",

diff --git a/schema/workflow.json b/schema/workflow.json
@@ -6,7 +6,8 @@
   "properties": {
     "name": {
       "type": "string",
-      "description": "Workflow definition unique identifier (which must be human readable)",
+      "description": "The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.",
+	  "pattern": "^[a-z0-9](-?[a-z0-9])*$",
       "minLength": 1
     },
     "version": {
@@ -20,7 +21,7 @@
     },
     "key": {
       "type": "string",
-      "description": "Expression that will be used to generate a domain-specific workflow instance identifier"
+      "description": "Optional expression that will be used to generate a domain-specific workflow instance identifier"
     },
     "annotations": {
       "type": "array",

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