-
Notifications
You must be signed in to change notification settings - Fork 51
Expand file tree
/
Copy pathopenapi.yaml
More file actions
6747 lines (6699 loc) · 235 KB
/
Copy pathopenapi.yaml
File metadata and controls
6747 lines (6699 loc) · 235 KB
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.1.0
info:
title: Agentex API
version: 0.1.0
paths:
/agents/{agent_id}:
get:
tags:
- Agents
summary: Get Agent by ID
description: Get an agent by its unique ID.
operationId: get_agent_by_id_agents__agent_id__get
parameters:
- name: agent_id
in: path
required: true
schema:
type: string
title: Agent Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Agent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Agents
summary: Delete Agent by ID
description: Delete an agent by its unique ID.
operationId: delete_agent_by_id_agents__agent_id__delete
parameters:
- name: agent_id
in: path
required: true
schema:
type: string
title: Agent Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/name/{agent_name}:
get:
tags:
- Agents
summary: Get Agent by Name
description: Get an agent by its unique name.
operationId: get_agent_by_name_agents_name__agent_name__get
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Agent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Agents
summary: Delete Agent by Name
description: Delete an agent by its unique name.
operationId: delete_agent_by_name_agents_name__agent_name__delete
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents:
get:
tags:
- Agents
summary: List Agents
description: List all registered agents, optionally filtered by query parameters.
operationId: list_agents_agents_get
parameters:
- name: task_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Task ID
title: Task Id
description: Task ID
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
description: Limit
default: 50
title: Limit
description: Limit
- name: page_number
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number
default: 1
title: Page Number
description: Page number
- name: order_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Field to order by
title: Order By
description: Field to order by
- name: order_direction
in: query
required: false
schema:
type: string
description: Order direction (asc or desc)
default: desc
title: Order Direction
description: Order direction (asc or desc)
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Agent'
title: Response List Agents Agents Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/register:
post:
tags:
- Agents
summary: Register Agent
description: Register a new agent or update an existing one.
operationId: register_agent_agents_register_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAgentRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterAgentResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/register-build:
post:
tags:
- Agents
summary: Register Build
description: Register an agent at build time, before it is deployed, so it can
be permissioned and shared prior to deploy. Idempotent by name.
operationId: register_build_agents_register_build_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterBuildRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Agent'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/forward/name/{agent_name}/{path}:
get:
tags:
- Agents
summary: Forward GET request to agent by name
description: Forward a GET request to an agent by its name.
operationId: forward_get_request_to_agent_agents_forward_name__agent_name___path__get
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
- name: path
in: path
required: true
schema:
type: string
title: Path
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Agents
summary: Forward POST request to agent by name
description: Forward a POST request to an agent by its name.
operationId: forward_post_request_to_agent_agents_forward_name__agent_name___path__post
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
- name: path
in: path
required: true
schema:
type: string
title: Path
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/{agent_id}/rpc:
post:
tags:
- Agents
summary: Handle Agent RPC by ID
description: Handle JSON-RPC requests for an agent by its unique ID.
operationId: handle_agent_rpc_by_id_agents__agent_id__rpc_post
parameters:
- name: agent_id
in: path
required: true
schema:
type: string
title: Agent Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AgentRPCRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgentRPCResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/agents/name/{agent_name}/rpc:
post:
tags:
- Agents
summary: Handle Agent RPC by Name
description: Handle JSON-RPC requests for an agent by its unique name.
operationId: handle_agent_rpc_by_name_agents_name__agent_name__rpc_post
parameters:
- name: agent_name
in: path
required: true
schema:
type: string
title: Agent Name
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AgentRPCRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AgentRPCResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}:
get:
tags:
- Tasks
summary: Get Task by ID
description: Get a task by its unique ID.
operationId: get_task_tasks__task_id__get
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
- name: relationships
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/TaskRelationships'
title: Relationships
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Tasks
summary: Delete Task by ID
description: Delete a task by its unique ID.
operationId: delete_task_tasks__task_id__delete
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Tasks
summary: Update Task by ID
description: Update mutable fields for a task by its unique ID.
operationId: update_task_tasks__task_id__put
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/name/{task_name}:
get:
tags:
- Tasks
summary: Get Task by Name
description: Get a task by its unique name.
operationId: get_task_by_name_tasks_name__task_name__get
parameters:
- name: task_name
in: path
required: true
schema:
type: string
title: Task Name
- name: relationships
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/TaskRelationships'
title: Relationships
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Tasks
summary: Delete Task by Name
description: Delete a task by its unique name.
operationId: delete_task_by_name_tasks_name__task_name__delete
parameters:
- name: task_name
in: path
required: true
schema:
type: string
title: Task Name
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Tasks
summary: Update Task by Name
description: Update mutable fields for a task by its unique Name.
operationId: update_task_by_name_tasks_name__task_name__put
parameters:
- name: task_name
in: path
required: true
schema:
type: string
title: Task Name
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks:
get:
tags:
- Tasks
summary: List Tasks
description: List all tasks.
operationId: list_tasks_tasks_get
parameters:
- name: agent_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Agent Id
- name: agent_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Agent Name
- name: status
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatus'
- type: 'null'
description: Filter tasks by status (e.g. RUNNING, COMPLETED).
title: Status
description: Filter tasks by status (e.g. RUNNING, COMPLETED).
- name: task_metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 'JSON-encoded object used to filter tasks via JSONB containment.
Example: {"created_by_user_id": "abc-123"}.'
title: Task Metadata
description: 'JSON-encoded object used to filter tasks via JSONB containment.
Example: {"created_by_user_id": "abc-123"}.'
- name: limit
in: query
required: false
schema:
type: integer
default: 50
title: Limit
- name: page_number
in: query
required: false
schema:
type: integer
default: 1
title: Page Number
- name: order_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Order By
- name: order_direction
in: query
required: false
schema:
type: string
default: desc
title: Order Direction
- name: relationships
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/TaskRelationships'
title: Relationships
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TaskResponse'
title: Response List Tasks Tasks Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/complete:
post:
tags:
- Tasks
summary: Complete Task
description: Mark a running task as completed.
operationId: complete_task_tasks__task_id__complete_post
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatusReasonRequest'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/fail:
post:
tags:
- Tasks
summary: Fail Task
description: Mark a running task as failed.
operationId: fail_task_tasks__task_id__fail_post
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatusReasonRequest'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/cancel:
post:
tags:
- Tasks
summary: Cancel Task
description: Mark a running task as canceled.
operationId: cancel_task_tasks__task_id__cancel_post
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatusReasonRequest'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/terminate:
post:
tags:
- Tasks
summary: Terminate Task
description: Mark a running task as terminated.
operationId: terminate_task_tasks__task_id__terminate_post
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatusReasonRequest'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/timeout:
post:
tags:
- Tasks
summary: Timeout Task
description: Mark a running task as timed out.
operationId: timeout_task_tasks__task_id__timeout_post
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/TaskStatusReasonRequest'
- type: 'null'
title: Request
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/stream:
get:
tags:
- Tasks
summary: Stream Task Events by ID
description: Stream events for a task by its unique ID.
operationId: stream_task_events_tasks__task_id__stream_get
parameters:
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/name/{task_name}/stream:
get:
tags:
- Tasks
summary: Stream Task Events by Name
description: Stream events for a task by its unique name.
operationId: stream_task_events_by_name_tasks_name__task_name__stream_get
parameters:
- name: task_name
in: path
required: true
schema:
type: string
title: Task Name
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/tasks/{task_id}/query/{query_name}:
get:
tags:
- Tasks
summary: Query Task Workflow
description: Query a Temporal workflow associated with a task for its current
state.
operationId: query_task_workflow_tasks__task_id__query__query_name__get
parameters:
- name: query_name
in: path
required: true
schema:
type: string
title: Query Name
- name: task_id
in: path
required: true
schema:
type: string
title: Task Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Query Task Workflow Tasks Task Id Query Query Name Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/messages/batch:
put:
tags:
- Messages
summary: Batch Update Messages
operationId: batch_update_messages_messages_batch_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchUpdateTaskMessagesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TaskMessage'
type: array
title: Response Batch Update Messages Messages Batch Put
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- Messages
summary: Batch Create Messages
operationId: batch_create_messages_messages_batch_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchCreateTaskMessagesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TaskMessage'
type: array
title: Response Batch Create Messages Messages Batch Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/messages:
post:
tags:
- Messages
summary: Create Message
operationId: create_message_messages_post
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskMessageRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMessage'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Messages
summary: List Messages
description: 'List messages for a task with offset-based pagination.