Skip to content

Commit 6a3e9b1

Browse files
committed
Rename: ActivityListInfo => ActivityExecutionListInfo
1 parent 4fe85c1 commit 6a3e9b1

File tree

4 files changed

+89
-89
lines changed

4 files changed

+89
-89
lines changed

openapi/openapiv2.json

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -11177,6 +11177,64 @@
1117711177
}
1117811178
}
1117911179
},
11180+
"v1ActivityExecutionListInfo": {
11181+
"type": "object",
11182+
"properties": {
11183+
"activityId": {
11184+
"type": "string",
11185+
"description": "For standalone activity - a unique identifier of this activity within its namespace along with run ID (below)."
11186+
},
11187+
"runId": {
11188+
"type": "string",
11189+
"description": "The run ID of the workflow or standalone activity."
11190+
},
11191+
"workflowId": {
11192+
"type": "string",
11193+
"description": "Workflow that contains this activity - only present for workflow activity."
11194+
},
11195+
"activityType": {
11196+
"$ref": "#/definitions/v1ActivityType",
11197+
"description": "The type of the activity, a string that maps to a registered activity on a worker."
11198+
},
11199+
"scheduledTime": {
11200+
"type": "string",
11201+
"format": "date-time",
11202+
"title": "Time the activity was originally scheduled via a StartActivityExecution request.\nTODO: Workflows call this schedule_time but it's scheduled_time in PendingActivityInfo, what should we choose for\nconsistency?"
11203+
},
11204+
"closeTime": {
11205+
"type": "string",
11206+
"format": "date-time",
11207+
"description": "If the activity is in a terminal status, this field represents the time the activity transitioned to that status."
11208+
},
11209+
"status": {
11210+
"$ref": "#/definitions/v1ActivityExecutionStatus",
11211+
"description": "Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not\navailable in the list response."
11212+
},
11213+
"searchAttributes": {
11214+
"$ref": "#/definitions/v1SearchAttributes",
11215+
"description": "Search attributes from the start request."
11216+
},
11217+
"taskQueue": {
11218+
"type": "string",
11219+
"description": "The task queue this activity was scheduled on when it was originally started, updated on activity options update."
11220+
},
11221+
"stateTransitionCount": {
11222+
"type": "string",
11223+
"format": "int64",
11224+
"description": "Updated on terminal status."
11225+
},
11226+
"stateSizeBytes": {
11227+
"type": "string",
11228+
"format": "int64",
11229+
"description": "Updated once on scheduled and once on terminal status."
11230+
},
11231+
"executionDuration": {
11232+
"type": "string",
11233+
"description": "The difference between close time and scheduled time.\nThis field is only populated if the activity is closed."
11234+
}
11235+
},
11236+
"description": "Limited activity information returned in the list response."
11237+
},
1118011238
"v1ActivityExecutionStatus": {
1118111239
"type": "string",
1118211240
"enum": [
@@ -11238,64 +11296,6 @@
1123811296
"default": "ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED",
1123911297
"description": "Defines whether to allow re-using an activity ID from a previously *closed* activity.\nIf the request is denied, the server returns an `ActivityExecutionAlreadyStarted` error.\n\nSee `ActivityIdConflictPolicy` for handling ID duplication with a *running* activity.\n\n - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE: Always allow starting an activity using the same activity ID.\n - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: Allow starting an activity using the same ID only when the last activity's final state is one\nof {failed, canceled, terminated, timed out}.\n - ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE: Do not permit re-use of the ID for this activity. Future start requests could potentially change the policy,\nallowing re-use of the ID."
1124011298
},
11241-
"v1ActivityListInfo": {
11242-
"type": "object",
11243-
"properties": {
11244-
"activityId": {
11245-
"type": "string",
11246-
"description": "For standalone activity - a unique identifier of this activity within its namespace along with run ID (below)."
11247-
},
11248-
"runId": {
11249-
"type": "string",
11250-
"description": "The run ID of the workflow or standalone activity."
11251-
},
11252-
"workflowId": {
11253-
"type": "string",
11254-
"description": "Workflow that contains this activity - only present for workflow activity."
11255-
},
11256-
"activityType": {
11257-
"$ref": "#/definitions/v1ActivityType",
11258-
"description": "The type of the activity, a string that maps to a registered activity on a worker."
11259-
},
11260-
"scheduledTime": {
11261-
"type": "string",
11262-
"format": "date-time",
11263-
"title": "Time the activity was originally scheduled via a StartActivityExecution request.\nTODO: Workflows call this schedule_time but it's scheduled_time in PendingActivityInfo, what should we choose for\nconsistency?"
11264-
},
11265-
"closeTime": {
11266-
"type": "string",
11267-
"format": "date-time",
11268-
"description": "If the activity is in a terminal status, this field represents the time the activity transitioned to that status."
11269-
},
11270-
"status": {
11271-
"$ref": "#/definitions/v1ActivityExecutionStatus",
11272-
"description": "Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not\navailable in the list response."
11273-
},
11274-
"searchAttributes": {
11275-
"$ref": "#/definitions/v1SearchAttributes",
11276-
"description": "Search attributes from the start request."
11277-
},
11278-
"taskQueue": {
11279-
"type": "string",
11280-
"description": "The task queue this activity was scheduled on when it was originally started, updated on activity options update."
11281-
},
11282-
"stateTransitionCount": {
11283-
"type": "string",
11284-
"format": "int64",
11285-
"description": "Updated on terminal status."
11286-
},
11287-
"stateSizeBytes": {
11288-
"type": "string",
11289-
"format": "int64",
11290-
"description": "Updated once on scheduled and once on terminal status."
11291-
},
11292-
"executionDuration": {
11293-
"type": "string",
11294-
"description": "The difference between close time and scheduled time.\nThis field is only populated if the activity is closed."
11295-
}
11296-
},
11297-
"description": "Limited activity information returned in the list response."
11298-
},
1129911299
"v1ActivityOptions": {
1130011300
"type": "object",
1130111301
"properties": {
@@ -13889,7 +13889,7 @@
1388913889
"type": "array",
1389013890
"items": {
1389113891
"type": "object",
13892-
"$ref": "#/definitions/v1ActivityListInfo"
13892+
"$ref": "#/definitions/v1ActivityExecutionListInfo"
1389313893
}
1389413894
},
1389513895
"nextPageToken": {

openapi/openapiv3.yaml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8049,32 +8049,7 @@ components:
80498049
- $ref: '#/components/schemas/PauseInfo_Manual'
80508050
description: The activity was paused by direct API invocation.
80518051
description: 'TODO: Move this to a common package?'
8052-
ActivityFailureInfo:
8053-
type: object
8054-
properties:
8055-
scheduledEventId:
8056-
type: string
8057-
startedEventId:
8058-
type: string
8059-
identity:
8060-
type: string
8061-
activityType:
8062-
$ref: '#/components/schemas/ActivityType'
8063-
activityId:
8064-
type: string
8065-
retryState:
8066-
enum:
8067-
- RETRY_STATE_UNSPECIFIED
8068-
- RETRY_STATE_IN_PROGRESS
8069-
- RETRY_STATE_NON_RETRYABLE_FAILURE
8070-
- RETRY_STATE_TIMEOUT
8071-
- RETRY_STATE_MAXIMUM_ATTEMPTS_REACHED
8072-
- RETRY_STATE_RETRY_POLICY_NOT_SET
8073-
- RETRY_STATE_INTERNAL_SERVER_ERROR
8074-
- RETRY_STATE_CANCEL_REQUESTED
8075-
type: string
8076-
format: enum
8077-
ActivityListInfo:
8052+
ActivityExecutionListInfo:
80788053
type: object
80798054
properties:
80808055
activityId:
@@ -8135,6 +8110,31 @@ components:
81358110
The difference between close time and scheduled time.
81368111
This field is only populated if the activity is closed.
81378112
description: Limited activity information returned in the list response.
8113+
ActivityFailureInfo:
8114+
type: object
8115+
properties:
8116+
scheduledEventId:
8117+
type: string
8118+
startedEventId:
8119+
type: string
8120+
identity:
8121+
type: string
8122+
activityType:
8123+
$ref: '#/components/schemas/ActivityType'
8124+
activityId:
8125+
type: string
8126+
retryState:
8127+
enum:
8128+
- RETRY_STATE_UNSPECIFIED
8129+
- RETRY_STATE_IN_PROGRESS
8130+
- RETRY_STATE_NON_RETRYABLE_FAILURE
8131+
- RETRY_STATE_TIMEOUT
8132+
- RETRY_STATE_MAXIMUM_ATTEMPTS_REACHED
8133+
- RETRY_STATE_RETRY_POLICY_NOT_SET
8134+
- RETRY_STATE_INTERNAL_SERVER_ERROR
8135+
- RETRY_STATE_CANCEL_REQUESTED
8136+
type: string
8137+
format: enum
81388138
ActivityOptions:
81398139
type: object
81408140
properties:
@@ -10515,7 +10515,7 @@ components:
1051510515
executions:
1051610516
type: array
1051710517
items:
10518-
$ref: '#/components/schemas/ActivityListInfo'
10518+
$ref: '#/components/schemas/ActivityExecutionListInfo'
1051910519
nextPageToken:
1052010520
type: string
1052110521
description: Token to use to fetch the next page. If empty, there is no next page.

temporal/api/activity/v1/message.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ message ActivityOptions {
6161
temporal.api.common.v1.RetryPolicy retry_policy = 6;
6262
}
6363

64-
// Info for a standalone activity.
64+
// Information about a standalone activity.
6565
message ActivityExecutionInfo {
6666
// Unique identifier of this activity within its namespace along with run ID (below).
6767
string activity_id = 1;
@@ -159,7 +159,7 @@ message ActivityExecutionInfo {
159159
}
160160

161161
// Limited activity information returned in the list response.
162-
message ActivityListInfo {
162+
message ActivityExecutionListInfo {
163163
// For standalone activity - a unique identifier of this activity within its namespace along with run ID (below).
164164
string activity_id = 1;
165165
// The run ID of the workflow or standalone activity.

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2742,7 +2742,7 @@ message ListActivityExecutionsRequest {
27422742
}
27432743

27442744
message ListActivityExecutionsResponse {
2745-
repeated temporal.api.activity.v1.ActivityListInfo executions = 1;
2745+
repeated temporal.api.activity.v1.ActivityExecutionListInfo executions = 1;
27462746
// Token to use to fetch the next page. If empty, there is no next page.
27472747
bytes next_page_token = 2;
27482748
}

0 commit comments

Comments
 (0)