Merge pull request #824 from fjtirado/Fix_#742

[Fix #742] Id, key and name refactor
serverlessworkflow · Mar 20, 2024 · e8ed64b · e8ed64b
2 parents 7ae6420 + 877816f
commit e8ed64b
Show file tree

Hide file tree

Showing 41 changed files with 98 additions and 156 deletions.
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,6 +1,5 @@
 {
-    "id": "roomreadings",
-    "name": "roomreadings",
+    "name": "room-readings",
     "description": "Room Temp and Humidity Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

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,6 +1,5 @@
 {
-    "id": "booklending",
-    "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,6 +1,5 @@
 {
-    "id": "vitalscheck",
-    "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,6 +1,5 @@
 {
-    "id": "checkcarvitals",
-    "name": "checkcarvitals",
+    "name": "check-car-vitals",
     "description": "Check Car Vitals Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

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,6 +1,5 @@
 {
-    "id": "notifycustomerworkflow",
-    "name": "notifycustomerworkflow",
+    "name": "notify-customer-workflow",
     "description": "Notify Customer",
     "version": "1.0.0",
     "specVersion": "0.8",

diff --git a/examples/event-based-greeting.json b/examples/event-based-greeting.json
@@ -1,8 +1,7 @@
 {
-    "id": "eventbasedgreeting",
     "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/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,6 +1,5 @@
 {
-    "id": "fillglassofwater",
-    "name": "fillglassofwater",
+    "name": "fill-glass-of-water",
     "description": "Fill glass of water workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

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

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,8 +1,7 @@
 {
-    "id": "jobmonitoring",
     "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/monitor-patient-vital-signs.json b/examples/monitor-patient-vital-signs.json
@@ -1,6 +1,5 @@
 {
-    "id": "patientVitalsWorkflow",
-    "name": "patientVitalsWorkflow",
+    "name": "patient-vitals-workflow",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "monitor-vitals",

diff --git a/examples/new-patient-onboarding.json b/examples/new-patient-onboarding.json
@@ -1,6 +1,5 @@
 {
-    "id": "patientonboarding",
-    "name": "patientonboarding",
+    "name": "patient-onboarding",
     "version": "1.0.0",
     "specVersion": "0.8",
     "start": "onboard",

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,8 +1,7 @@
 {
-    "id": "customercreditcheck",
     "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,6 +1,5 @@
 {
-    "id": "customerbankingtransactions",
-    "name": "customerbankingtransactions",
+    "name": "customer-banking-transactions",
     "description": "Customer Banking Transactions Workflow",
     "version": "1.0.0",
     "specVersion": "0.8",

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,8 +1,7 @@
 {
-    "id": "paymentconfirmation",
     "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,8 +1,7 @@
 {
-    "id": "sendcloudeventonprovision",
     "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,8 +1,7 @@
 {
-    "id": "solvemathproblems",
     "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/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,27 @@
 {
-  "$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": "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
     },
-    "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": "Optional expression that will be used to generate a domain-specific workflow instance identifier"
     },
     "annotations": {
       "type": "array",
@@ -152,22 +146,11 @@
     }
   },
   "additionalProperties": false,
-  "oneOf": [
-    {
-      "required": [
-        "id",
-        "specVersion",
-        "states"
-      ]
-    },
-    {
-      "required": [
-        "key",
-        "specVersion",
-        "states"
-      ]
-    }
-  ],
+  "required": [
+    "name",
+    "specVersion",
+    "states"
+   ],
   "definitions": {
     "sleep": {
       "type": "object",