@fluidgrids/workflows 2026.1028.2 → 2026.1030.1

package/schema/workflow-command.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://docs.fluidgrids.ai/schemas/workflow-command.schema.json",
   "title": "FluidGrids workflow-task command",
-  "description": "A flat object discriminated by an UPPER_SNAKE type. Commands travel as [JSON!]! (DB4). UPSERT_SEARCH_ATTRIBUTES, ACCEPT_UPDATE, REJECT_UPDATE and COMPLETE_UPDATE are defined but refused in Phase B.",
+  "description": "A flat object discriminated by an UPPER_SNAKE type. Commands travel as [JSON!]! (DB4). UPSERT_SEARCH_ATTRIBUTES, ACCEPT_UPDATE, REJECT_UPDATE, COMPLETE_UPDATE and SCHEDULE_ACTIVITY of kind user are Phase C: the service accepts them only for the C-GATE features its flags enable (c.searchAttributes, c.updates, c.userActivity).",
   "type": "object",
   "required": [
     "type"
@@ -467,6 +467,7 @@
             "workflowKey",
             "workflowId"
           ],
+          "description": "The open run of a workflow id, following its continue-as-new chain; firstRunId pins the chain (R2).",
           "properties": {
             "workflowKey": {
               "type": "string",
@@ -477,12 +478,82 @@
               "type": "string",
               "minLength": 1,
               "maxLength": 256
+            },
+            "firstRunId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
             }
           },
           "additionalProperties": false
         }
       ]
     },
+    "runRetryPolicy": {
+      "type": "object",
+      "required": [
+        "initialDelayMs"
+      ],
+      "description": "Run-level retry (11 §2.17), in milliseconds. maxAttempts counts every attempt; absent means unlimited, bounded by the execution timeout.",
+      "properties": {
+        "maxAttempts": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "initialDelayMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "backoffMultiplier": {
+          "type": "number",
+          "minimum": 1
+        },
+        "maxDelayMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "TIMEOUT",
+              "TRANSIENT",
+              "DEPENDENCY",
+              "AUTHORIZATION",
+              "VALIDATION",
+              "PERMANENT",
+              "UNKNOWN"
+            ]
+          }
+        },
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "timeouts": {
+      "type": "object",
+      "description": "The three workflow timeouts (11 §2.20), in milliseconds.",
+      "properties": {
+        "executionTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "runTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "workflowTaskTimeout": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
     "childOptions": {
       "type": "object",
       "required": [
@@ -544,101 +615,319 @@
         "startDelay": {
           "type": "integer",
           "minimum": 0
+        },
+        "retry": {
+          "$ref": "#/$defs/runRetryPolicy"
+        },
+        "versioningBehavior": {
+          "enum": [
+            "PINNED",
+            "AUTO_UPGRADE"
+          ]
+        },
+        "idReusePolicy": {
+          "enum": [
+            "ALLOW_DUPLICATE",
+            "ALLOW_DUPLICATE_FAILED_ONLY",
+            "REJECT_DUPLICATE"
+          ]
+        },
+        "idConflictPolicy": {
+          "enum": [
+            "FAIL",
+            "USE_EXISTING",
+            "TERMINATE_EXISTING"
+          ]
+        },
+        "fairnessKey": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+        },
+        "fairnessWeight": {
+          "type": "number",
+          "minimum": 0.1,
+          "maximum": 10,
+          "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
         }
       }
     },
-    "headers": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "string"
-      }
-    },
-    "command_SCHEDULE_ACTIVITY": {
+    "legacyCanRetryPolicy": {
       "type": "object",
       "required": [
-        "type",
-        "activityId",
-        "kind",
-        "nodeType",
-        "operation",
-        "args",
-        "retry"
+        "retryDelay"
       ],
+      "description": "The R1 activity-shaped CONTINUE_AS_NEW retry: whatever explicitRetryPolicy wrote from a Partial<RetryPolicy>, so numbers carry no integer or minimum constraint. It never had a meaning, and the service ignores it.",
       "properties": {
-        "type": {
-          "const": "SCHEDULE_ACTIVITY"
-        },
-        "headers": {
-          "$ref": "#/$defs/headers"
-        },
-        "activityId": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
+        "maxRetries": {
+          "type": "number"
         },
-        "kind": {
-          "const": "node"
+        "retryDelay": {
+          "type": "number"
         },
-        "nodeType": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
+        "backoffMultiplier": {
+          "type": "number"
         },
-        "nodeVersion": {
-          "type": "string"
+        "maxDelay": {
+          "type": "number"
         },
-        "operation": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         },
-        "args": {},
-        "connection": {
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "canOptions": {
+      "type": "object",
+      "description": "Options of a CONTINUE_AS_NEW command (C-SCHEMA, frozen in R2). retry is the R2 run-retry policy of the new run, or the R1 activity shape (retryDelay, maxRetries, maxDelay) that R1 bundles wrote and R2 bundles still write for that shape: it never had a meaning, and the service ignores it instead of reading it as a run-retry policy.",
+      "properties": {
+        "taskQueue": {
           "type": "string",
           "minLength": 1,
           "maxLength": 256
         },
         "retry": {
-          "$ref": "#/$defs/retryPolicy"
-        },
-        "startToCloseTimeout": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "scheduleToCloseTimeout": {
-          "type": "integer",
-          "minimum": 0
+          "oneOf": [
+            {
+              "$ref": "#/$defs/runRetryPolicy"
+            },
+            {
+              "$ref": "#/$defs/legacyCanRetryPolicy"
+            }
+          ]
         },
-        "scheduleToStartTimeout": {
+        "workflowTaskTimeout": {
           "type": "integer",
           "minimum": 0
         },
-        "heartbeatTimeout": {
-          "type": "integer",
-          "minimum": 0
+        "context": {
+          "type": "object"
         },
-        "cancellationType": {
+        "versioningBehavior": {
           "enum": [
-            "WAIT_CANCELLATION_COMPLETED",
-            "TRY_CANCEL",
-            "ABANDON"
+            "PINNED",
+            "AUTO_UPGRADE"
           ]
-        },
-        "priority": {
-          "type": "integer",
-          "minimum": 1,
-          "maximum": 5
-        },
-        "summary": {
-          "type": "string",
-          "maxLength": 200
-        },
-        "runOn": {
-          "type": "string"
         }
       },
       "additionalProperties": false
     },
+    "headers": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "Interceptor headers (11 §2.10): string values; a user activity carries at most 16 KiB of JSON (checked by validateCommands)."
+    },
+    "command_SCHEDULE_ACTIVITY": {
+      "description": "A oneOf on kind (C-CMD-C): node runs a canvas node operation; user (Phase C) runs a user activity on a self-hosted task queue.",
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "activityId",
+            "kind",
+            "nodeType",
+            "operation",
+            "args",
+            "retry"
+          ],
+          "properties": {
+            "type": {
+              "const": "SCHEDULE_ACTIVITY"
+            },
+            "headers": {
+              "$ref": "#/$defs/headers"
+            },
+            "activityId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "args": {},
+            "retry": {
+              "$ref": "#/$defs/retryPolicy"
+            },
+            "startToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToStartTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "heartbeatTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "cancellationType": {
+              "enum": [
+                "WAIT_CANCELLATION_COMPLETED",
+                "TRY_CANCEL",
+                "ABANDON"
+              ]
+            },
+            "priority": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 5
+            },
+            "summary": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "fairnessKey": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 255,
+              "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+            },
+            "fairnessWeight": {
+              "type": "number",
+              "minimum": 0.1,
+              "maximum": 10,
+              "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
+            },
+            "kind": {
+              "const": "node"
+            },
+            "nodeType": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "nodeVersion": {
+              "type": "string"
+            },
+            "operation": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "connection": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "runOn": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "activityId",
+            "kind",
+            "activityName",
+            "taskQueue",
+            "args",
+            "retry"
+          ],
+          "properties": {
+            "type": {
+              "const": "SCHEDULE_ACTIVITY"
+            },
+            "headers": {
+              "$ref": "#/$defs/headers"
+            },
+            "activityId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "args": {},
+            "retry": {
+              "$ref": "#/$defs/retryPolicy"
+            },
+            "startToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToStartTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "heartbeatTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "cancellationType": {
+              "enum": [
+                "WAIT_CANCELLATION_COMPLETED",
+                "TRY_CANCEL",
+                "ABANDON"
+              ]
+            },
+            "priority": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 5
+            },
+            "summary": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "fairnessKey": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 255,
+              "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+            },
+            "fairnessWeight": {
+              "type": "number",
+              "minimum": 0.1,
+              "maximum": 10,
+              "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
+            },
+            "kind": {
+              "const": "user"
+            },
+            "activityName": {
+              "type": "string",
+              "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$"
+            },
+            "taskQueue": {
+              "type": "string",
+              "pattern": "^[a-z0-9][a-z0-9-]{0,62}$"
+            },
+            "connections": {
+              "type": "array",
+              "maxItems": 16,
+              "uniqueItems": true,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 256
+              },
+              "description": "Connection names the worker may resolve for each started attempt (H2: declared by the definition and on the worker token allow-list)."
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
     "command_REQUEST_CANCEL_ACTIVITY": {
       "type": "object",
       "required": [
@@ -939,6 +1228,20 @@
         "attempts": {
           "type": "integer",
           "minimum": 1
+        },
+        "nodeType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "operation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "summary": {
+          "type": "string",
+          "maxLength": 200
         }
       },
       "additionalProperties": false,
@@ -971,7 +1274,7 @@
         },
         "input": {},
         "options": {
-          "type": "object"
+          "$ref": "#/$defs/canOptions"
         }
       },
       "additionalProperties": false