[Fix #742] Id, key and name refactor

fjtirado · fjtirado · commit 3c9316b11634 · 2024-02-21T14:38:45.000+01:00
Id is removed.
Name remains mandatory and is clarified that should be unique.
Key description is updated and becomes optional in all cases.
Version is assumed to be latest if not specified

Signed-off-by: Francisco Javier Tirado Sarti &lt;ftirados@redhat.com&gt;
diff --git a/.ci/validation/src/index.ts b/.ci/validation/src/index.ts
@@ -25,7 +25,7 @@ export module SWSchemaValidator {
     addFormats(ajv)
 
 
-    const workflowSchemaId = 'https://serverlessworkflow.io/schemas/0.8/workflow.json'
+    const workflowSchemaId = 'https://serverlessworkflow.io/schemas/0.9/workflow.json'
     const schemaPath = '../../../schema'
     export const defaultEncoding = 'utf-8'
 
diff --git a/examples/accumulate-room-readings.json b/examples/accumulate-room-readings.json
@@ -1,5 +1,4 @@
 {
-    "id": "roomreadings",
     "name": "roomreadings",
     "description": "Room Temp and Humidity Workflow",
     "version": "1.0.0",
diff --git a/examples/applicant-request-decision.json b/examples/applicant-request-decision.json
@@ -1,5 +1,4 @@
 {
-    "id": "applicantrequest",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "applicant-request-decision-workflow",
diff --git a/examples/async-function-invocation.json b/examples/async-function-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "sendcustomeremail",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "send-customer-email-workflow",
diff --git a/examples/async-subflow-invocation.json b/examples/async-subflow-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "onboardcustomer",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "onboard-customer",
diff --git a/examples/book-lending.json b/examples/book-lending.json
@@ -1,5 +1,4 @@
 {
-    "id": "booklending",
     "name": "booklending",
     "description": "Book Lending Workflow",
     "version": "1.0.0",
diff --git a/examples/car-vitals-checks-subflow.json b/examples/car-vitals-checks-subflow.json
@@ -1,5 +1,4 @@
 {
-    "id": "vitalscheck",
     "name": "vitalscheck",
     "description": "Car Vitals Check",
     "version": "1.0.0",
diff --git a/examples/car-vitals-checks.json b/examples/car-vitals-checks.json
@@ -1,5 +1,4 @@
 {
-    "id": "checkcarvitals",
     "name": "checkcarvitals",
     "description": "Check Car Vitals Workflow",
     "version": "1.0.0",
diff --git a/examples/check-inbox-periodically.json b/examples/check-inbox-periodically.json
@@ -1,5 +1,4 @@
 {
-    "id": "check-inbox",
     "name": "check-inbox",
     "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,4 @@
 {
-    "id": "notifycustomerworkflow",
     "name": "notifycustomerworkflow",
     "description": "Notify Customer",
     "version": "1.0.0",
diff --git a/examples/event-based-greeting.json b/examples/event-based-greeting.json
@@ -1,5 +1,4 @@
 {
-    "id": "eventbasedgreeting",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "Event Based Greeting Workflow",
diff --git a/examples/event-based-service-invocation.json b/examples/event-based-service-invocation.json
@@ -1,5 +1,4 @@
 {
-    "id": "vet-appointment-workflow",
     "name": "vet-appointment-workflow",
     "description": "Vet service call via events",
     "version": "1.0.0",
diff --git a/examples/event-based-transitions.json b/examples/event-based-transitions.json
@@ -1,5 +1,4 @@
 {
-    "id": "eventbasedswitchstate",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "event-based-switch-transitions",
diff --git a/examples/filling-a-glass-of-water.json b/examples/filling-a-glass-of-water.json
@@ -1,5 +1,4 @@
 {
-    "id": "fillglassofwater",
     "name": "fillglassofwater",
     "description": "Fill glass of water workflow",
     "version": "1.0.0",
diff --git a/examples/finalize-college-application.json b/examples/finalize-college-application.json
@@ -1,5 +1,4 @@
 {
-    "id": "finalize-college-application",
     "name": "finalizeCollegeApplication",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/greeting.json b/examples/greeting.json
@@ -1,5 +1,4 @@
 {
-    "id": "greeting",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "greeting-workflow",
diff --git a/examples/handle-car-auction-bids.json b/examples/handle-car-auction-bids.json
@@ -1,5 +1,4 @@
 {
-    "id": "handle-car-auction-bid",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "handle-car-auction-bid",
diff --git a/examples/hello-world.json b/examples/hello-world.json
@@ -1,8 +1,7 @@
 {
-   "id": "helloworld",
    "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-job.json b/examples/monitor-job.json
@@ -1,5 +1,4 @@
 {
-    "id": "jobmonitoring",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "jobmonitoring",
diff --git a/examples/monitor-patient-vital-signs.json b/examples/monitor-patient-vital-signs.json
@@ -1,5 +1,4 @@
 {
-    "id": "patientVitalsWorkflow",
     "name": "patientVitalsWorkflow",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/new-patient-onboarding.json b/examples/new-patient-onboarding.json
@@ -1,5 +1,4 @@
 {
-    "id": "patientonboarding",
     "name": "patientonboarding",
     "version": "1.0.0",
     "specVersion": "0.8",
diff --git a/examples/parallel-execution.json b/examples/parallel-execution.json
@@ -1,5 +1,4 @@
 {
-    "id": "parallelexec",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "parallel-execution",
diff --git a/examples/perform-customer-credit-check.json b/examples/perform-customer-credit-check.json
@@ -1,5 +1,4 @@
 {
-    "id": "customercreditcheck",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "customercreditcheck",
diff --git a/examples/process-transactions.json b/examples/process-transactions.json
@@ -1,5 +1,4 @@
 {
-    "id": "customerbankingtransactions",
     "name": "customerbankingtransactions",
     "description": "Customer Banking Transactions Workflow",
     "version": "1.0.0",
diff --git a/examples/provision-orders.json b/examples/provision-orders.json
@@ -1,5 +1,4 @@
 {
-    "id": "provisionorders",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "provision-orders",
diff --git a/examples/purchase-order-deadline.json b/examples/purchase-order-deadline.json
@@ -1,5 +1,4 @@
 {
-    "id": "order",
     "name": "order",
     "description": "Purchase Order Workflow",
     "version": "1.0.0",
diff --git a/examples/reusing-function-and-event-definitions.json b/examples/reusing-function-and-event-definitions.json
@@ -1,5 +1,4 @@
 {
-    "id": "paymentconfirmation",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "paymentconfirmation",
diff --git a/examples/send-cloudevent-on-workflow-completion.json b/examples/send-cloudevent-on-workflow-completion.json
@@ -1,5 +1,4 @@
 {
-    "id": "sendcloudeventonprovision",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "sendcloudeventonprovision",
diff --git a/examples/solving-math-problems.json b/examples/solving-math-problems.json
@@ -1,5 +1,4 @@
 {
-    "id": "solvemathproblems",
     "version": "1.0.0",
     "specVersion": "0.8",
     "name": "solve-math-problems-workflow",
diff --git a/schema/auth.json b/schema/auth.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/auth.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/auth.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - auth schema",
   "type": "object",
diff --git a/schema/common.json b/schema/common.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/common.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/common.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - common schema",
   "type": "object",
diff --git a/schema/errors.json b/schema/errors.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/errors.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/errors.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - errors schema",
   "type": "object",
diff --git a/schema/events.json b/schema/events.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/events.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/events.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - events schema",
   "type": "object",
diff --git a/schema/extensions.json b/schema/extensions.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/extensions.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/extensions.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - extensions schema",
   "type": "object",
diff --git a/schema/functions.json b/schema/functions.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/functions.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/functions.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - functions schema",
   "type": "object",
diff --git a/schema/odata.json b/schema/odata.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/odata.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/odata.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - OData command options schema",
   "type": "object",
diff --git a/schema/retries.json b/schema/retries.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/retries.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/retries.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - retries schema",
   "type": "object",
diff --git a/schema/secrets.json b/schema/secrets.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/secrets.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/secrets.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - secrets schema",
   "type": "object",
diff --git a/schema/timeouts.json b/schema/timeouts.json
@@ -1,5 +1,5 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/timeouts.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/timeouts.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - functions schema",
   "type": "object",
diff --git a/schema/workflow.json b/schema/workflow.json
@@ -1,33 +1,26 @@
 {
-  "$id": "https://serverlessworkflow.io/schemas/0.8/workflow.json",
+  "$id": "https://serverlessworkflow.io/schemas/0.9/workflow.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "description": "Serverless Workflow specification - workflow schema",
   "type": "object",
   "properties": {
-    "id": {
-      "type": "string",
-      "description": "Workflow unique identifier",
-      "minLength": 1
-    },
-    "key": {
+    "name": {
       "type": "string",
-      "description": "Domain-specific workflow identifier",
+      "description": "Workflow definition unique identifier (which must be human readable)",
       "minLength": 1
     },
-    "name": {
+    "version": {
       "type": "string",
-      "description": "Workflow name",
-      "minLength": 1
+      "description": "Workflow version",
+      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
     },
     "description": {
       "type": "string",
       "description": "Workflow description"
     },
-    "version": {
+    "key": {
       "type": "string",
-      "description": "Workflow version",
-      "minLength": 1,
-      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+      "description": "Expression that will be used to generate a domain-specific workflow instance identifier"
     },
     "annotations": {
       "type": "array",
@@ -152,22 +145,11 @@
     }
   },
   "additionalProperties": false,
-  "oneOf": [
-    {
-      "required": [
-        "id",
-        "specVersion",
-        "states"
-      ]
-    },
-    {
-      "required": [
-        "key",
-        "specVersion",
-        "states"
-      ]
-    }
-  ],
+  "required": [
+    "name",
+    "specVersion",
+    "states"
+   ],
   "definitions": {
     "sleep": {
       "type": "object",
diff --git a/specification.md b/specification.md
@@ -1925,11 +1925,10 @@ definition "id" must be a constant value.
 
 | Parameter | Description | Type | Required |
 | --- | --- |  --- | --- |
-| id | Workflow unique identifier | string | yes (if `key` is not defined) |
-| key | Domain-specific workflow identifier | string | yes (if `id` is not defined) |
-| name | Workflow name | string | no |
+| name | Workflow definition unique identifier (which must be human readable) | 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 |
-| version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format | string | no |
+| key | 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 |

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "roomreadings",`
`3`	`2`	`"name": "roomreadings",`
`4`	`3`	`"description": "Room Temp and Humidity Workflow",`
`5`	`4`	`"version": "1.0.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "applicantrequest",`
`3`	`2`	`"version": "1.0.0",`
`4`	`3`	`"specVersion": "0.8",`
`5`	`4`	`"name": "applicant-request-decision-workflow",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "sendcustomeremail",`
`3`	`2`	`"version": "1.0.0",`
`4`	`3`	`"specVersion": "0.8",`
`5`	`4`	`"name": "send-customer-email-workflow",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "onboardcustomer",`
`3`	`2`	`"version": "1.0.0",`
`4`	`3`	`"specVersion": "0.8",`
`5`	`4`	`"name": "onboard-customer",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "booklending",`
`3`	`2`	`"name": "booklending",`
`4`	`3`	`"description": "Book Lending Workflow",`
`5`	`4`	`"version": "1.0.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "vitalscheck",`
`3`	`2`	`"name": "vitalscheck",`
`4`	`3`	`"description": "Car Vitals Check",`
`5`	`4`	`"version": "1.0.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "checkcarvitals",`
`3`	`2`	`"name": "checkcarvitals",`
`4`	`3`	`"description": "Check Car Vitals Workflow",`
`5`	`4`	`"version": "1.0.0",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "check-inbox",`
`3`	`2`	`"name": "check-inbox",`
`4`	`3`	`"version": "1.0.0",`
`5`	`4`	`"specVersion": "0.8",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "id": "notifycustomerworkflow",`
`3`	`2`	`"name": "notifycustomerworkflow",`
`4`	`3`	`"description": "Notify Customer",`
`5`	`4`	`"version": "1.0.0",`