-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathiwf.yaml
1545 lines (1545 loc) · 46 KB
/
iwf.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- url: 'http://petstore.swagger.io/v2'
info:
description: >-
This APIs for iwf SDKs to operate workflows
version: 1.0.0
title: Workflow APIs
license:
name: Apache-2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
paths:
# workflow APIs are hosted by iWF server for iWF SDKs to call
/api/v1/workflow/start:
post:
summary: "start a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStartRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStartResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/signal:
post:
summary: "signal a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSignalRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/stop:
post:
summary: "stop a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStopRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/dataobjects/get:
post:
summary: "get workflow data objects aka data attributes"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetDataObjectsRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetDataObjectsResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/dataobjects/set:
post:
summary: "set workflow data objects aka data attributes"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSetDataObjectsRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/searchattributes/get:
post:
summary: "get workflow search attributes"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetSearchAttributesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetSearchAttributesResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/searchattributes/set:
post:
summary: "set workflow search attributes"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSetSearchAttributesRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/get:
post:
summary: "get a workflow's status and results(if completed & requested)"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/getWithWait: ## this will wait for workflow to close if still running
post:
summary: "get a workflow's status and results(if completed & requested), wait if the workflow is still running"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'420':
description: wait has exceeded timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/search:
post:
summary: "search for workflows by a search attribute query"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSearchRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSearchResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/reset:
post:
summary: "reset a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowResetRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowResetResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/rpc:
post:
summary: "execute an RPC of a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRpcRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowRpcResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'420':
description: RPC execution error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'450':
description: RPC acquire locking failure
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/timer/skip:
post:
summary: "skip the timer of a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowSkipTimerRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/config/update:
post:
summary: "update the config of a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowConfigUpdateRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/internal/dump:
post:
summary: "dump internal info of a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowDumpRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowDumpResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/info/healthcheck:
get:
summary: "return health info of the server"
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/HealthInfo'
/api/v1/workflow/waitForStateCompletion:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowWaitForStateCompletionRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowWaitForStateCompletionResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'420':
description: wait has exceeded timeout
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/triggerContinueAsNew:
post:
summary: "trigger ContinueAsNew for a workflow"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerContinueAsNewRequest'
responses:
'200':
description: successful operation
content: {}
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
# Below APIs are hosted by iWF SDK for iWF server to call
/api/v1/workflowState/start:
post:
summary: "for invoking WorkflowState.start API"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStateStartRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStateStartResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/WorkerErrorResponse'
/api/v1/workflowState/decide:
post:
summary: "for invoking WorkflowState.decide API"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStateDecideRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowStateDecideResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/WorkerErrorResponse'
/api/v1/workflowWorker/rpc:
post:
summary: "for invoking workflow RPC API in the worker"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowWorkerRpcRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowWorkerRpcResponse'
'400':
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/WorkerErrorResponse'
components:
schemas:
KeyValue:
type: object
properties:
key:
type: string
value:
$ref: '#/components/schemas/EncodedObject'
EncodedObject:
type: object
properties:
encoding:
type: string
data:
type: string
SearchAttributeKeyAndType:
type: object
properties:
key:
type: string
valueType:
$ref: '#/components/schemas/SearchAttributeValueType'
SearchAttributeValueType: # see https://docs.temporal.io/concepts/what-is-a-search-attribute#types
type: string
enum:
- KEYWORD
- TEXT
- DATETIME
- INT
- DOUBLE
- BOOL
- KEYWORD_ARRAY # NOTE: for Cadence/Temporal keyword array is registered in the same type as KEYWORD
SearchAttribute:
type: object
properties:
key:
type: string
stringValue: # It's used for any value than can be stored as string: keyword, text, and DATETIME
type: string
integerValue: # It's used for INT type
type: integer
format: int64
doubleValue: # For DOUBLE type
type: number
format: double
boolValue: # for BOOL type
type: boolean
stringArrayValue: # for any type than can be stored as string array: KEYWORD, TEXT, and DATETIME
type: array
items:
type: string
valueType:
$ref: '#/components/schemas/SearchAttributeValueType'
RetryPolicy:
type: object
properties:
initialIntervalSeconds: # default to 1s
type: integer
backoffCoefficient: # default to 2
type: number
format: float
maximumIntervalSeconds: # default to 100x of initial interval
type: integer
maximumAttempts: # default to 0, means unlimited
type: integer
maximumAttemptsDurationSeconds: # the end to end duration of all attempts
type: integer
WorkflowRetryPolicy:
type: object
properties:
initialIntervalSeconds: # default to 1s
type: integer
backoffCoefficient: # default to 2
type: number
format: float
maximumIntervalSeconds: # default to 100x of initial interval
type: integer
maximumAttempts: # default to 0, means unlimited
type: integer
ExecuteApiFailurePolicy:
type: string
enum:
- FAIL_WORKFLOW_ON_EXECUTE_API_FAILURE
- PROCEED_TO_CONFIGURED_STATE
StartApiFailurePolicy:
type: string
enum:
- FAIL_WORKFLOW_ON_START_API_FAILURE
- PROCEED_TO_DECIDE_ON_START_API_FAILURE # next states derived from decide() API
WaitUntilApiFailurePolicy:
type: string
enum:
- FAIL_WORKFLOW_ON_FAILURE
- PROCEED_ON_FAILURE # next states derived from execute() API
WorkflowStateOptions:
type: object
properties:
searchAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
waitUntilApiSearchAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
executeApiSearchAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
dataObjectsLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
startApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
type: integer
decideApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
type: integer
startApiRetryPolicy:
$ref: '#/components/schemas/RetryPolicy'
decideApiRetryPolicy:
$ref: '#/components/schemas/RetryPolicy'
startApiFailurePolicy:
$ref: '#/components/schemas/StartApiFailurePolicy'
executeApiFailurePolicy:
$ref: '#/components/schemas/ExecuteApiFailurePolicy'
executeApiFailureProceedStateId:
type: string
executeApiFailureProceedStateOptions:
$ref: '#/components/schemas/WorkflowStateOptions'
skipStartApi:
# all below are for compatibility
type: boolean
waitUntilApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
type: integer
executeApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
type: integer
waitUntilApiRetryPolicy:
$ref: '#/components/schemas/RetryPolicy'
executeApiRetryPolicy:
$ref: '#/components/schemas/RetryPolicy'
waitUntilApiFailurePolicy:
$ref: '#/components/schemas/WaitUntilApiFailurePolicy'
skipWaitUntil:
type: boolean
dataAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
waitUntilApiDataAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
executeApiDataAttributesLoadingPolicy:
$ref: '#/components/schemas/PersistenceLoadingPolicy'
WorkflowAlreadyStartedOptions:
type: object
required:
- ignoreAlreadyStartedError
properties:
ignoreAlreadyStartedError:
type: boolean
requestId:
type: string
WorkflowStartOptions:
type: object
properties:
workflowIDReusePolicy:
$ref: '#/components/schemas/WorkflowIDReusePolicy'
cronSchedule:
type: string
workflowStartDelaySeconds:
type: integer
format: int32
retryPolicy:
$ref: '#/components/schemas/WorkflowRetryPolicy'
searchAttributes:
type: array
items:
$ref: '#/components/schemas/SearchAttribute'
dataAttributes:
type: array
items:
$ref: '#/components/schemas/KeyValue'
workflowConfigOverride:
$ref: '#/components/schemas/WorkflowConfig'
# for compatibility
idReusePolicy:
$ref: '#/components/schemas/IDReusePolicy'
useMemoForDataAttributes:
type: boolean
workflowAlreadyStartedOptions:
$ref: '#/components/schemas/WorkflowAlreadyStartedOptions'
WorkflowIDReusePolicy:
type: string
enum:
- ALLOW_DUPLICATE_FAILED_ONLY
- ALLOW_DUPLICATE
- REJECT_DUPLICATE
- TERMINATE_IF_RUNNING
IDReusePolicy:
type: string
enum:
- ALLOW_IF_PREVIOUS_EXISTS_ABNORMALLY # Keeping typo enum for backwards compatibility
- ALLOW_IF_PREVIOUS_EXITS_ABNORMALLY
- ALLOW_IF_NO_RUNNING
- DISALLOW_REUSE
- ALLOW_TERMINATE_IF_RUNNING
PersistenceLoadingPolicy:
type: object
properties:
persistenceLoadingType:
$ref: '#/components/schemas/PersistenceLoadingType'
partialLoadingKeys:
type: array
items:
type: string
lockingKeys:
type: array
items:
type: string
useKeyAsPrefix:
type: boolean
PersistenceLoadingType:
type: string
enum:
- LOAD_ALL_WITHOUT_LOCKING
- LOAD_PARTIAL_WITHOUT_LOCKING
- LOAD_PARTIAL_WITH_EXCLUSIVE_LOCK
- LOAD_NONE
- LOAD_ALL_WITH_PARTIAL_LOCK
WorkerErrorResponse:
type: object
properties:
detail:
type: string
errorType:
type: string
HealthInfo:
type: object
properties:
condition:
type: string
hostname:
type: string
duration: # indicate how long to check the health(in seconds)
type: integer
ErrorResponse:
type: object
properties:
detail:
type: string
subStatus:
$ref: '#/components/schemas/ErrorSubStatus'
originalWorkerErrorDetail:
type: string
originalWorkerErrorType:
type: string
originalWorkerErrorStatus:
type: integer
ErrorSubStatus:
type: string
enum:
- UNCATEGORIZED_SUB_STATUS
- WORKFLOW_ALREADY_STARTED_SUB_STATUS
- WORKFLOW_NOT_EXISTS_SUB_STATUS
- WORKER_API_ERROR
- LONG_POLL_TIME_OUT_SUB_STATUS
WorkflowStartRequest:
type: object
required:
- workflowId
- iwfWorkerUrl
- iwfWorkflowType
- workflowTimeoutSeconds
properties:
workflowId:
type: string
iwfWorkflowType:
type: string
workflowTimeoutSeconds:
type: integer
iwfWorkerUrl:
type: string
startStateId:
type: string
waitForCompletionStateIds:
type: array
items:
type: string
waitForCompletionStateExecutionIds:
type: array
items:
type: string
stateInput:
$ref: '#/components/schemas/EncodedObject'
stateOptions:
$ref: '#/components/schemas/WorkflowStateOptions'
workflowStartOptions:
$ref: '#/components/schemas/WorkflowStartOptions'
WorkflowStartResponse:
type: object
properties:
workflowRunId:
type: string
WorkflowSignalRequest:
type: object
required:
- workflowId
- signalChannelName
properties:
workflowId:
type: string
workflowRunId:
type: string
signalChannelName:
type: string
signalValue:
$ref: '#/components/schemas/EncodedObject'
WorkflowStopRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
reason:
type: string
stopType:
$ref: '#/components/schemas/WorkflowStopType'
WorkflowStopType:
type: string
enum:
- CANCEL # default behavior
- TERMINATE # this will hard terminate the workflow
- FAIL
WorkflowGetDataObjectsRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
keys: # return all objects if this is empty
type: array
items:
type: string
useMemoForDataAttributes:
type: boolean
WorkflowGetDataObjectsResponse:
type: object
properties:
objects:
type: array
items:
$ref: '#/components/schemas/KeyValue'
WorkflowSetDataObjectsRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
objects:
type: array
items:
$ref: '#/components/schemas/KeyValue'
WorkflowGetSearchAttributesRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
keys:
type: array
items:
$ref: '#/components/schemas/SearchAttributeKeyAndType'
WorkflowGetSearchAttributesResponse:
type: object
properties:
searchAttributes:
type: array
items:
$ref: '#/components/schemas/SearchAttribute'
WorkflowSetSearchAttributesRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
searchAttributes:
type: array
items:
$ref: '#/components/schemas/SearchAttribute'
WorkflowGetRequest:
type: object
required:
- workflowId
properties:
workflowId:
type: string
workflowRunId:
type: string
needsResults: # result will be return if this is true, and workflow is completed
type: boolean
waitTimeSeconds: # amount of time that the request will be waiting for, only works for getWithWait API
type: integer
WorkflowGetResponse:
type: object
required:
- workflowRunId
- workflowStatus
properties:
workflowRunId:
type: string
workflowStatus:
$ref: '#/components/schemas/WorkflowStatus'
results: # result will be return if needsResults is true in request, and workflow is completed
type: array
items:
$ref: '#/components/schemas/StateCompletionOutput'
errorType:
$ref: '#/components/schemas/WorkflowErrorType'
errorMessage:
type: string
WorkflowErrorType:
type: string
enum:
- STATE_DECISION_FAILING_WORKFLOW_ERROR_TYPE
- CLIENT_API_FAILING_WORKFLOW_ERROR_TYPE
- STATE_API_FAIL_MAX_OUT_RETRY_ERROR_TYPE # deprecated
- STATE_API_FAIL_ERROR_TYPE
- INVALID_USER_WORKFLOW_CODE_ERROR_TYPE
- RPC_ACQUIRE_LOCK_FAILURE
- SERVER_INTERNAL_ERROR_TYPE
WorkflowStatus:
type: string
enum:
- RUNNING
- COMPLETED
- FAILED
- TIMEOUT
- TERMINATED
- CANCELED
- CONTINUED_AS_NEW
StateCompletionOutput:
type: object
required:
- completedStateExecutionId
- completedStateId
properties:
completedStateId:
type: string
completedStateExecutionId:
type: string
completedStateOutput:
$ref: '#/components/schemas/EncodedObject'
WorkflowSearchRequest:
type: object
required:
- query
properties:
query:
type: string
pageSize:
type: integer
format: int32
nextPageToken:
type: string
WorkflowSearchResponse:
type: object
properties:
workflowExecutions:
type: array
items:
$ref: '#/components/schemas/WorkflowSearchResponseEntry'
nextPageToken:
type: string
WorkflowSearchResponseEntry:
type: object
required:
- workflowId
- workflowRunId
properties:
workflowId:
type: string
workflowRunId:
type: string
WorkflowResetRequest:
type: object
required:
- workflowId
- resetType
properties:
workflowId:
type: string
workflowRunId:
type: string
resetType:
$ref: '#/components/schemas/WorkflowResetType'
historyEventId: #required for resetType of HISTORY_EVENT_ID. The eventID of any event after DecisionTaskStarted you want to reset to (this event is exclusive in a new run. The new run history will fork and continue from the previous eventID of this). It can be DecisionTaskCompleted, DecisionTaskFailed or others
type: integer
reason: #reason to do the reset for tracking purpose
type: string
historyEventTime: #Earliest time of history event time, required for resetType of HISTORY_EVENT_TIME.Supported formats are '2006-01-02T15:04:05+07:00', raw UnixNano and time range (N<duration>), where 0 < N < 1000000 and duration (full-notation/short-notation) can be second/s, minute/m, hour/h, day/d, week/w, month/M or year/y. For example, '15minute' or '15m' implies last 15 minutes, meaning that workflow will be reset to the first decision that completed in last 15 minutes
type: string
stateId: # required for STATE_ID resetType
type: string
stateExecutionId: # required for STATE_EXECUTION_ID resetType
type: string
skipSignalReapply: # whether skipping signals reapply after the reset point
type: boolean
skipUpdateReapply: # whether to skip reapplying updates after the reset point
type: boolean
WorkflowResetType:
type: string
enum:
- HISTORY_EVENT_ID
- BEGINNING
- HISTORY_EVENT_TIME
- STATE_ID
- STATE_EXECUTION_ID
WorkflowResetResponse:
type: object
required:
- workflowRunId
properties:
workflowRunId:
type: string
WorkflowDumpRequest:
type: object
required:
- workflowId
- workflowRunId
- pageSizeInBytes
- pageNum
properties:
workflowId:
type: string
workflowRunId:
type: string
pageSizeInBytes:
type: integer
pageNum:
type: integer
WorkflowDumpResponse:
type: object
required:
- checksum
- totalPages
- jsonData
properties:
checksum:
type: string # caller should start over if the checksum is not matched anymore