Skip to content

Commit 9a8c86d

Browse files
committed
Rename: ActivityListInfo => ActivityExecutionListInfo
1 parent 1e99f6f commit 9a8c86d

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
@@ -11154,6 +11154,64 @@
1115411154
}
1115511155
}
1115611156
},
11157+
"v1ActivityExecutionListInfo": {
11158+
"type": "object",
11159+
"properties": {
11160+
"activityId": {
11161+
"type": "string",
11162+
"description": "For standalone activity - a unique identifier of this activity within its namespace along with run ID (below)."
11163+
},
11164+
"runId": {
11165+
"type": "string",
11166+
"description": "The run ID of the workflow or standalone activity."
11167+
},
11168+
"workflowId": {
11169+
"type": "string",
11170+
"description": "Workflow that contains this activity - only present for workflow activity."
11171+
},
11172+
"activityType": {
11173+
"$ref": "#/definitions/v1ActivityType",
11174+
"description": "The type of the activity, a string that maps to a registered activity on a worker."
11175+
},
11176+
"scheduledTime": {
11177+
"type": "string",
11178+
"format": "date-time",
11179+
"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?"
11180+
},
11181+
"closeTime": {
11182+
"type": "string",
11183+
"format": "date-time",
11184+
"description": "If the activity is in a terminal status, this field represents the time the activity transitioned to that status."
11185+
},
11186+
"status": {
11187+
"$ref": "#/definitions/v1ActivityExecutionStatus",
11188+
"description": "Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not\navailable in the list response."
11189+
},
11190+
"searchAttributes": {
11191+
"$ref": "#/definitions/v1SearchAttributes",
11192+
"description": "Search attributes from the start request."
11193+
},
11194+
"taskQueue": {
11195+
"type": "string",
11196+
"description": "The task queue this activity was scheduled on when it was originally started, updated on activity options update."
11197+
},
11198+
"stateTransitionCount": {
11199+
"type": "string",
11200+
"format": "int64",
11201+
"description": "Updated on terminal status."
11202+
},
11203+
"stateSizeBytes": {
11204+
"type": "string",
11205+
"format": "int64",
11206+
"description": "Updated once on scheduled and once on terminal status."
11207+
},
11208+
"executionDuration": {
11209+
"type": "string",
11210+
"description": "The difference between close time and scheduled time.\nThis field is only populated if the activity is closed."
11211+
}
11212+
},
11213+
"description": "Limited activity information returned in the list response."
11214+
},
1115711215
"v1ActivityExecutionStatus": {
1115811216
"type": "string",
1115911217
"enum": [
@@ -11215,64 +11273,6 @@
1121511273
"default": "ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED",
1121611274
"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."
1121711275
},
11218-
"v1ActivityListInfo": {
11219-
"type": "object",
11220-
"properties": {
11221-
"activityId": {
11222-
"type": "string",
11223-
"description": "For standalone activity - a unique identifier of this activity within its namespace along with run ID (below)."
11224-
},
11225-
"runId": {
11226-
"type": "string",
11227-
"description": "The run ID of the workflow or standalone activity."
11228-
},
11229-
"workflowId": {
11230-
"type": "string",
11231-
"description": "Workflow that contains this activity - only present for workflow activity."
11232-
},
11233-
"activityType": {
11234-
"$ref": "#/definitions/v1ActivityType",
11235-
"description": "The type of the activity, a string that maps to a registered activity on a worker."
11236-
},
11237-
"scheduledTime": {
11238-
"type": "string",
11239-
"format": "date-time",
11240-
"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?"
11241-
},
11242-
"closeTime": {
11243-
"type": "string",
11244-
"format": "date-time",
11245-
"description": "If the activity is in a terminal status, this field represents the time the activity transitioned to that status."
11246-
},
11247-
"status": {
11248-
"$ref": "#/definitions/v1ActivityExecutionStatus",
11249-
"description": "Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not\navailable in the list response."
11250-
},
11251-
"searchAttributes": {
11252-
"$ref": "#/definitions/v1SearchAttributes",
11253-
"description": "Search attributes from the start request."
11254-
},
11255-
"taskQueue": {
11256-
"type": "string",
11257-
"description": "The task queue this activity was scheduled on when it was originally started, updated on activity options update."
11258-
},
11259-
"stateTransitionCount": {
11260-
"type": "string",
11261-
"format": "int64",
11262-
"description": "Updated on terminal status."
11263-
},
11264-
"stateSizeBytes": {
11265-
"type": "string",
11266-
"format": "int64",
11267-
"description": "Updated once on scheduled and once on terminal status."
11268-
},
11269-
"executionDuration": {
11270-
"type": "string",
11271-
"description": "The difference between close time and scheduled time.\nThis field is only populated if the activity is closed."
11272-
}
11273-
},
11274-
"description": "Limited activity information returned in the list response."
11275-
},
1127611276
"v1ActivityOptions": {
1127711277
"type": "object",
1127811278
"properties": {
@@ -13866,7 +13866,7 @@
1386613866
"type": "array",
1386713867
"items": {
1386813868
"type": "object",
13869-
"$ref": "#/definitions/v1ActivityListInfo"
13869+
"$ref": "#/definitions/v1ActivityExecutionListInfo"
1387013870
}
1387113871
},
1387213872
"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
@@ -2740,7 +2740,7 @@ message ListActivityExecutionsRequest {
27402740
}
27412741

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

0 commit comments

Comments
 (0)