update openapi

temporalio · Aug 21, 2024 · e7778d2 · e7778d2
1 parent 8d4ec6f
commit e7778d2
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 44 deletions.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -6139,12 +6139,11 @@
           },
           "title": "Identifies a specific activity within a namespace. ActivityExecution is expected to be\nglobally unique for running workflows.\nrun_id in workflow_execution can be empty,\nwhen run_id is empty the latest run of the workflow should be selected"
         },
-        "activityUpdate": {
-          "$ref": "#/definitions/v1ActivityUpdate"
+        "activityOptionsUpdate": {
+          "$ref": "#/definitions/v1ActivityOptionsUpdate"
         },
         "identity": {
-          "type": "string",
-          "title": "The identity of the worker/client/caller"
+          "type": "string"
         }
       }
     },
@@ -6440,6 +6439,23 @@
         }
       }
     },
+    "v1ActivityOptionsUpdate": {
+      "type": "object",
+      "properties": {
+        "taskQueue": {
+          "type": "string"
+        },
+        "timeouts": {
+          "$ref": "#/definitions/v1Timeouts"
+        },
+        "retryPolicy": {
+          "$ref": "#/definitions/v1RetryPolicy"
+        },
+        "updateMask": {
+          "type": "string"
+        }
+      }
+    },
     "v1ActivityPropertiesModifiedExternallyEventAttributes": {
       "type": "object",
       "properties": {
@@ -6688,23 +6704,6 @@
       },
       "title": "Represents the identifier used by a activity author to define the activity. Typically, the\nname of a function. This is sometimes referred to as the activity's \"name\""
     },
-    "v1ActivityUpdate": {
-      "type": "object",
-      "properties": {
-        "taskQueue": {
-          "type": "string"
-        },
-        "timeouts": {
-          "$ref": "#/definitions/v1Timeouts"
-        },
-        "retryPolicy": {
-          "$ref": "#/definitions/v1RetryPolicy"
-        },
-        "updateMask": {
-          "type": "string"
-        }
-      }
-    },
     "v1AddOrUpdateRemoteClusterResponse": {
       "type": "object"
     },
@@ -11548,19 +11547,19 @@
     "v1Timeouts": {
       "type": "object",
       "properties": {
-        "scheduleToCloseTimeout": {
+        "scheduleToClose": {
           "type": "string",
           "description": "Indicates how long the caller is willing to wait for activity completion. The \"schedule\" time\nis when the activity is initially scheduled, not when the most recent retry is scheduled.\nLimits how long retries will be attempted. Either this or `start_to_close_timeout` must be\nspecified. When not specified, defaults to the workflow execution timeout.\n"
         },
-        "scheduleToStartTimeout": {
+        "scheduleToStart": {
           "type": "string",
           "title": "Limits the time an activity task can stay in a task queue before a worker picks it up. The\n\"schedule\" time is when the most recent retry is scheduled. This timeout should usually not\nbe set: it's useful in specific scenarios like worker-specific task queues. This timeout is\nalways non retryable, as all a retry would achieve is to put it back into the same queue.\nDefaults to `schedule_to_close_timeout` or workflow execution timeout if that is not\nspecified. More info:\nhttps://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/"
         },
-        "startToCloseTimeout": {
+        "startToClose": {
           "type": "string",
           "description": "Maximum time an activity is allowed to execute after being picked up by a worker. This\ntimeout is always retryable. Either this or `schedule_to_close_timeout` must be specified.\n"
         },
-        "heartbeatTimeout": {
+        "heartbeatsTimeout": {
           "type": "string",
           "description": "Maximum permitted time between successful worker heartbeats."
         }

diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml
@@ -4466,6 +4466,18 @@ components:
           $ref: '#/components/schemas/Timeouts'
         retryPolicy:
           $ref: '#/components/schemas/RetryPolicy'
+    ActivityOptionsUpdate:
+      type: object
+      properties:
+        taskQueue:
+          type: string
+        timeouts:
+          $ref: '#/components/schemas/Timeouts'
+        retryPolicy:
+          $ref: '#/components/schemas/RetryPolicy'
+        updateMask:
+          type: string
+          format: field-mask
     ActivityPropertiesModifiedExternallyEventAttributes:
       type: object
       properties:
@@ -4699,18 +4711,6 @@ components:
       description: |-
         Represents the identifier used by a activity author to define the activity. Typically, the
          name of a function. This is sometimes referred to as the activity's "name"
-    ActivityUpdate:
-      type: object
-      properties:
-        taskQueue:
-          type: string
-        timeouts:
-          $ref: '#/components/schemas/Timeouts'
-        retryPolicy:
-          $ref: '#/components/schemas/RetryPolicy'
-        updateMask:
-          type: string
-          format: field-mask
     Alert:
       type: object
       properties:
@@ -8823,7 +8823,7 @@ components:
     Timeouts:
       type: object
       properties:
-        scheduleToCloseTimeout:
+        scheduleToClose:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
           description: |-
@@ -8834,7 +8834,7 @@ components:
 
              (-- api-linter: core::0140::prepositions=disabled
                  aip.dev/not-precedent: "to" is used to indicate interval. --)
-        scheduleToStartTimeout:
+        scheduleToStart:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
           description: |-
@@ -8848,7 +8848,7 @@ components:
 
              (-- api-linter: core::0140::prepositions=disabled
                  aip.dev/not-precedent: "to" is used to indicate interval. --)
-        startToCloseTimeout:
+        startToClose:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
           description: |-
@@ -8857,7 +8857,7 @@ components:
 
              (-- api-linter: core::0140::prepositions=disabled
                  aip.dev/not-precedent: "to" is used to indicate interval. --)
-        heartbeatTimeout:
+        heartbeatsTimeout:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
           description: Maximum permitted time between successful worker heartbeats.
@@ -8940,11 +8940,10 @@ components:
           type: string
         activityExecution:
           $ref: '#/components/schemas/ActivityExecution'
-        activityUpdate:
-          $ref: '#/components/schemas/ActivityUpdate'
+        activityOptionsUpdate:
+          $ref: '#/components/schemas/ActivityOptionsUpdate'
         identity:
           type: string
-          description: The identity of the worker/client/caller
     UpdateActivityOptionsResponse:
       type: object
       properties: {}