Document invalid workflow_start_delay option (#446)

temporalio · Aug 21, 2024 · 6272d2c · 6272d2c
1 parent 4521cd5
commit 6272d2c
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -4725,7 +4725,7 @@
       "properties": {
         "startWorkflow": {
           "$ref": "#/definitions/v1StartWorkflowExecutionRequest",
-          "title": "Additional restrictions:\n- setting `cron_schedule` is invalid\n- setting `request_eager_execution` is invalid"
+          "title": "Additional restrictions:\n- setting `cron_schedule` is invalid\n- setting `request_eager_execution` is invalid\n- setting `workflow_start_delay` is invalid"
         },
         "updateWorkflow": {
           "$ref": "#/definitions/v1UpdateWorkflowExecutionRequest",

diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml
@@ -5234,6 +5234,7 @@ components:
             Additional restrictions:
              - setting `cron_schedule` is invalid
              - setting `request_eager_execution` is invalid
+             - setting `workflow_start_delay` is invalid
         updateWorkflow:
           allOf:
             - $ref: '#/components/schemas/UpdateWorkflowExecutionRequest'

diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto
@@ -1632,6 +1632,7 @@ message ExecuteMultiOperationRequest {
             // Additional restrictions:
             // - setting `cron_schedule` is invalid
             // - setting `request_eager_execution` is invalid
+            // - setting `workflow_start_delay` is invalid
             StartWorkflowExecutionRequest start_workflow = 1;
 
             // Additional restrictions: