[Fix #742] Jean Baptiste comments

fjtirado · fjtirado · commit 877816f70a9b · 2024-03-11T12:46:42.000+01:00
Signed-off-by: Francisco Javier Tirado Sarti &lt;ftirados@redhat.com&gt;
diff --git a/examples/accumulate-room-readings.json b/examples/accumulate-room-readings.json
@@ -1,5 +1,5 @@
 {
-    "name": "roomreadings",
+    "name": "room-readings",
     "description": "Room Temp and Humidity Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/book-lending.json b/examples/book-lending.json
@@ -1,5 +1,5 @@
 {
-    "name": "booklending",
+    "name": "book-lending",
     "description": "Book Lending Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/car-vitals-checks-subflow.json b/examples/car-vitals-checks-subflow.json
@@ -1,5 +1,5 @@
 {
-    "name": "vitalscheck",
+    "name": "vitals-check",
     "description": "Car Vitals Check",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/car-vitals-checks.json b/examples/car-vitals-checks.json
@@ -1,5 +1,5 @@
 {
-    "name": "checkcarvitals",
+    "name": "check-car-vitals",
     "description": "Check Car Vitals Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/continuing-as-a-new-execution.json b/examples/continuing-as-a-new-execution.json
@@ -1,5 +1,5 @@
 {
-    "name": "notifycustomerworkflow",
+    "name": "notify-customer-workflow",
     "description": "Notify Customer",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/filling-a-glass-of-water.json b/examples/filling-a-glass-of-water.json
@@ -1,5 +1,5 @@
 {
-    "name": "fillglassofwater",
+    "name": "fill-glass-of-water",
     "description": "Fill glass of water workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/monitor-job.json b/examples/monitor-job.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "jobmonitoring",
+    "name": "job-monitoring",
     "description": "Monitor finished execution of a submitted job",
     "start": "submit-job",
     "functions": [
diff --git a/examples/new-patient-onboarding.json b/examples/new-patient-onboarding.json
@@ -1,5 +1,5 @@
 {
-    "name": "patientonboarding",
+    "name": "patient-onboarding",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "onboard",
diff --git a/examples/perform-customer-credit-check.json b/examples/perform-customer-credit-check.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "customercreditcheck",
+    "name": "customer-credit-check",
     "description": "Perform Customer Credit Check",
     "start": "check-credit",
     "functions": [
diff --git a/examples/process-transactions.json b/examples/process-transactions.json
@@ -1,5 +1,5 @@
 {
-    "name": "customerbankingtransactions",
+    "name": "customer-banking-transactions",
     "description": "Customer Banking Transactions Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/reusing-function-and-event-definitions.json b/examples/reusing-function-and-event-definitions.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "paymentconfirmation",
+    "name": "payment-confirmation",
     "description": "Performs Payment Confirmation",
     "functions": "file://functiondefs.json",
     "events": "file://eventdefs.yml",
diff --git a/examples/send-cloudevent-on-workflow-completion.json b/examples/send-cloudevent-on-workflow-completion.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "sendcloudeventonprovision",
+    "name": "send-cloudevent-provision",
     "start": "provision-orders-state",
     "events": [
         {
diff --git a/examples/solving-math-problems.json b/examples/solving-math-problems.json
@@ -1,7 +1,7 @@
 {
     "version": "1.0.0",
     "specVersion": "0.8",
-    "name": "solve-math-problems-workflow",
+    "name": "solve-math-problems",
     "description": "Solve math problems",
     "start": "solve",
     "functions": [
diff --git a/specification.md b/specification.md
@@ -4194,7 +4194,7 @@ This short-hand definition can be used if sub-workflow lookup is done only by it
 property and not its `version` property.
 
 ```json
-"subFlowRef": "mySubFlowName"
+"subFlowRef": "my-subflow-id"
 ```
 
 If you need to define the `version` properties, you can use its `object` type:
@@ -4219,7 +4219,7 @@ If you need to define the `version` properties, you can use its `object` type:
 
 ```json
 {
-    "workflowId": "handleApprovedVisaWorkflowID",
+    "workflowId": "handle-approved-visa",
     "version": "2.0.0"
 }
 ```
@@ -4228,7 +4228,7 @@ If you need to define the `version` properties, you can use its `object` type:
 <td valign="top">
 
 ```yaml
-workflowId: handleApprovedVisaWorkflowID
+workflowId: handle-approved-visa
 version: '2.0.0'
 ```
 
@@ -6107,13 +6107,13 @@ If string type, it contains the unique workflow name of the workflow that the ex
 ```json
 { 
   "end": {
-    "continueAs": "myworkflowname"
+    "continueAs": "my-workflow-name"
   }
 }
 ```
 
 Defining this should stop the current workflow execution, and continue execution as a new workflow instance of the 
-workflow which defines the workflow name of "myworkflowbane". The state data where this is define should 
+workflow which defines the workflow name of "my-workflow-name". The state data where this is define should 
 become the workflow data input of the workflow that is continuing the current workflow execution.
 
 Note that any defined `produceEvents` and `compensate` definitions should be honored before `continueAs` is applied.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "roomreadings",`
	`2`	`+ "name": "room-readings",`
`3`	`3`	`"description": "Room Temp and Humidity Workflow",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "booklending",`
	`2`	`+ "name": "book-lending",`
`3`	`3`	`"description": "Book Lending Workflow",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "vitalscheck",`
	`2`	`+ "name": "vitals-check",`
`3`	`3`	`"description": "Car Vitals Check",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "checkcarvitals",`
	`2`	`+ "name": "check-car-vitals",`
`3`	`3`	`"description": "Check Car Vitals Workflow",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "notifycustomerworkflow",`
	`2`	`+ "name": "notify-customer-workflow",`
`3`	`3`	`"description": "Notify Customer",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "fillglassofwater",`
	`2`	`+ "name": "fill-glass-of-water",`
`3`	`3`	`"description": "Fill glass of water workflow",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"version": "1.0.0",`
`3`	`3`	`"specVersion": "0.8",`
`4`		`- "name": "jobmonitoring",`
	`4`	`+ "name": "job-monitoring",`
`5`	`5`	`"description": "Monitor finished execution of a submitted job",`
`6`	`6`	`"start": "submit-job",`
`7`	`7`	`"functions": [`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "patientonboarding",`
	`2`	`+ "name": "patient-onboarding",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"specVersion": "0.8",`
`5`	`5`	`"start": "onboard",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "customerbankingtransactions",`
	`2`	`+ "name": "customer-banking-transactions",`
`3`	`3`	`"description": "Customer Banking Transactions Workflow",`
`4`	`4`	`"version": "1.0.0",`
`5`	`5`	`"specVersion": "0.8",`