|
6724 | 6724 | }, |
6725 | 6725 | "eventRef": { |
6726 | 6726 | "$ref": "#/definitions/WorkflowEventEventReference" |
| 6727 | + }, |
| 6728 | + "requestIdRef": { |
| 6729 | + "$ref": "#/definitions/WorkflowEventRequestIdReference" |
6727 | 6730 | } |
6728 | 6731 | } |
6729 | 6732 | }, |
|
6769 | 6772 | } |
6770 | 6773 | } |
6771 | 6774 | }, |
| 6775 | + "PauseInfoRule": { |
| 6776 | + "type": "object", |
| 6777 | + "properties": { |
| 6778 | + "ruleId": { |
| 6779 | + "type": "string", |
| 6780 | + "description": "The rule that paused the activity." |
| 6781 | + }, |
| 6782 | + "identity": { |
| 6783 | + "type": "string", |
| 6784 | + "description": "The identity of the actor that created the rule." |
| 6785 | + }, |
| 6786 | + "reason": { |
| 6787 | + "type": "string", |
| 6788 | + "description": "Reason why rule was created. Populated from rule description." |
| 6789 | + } |
| 6790 | + } |
| 6791 | + }, |
6772 | 6792 | "PendingActivityInfoPauseInfo": { |
6773 | 6793 | "type": "object", |
6774 | 6794 | "properties": { |
|
6781 | 6801 | "$ref": "#/definitions/PauseInfoManual", |
6782 | 6802 | "title": "activity was paused by the manual intervention" |
6783 | 6803 | }, |
6784 | | - "ruleId": { |
6785 | | - "type": "string", |
6786 | | - "description": "Id of the rule that paused the activity." |
| 6804 | + "rule": { |
| 6805 | + "$ref": "#/definitions/PauseInfoRule", |
| 6806 | + "title": "activity was paused by the rule" |
6787 | 6807 | } |
6788 | 6808 | } |
6789 | 6809 | }, |
|
6973 | 6993 | "eventType": { |
6974 | 6994 | "$ref": "#/definitions/v1EventType" |
6975 | 6995 | } |
6976 | | - } |
| 6996 | + }, |
| 6997 | + "description": "EventReference is a direct reference to a history event through the event ID." |
| 6998 | + }, |
| 6999 | + "WorkflowEventRequestIdReference": { |
| 7000 | + "type": "object", |
| 7001 | + "properties": { |
| 7002 | + "requestId": { |
| 7003 | + "type": "string" |
| 7004 | + }, |
| 7005 | + "eventType": { |
| 7006 | + "$ref": "#/definitions/v1EventType" |
| 7007 | + } |
| 7008 | + }, |
| 7009 | + "description": "RequestIdReference is a indirect reference to a history event through the request ID." |
6977 | 7010 | }, |
6978 | 7011 | "WorkflowRuleActionActionActivityPause": { |
6979 | 7012 | "type": "object" |
|
7030 | 7063 | "requestId": { |
7031 | 7064 | "type": "string", |
7032 | 7065 | "description": "Used to de-dupe requests. Typically should be UUID." |
| 7066 | + }, |
| 7067 | + "identity": { |
| 7068 | + "type": "string", |
| 7069 | + "description": "Identity of the actor who created the rule. Will be stored with the rule." |
| 7070 | + }, |
| 7071 | + "description": { |
| 7072 | + "type": "string", |
| 7073 | + "description": "Rule description.Will be stored with the rule." |
7033 | 7074 | } |
7034 | 7075 | } |
7035 | 7076 | }, |
|
8911 | 8952 | }, |
8912 | 8953 | "internal": { |
8913 | 8954 | "$ref": "#/definitions/CallbackInternal" |
| 8955 | + }, |
| 8956 | + "links": { |
| 8957 | + "type": "array", |
| 8958 | + "items": { |
| 8959 | + "type": "object", |
| 8960 | + "$ref": "#/definitions/apicommonv1Link" |
| 8961 | + }, |
| 8962 | + "description": "Links associated with the callback. It can be used to link to underlying resources of the\ncallback." |
8914 | 8963 | } |
8915 | 8964 | }, |
8916 | 8965 | "description": "Callback to attach to various events in the system, e.g. workflow run completion." |
|
10042 | 10091 | "$ref": "#/definitions/v1ExecuteMultiOperationResponseResponse" |
10043 | 10092 | } |
10044 | 10093 | } |
10045 | | - } |
| 10094 | + }, |
| 10095 | + "description": "IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination (\"Update-with-Start\") when both\n 1. the workflow update for the requested update ID has already completed, and\n 2. the workflow for the requested workflow ID has already been closed,\nthen you'll receive\n - an update response containing the update's outcome, and\n - a start response with a `status` field that reflects the workflow's current state." |
10046 | 10096 | }, |
10047 | 10097 | "v1ExecuteMultiOperationResponseResponse": { |
10048 | 10098 | "type": "object", |
|
12390 | 12440 | "v1RequestCancelWorkflowExecutionResponse": { |
12391 | 12441 | "type": "object" |
12392 | 12442 | }, |
| 12443 | + "v1RequestIdInfo": { |
| 12444 | + "type": "object", |
| 12445 | + "properties": { |
| 12446 | + "eventType": { |
| 12447 | + "$ref": "#/definitions/v1EventType", |
| 12448 | + "description": "The event type of the history event generated by the request." |
| 12449 | + }, |
| 12450 | + "eventId": { |
| 12451 | + "type": "string", |
| 12452 | + "format": "int64", |
| 12453 | + "description": "The event id of the history event generated by the request. It's possible the event ID is not\nknown (unflushed buffered event). In this case, the value will be zero or a negative value,\nrepresenting an invalid ID." |
| 12454 | + }, |
| 12455 | + "buffered": { |
| 12456 | + "type": "boolean", |
| 12457 | + "description": "Indicate if the request is still buffered. If so, the event ID is not known and its value\nwill be an invalid event ID." |
| 12458 | + } |
| 12459 | + }, |
| 12460 | + "description": "RequestIdInfo contains details of a request ID." |
| 12461 | + }, |
12393 | 12462 | "v1ResetActivityResponse": { |
12394 | 12463 | "type": "object" |
12395 | 12464 | }, |
|
13722 | 13791 | "type": "boolean", |
13723 | 13792 | "description": "If true, a new workflow was started." |
13724 | 13793 | }, |
| 13794 | + "status": { |
| 13795 | + "$ref": "#/definitions/v1WorkflowExecutionStatus", |
| 13796 | + "description": "Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING\nunless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs)." |
| 13797 | + }, |
13725 | 13798 | "eagerWorkflowTask": { |
13726 | 13799 | "$ref": "#/definitions/v1PollWorkflowTaskQueueResponse", |
13727 | 13800 | "description": "When `request_eager_execution` is set on the `StartWorkflowExecutionRequest`, the server - if supported - will\nreturn the first workflow task to be eagerly executed.\nThe caller is expected to have a worker available to process the task." |
| 13801 | + }, |
| 13802 | + "link": { |
| 13803 | + "$ref": "#/definitions/apicommonv1Link", |
| 13804 | + "description": "Link to the workflow event." |
13728 | 13805 | } |
13729 | 13806 | } |
13730 | 13807 | }, |
|
14846 | 14923 | "resetRunId": { |
14847 | 14924 | "type": "string", |
14848 | 14925 | "description": "Reset Run ID points to the new run when this execution is reset. If the execution is reset multiple times, it points to the latest run." |
| 14926 | + }, |
| 14927 | + "requestIdInfos": { |
| 14928 | + "type": "object", |
| 14929 | + "additionalProperties": { |
| 14930 | + "$ref": "#/definitions/v1RequestIdInfo" |
| 14931 | + }, |
| 14932 | + "description": "Request ID information (eg: history event information associated with the request ID).\nNote: It only contains request IDs from StartWorkflowExecution requests, including indirect\ncalls (eg: if SignalWithStartWorkflowExecution starts a new workflow, then the request ID is\nused in the StartWorkflowExecution request)." |
14849 | 14933 | } |
14850 | 14934 | }, |
14851 | 14935 | "description": "Holds all the extra information about workflow execution that is not part of Visibility." |
|
15447 | 15531 | "spec": { |
15448 | 15532 | "$ref": "#/definitions/v1WorkflowRuleSpec", |
15449 | 15533 | "title": "Rule specification" |
| 15534 | + }, |
| 15535 | + "createdByIdentity": { |
| 15536 | + "type": "string", |
| 15537 | + "title": "Identity of the actor that created the rule" |
| 15538 | + }, |
| 15539 | + "description": { |
| 15540 | + "type": "string", |
| 15541 | + "description": "Rule description." |
15450 | 15542 | } |
15451 | 15543 | }, |
15452 | 15544 | "description": "WorkflowRule describes a rule that can be applied to any workflow in this namespace." |
|
0 commit comments