forked from CSML-by-Clevy/csml-engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
1092 lines (1057 loc) · 27 KB
/
swagger.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"
info:
version: 1.7.0
title: CSML Engine
description: CSML Engine Server API specifications
termsOfService: http://csml.dev/terms/
contact:
name: CSML dev team
email: [email protected]
url: https://csml.dev
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:5000
paths:
/status:
get:
description: Get the server status
operationId: status
tags:
- status
responses:
"200":
description: Success Response
content:
application/json:
schema:
$ref: "#/components/schemas/StatusResponse"
default:
description: Error Response
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/run:
post:
description: Process an incoming client chat request
operationId: run
tags:
- chat
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/RunRequestBot"
- $ref: "#/components/schemas/RunRequestLatestVersion"
- $ref: "#/components/schemas/RunRequestSpecificVersion"
responses:
"200":
description: Success Response
content:
application/json:
schema:
$ref: "#/components/schemas/RunResponse"
default:
description: Error Response
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/validate:
post:
description: Validate a CSML bot
operationId: validate
tags:
- lint
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/BotModel"
responses:
"200":
description: Success Response
content:
application/json:
schema:
$ref: "#/components/schemas/ValidateResponse"
default:
description: Error Response
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/bots:
post:
description: Save a new version of a bot
operationId: createBotVersion
tags:
- bot versioning
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/BotModel"
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/NewBotVersionResponse"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/bots/{bot_id}/versions:
get:
description: Get the last few versions of a bot
operationId: getLastBotVersions
tags:
- bot versioning
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: path
description: ID of bot to retrieve
required: true
schema:
type: string
- name: limit
in: query
description: max number of versions to retrieve
required: false
schema:
type: integer
default: 20
- name: pagination_key
in: query
description: pagination key (if the previous request had susequent results)
required: false
schema:
type: string
default: none
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/BotVersionsResponse"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/bots/{bot_id}/versions/{version_id}:
get:
description: Get the requested version
operationId: getBotVersion
tags:
- bot versioning
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: path
description: ID of bot
required: true
schema:
type: string
- name: version_id
in: path
description: ID of version
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/BotVersionModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
description: Delete the requested version
operationId: deleteBotVersion
tags:
- bot versioning
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: path
description: ID of bot
required: true
schema:
type: string
- name: version_id
in: path
description: ID of version
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/conversations:
get:
description: Get all past conversations for a client
operationId: getConversations
tags:
- conversations
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ConversationModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/conversations/open:
post:
description: Get the currently open conversation for the given client, or an empty response if there is none
operationId: getOpenConversation
tags:
- conversations
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClientModel"
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ConversationModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/conversations/close:
post:
description: Close any open conversation for the given client
operationId: closeOpenConversations
tags:
- conversations
security:
- ApiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClientModel"
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/messages:
get:
description: Get a client's message history
operationId: getMessages
tags:
- messages
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
- name: pagination_key
in: query
required: false
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/StateModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/state:
get:
description: Get a client's current state
operationId: getState
tags:
- state
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/StateModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/memories:
get:
description: Get a client's current memories
operationId: getMemories
tags:
- memory
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/MemoryModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
description: Create a new memory for a client
operationId: createMemory
tags:
- memory
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryModel"
responses:
"201":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
description: Delete all memories for a client
operationId: deleteMemories
tags:
- memory
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/memories/{key}:
get:
description: Get a given memory for a client
operationId: getMemory
tags:
- memory
security:
- ApiKeyAuth: []
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/MemoryModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
description: Delete a given memory
operationId: deleteMemory
tags:
- memory
security:
- ApiKeyAuth: []
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/data/clients:
delete:
description: Delete all the data belonging to a client
operationId: deleteClientData
security:
- ApiKeyAuth: []
tags:
- data
parameters:
- name: bot_id
in: query
required: true
schema:
type: string
- name: user_id
in: query
required: true
schema:
type: string
- name: channel_id
in: query
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/data/bots/{bot_id}:
delete:
description: Delete all the data in a bot
operationId: deleteBotData
tags:
- data
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: path
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/bots/{bot_id}:
get:
description: Get the latest version of a bot
operationId: getLatestBotVersion
tags:
- bot versioning
security:
- ApiKeyAuth: []
parameters:
- name: bot_id
in: path
description: ID of bot to retrieve
required: true
schema:
type: string
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/BotVersionModel"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
delete:
security:
- ApiKeyAuth: []
description: Delete all versions of a bot
operationId: deleteBot
tags:
- bot versioning
parameters:
- name: bot_id
in: path
description: ID of bot
required: true
schema:
type: string
responses:
"204":
description: ""
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-Api-Key
schemas:
BotModel:
type: object
required:
- id
- name
- default_flow
- flows
properties:
id:
type: string
example: MyBotId
name:
type: string
example: MyBot
env:
type: object
example: { "SOME_KEY": "SOME_VALUE" }
default_flow:
type: string
example: Default
fn_endpoint:
$ref: "#/components/schemas/FnEndpoint"
flows:
type: array
items:
$ref: "#/components/schemas/FlowModel"
BotVersionModel:
allOf:
- $ref: "#/components/schemas/BotModel"
- type: object
properties:
version_id:
type: string
engine_version:
$ref: "#/components/schemas/EngineVersion"
FlowModel:
type: object
required:
- id
- content
- commands
properties:
id:
type: string
example: "94c6d714-7cab-4164-9e50-ee80ec866471"
name:
type: string
example: Default
content:
type: string
example: 'start:\n say "Hello"\n goto end'
commands:
type: array
items:
type: string
example: "trigger keyword"
EventModel:
type: object
required:
- client
- payload
properties:
request_id:
type: string
description: "Unique identifier for the incoming request. Will be generated if not provided."
example: "f5a727c5-a702-4896-bd0d-a45acbae0e22"
client:
$ref: "#/components/schemas/ClientModel"
payload:
$ref: "#/components/schemas/PayloadModel"
metadata:
type: object
description: Additional metadata about the context of the request. Will be available under the '_metadata' variable in the actual conversation.
example: '{"username": "johndoe", "email": "[email protected]"}'
callback_url:
type: string
example: ""
description: if defined, all messages will be POSTed to this URL as they are emitted by the CSML engine
ttl_duration:
type: integer
example: 30
description: number of days after which to expire chatbot usage data. Don't expire data if not set. Overrides corresponding engine environment variable
low_data_mode:
type: boolean
description: if set to true, the chatbot will not store the contents of sent/received messages. Overrides corresponding engine environment variable
PayloadModel:
type: object
description: The actual payload of the request made by the user
required:
- content_type
- content
properties:
content_type:
type: string
example: "text"
content:
type: object
example: '{"text": "Hi from the user!"}'
ConversationModel:
type: object
description: A Conversation definition
required:
- client
- flow_id
- step_id
- status
properties:
id:
type: string
example: "7db5c125-e150-4df4-8cf7-b605c4f4fdcd"
client:
$ref: "#/components/schemas/ClientModel"
flow_id:
type: string
example: "Default"
step_id:
type: string
example: "start"
last_interaction_at:
type: string
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
StateModel:
type: object
required:
- type
- value
properties:
type:
type: string
value:
anyOf:
- type: string
- type: number
- type: object
- type: array
MemoryModel:
type: object
required:
- key
- value
properties:
key:
type: string
value:
anyOf:
- type: string
- type: number
- type: object
- type: array
ClientModel:
type: object
description: The Client object
required:
- bot_id
- channel_id
- user_id
properties:
bot_id:
type: string
example: "MyBotId"
channel_id:
type: string
example: "4d0341db-1a13-4470-8c26-c15a03cce502"
user_id:
type: string
example: "2fc4648b-a3f9-42db-a799-1f5b6852b1e3"
MessageModel:
type: object
required:
- payload
properties:
payload:
$ref: "#/components/schemas/PayloadModel"
interaction_order:
type: integer
conversation_id:
type: string
direction:
type: string
enum:
- SEND
- RECEIVE
LintErrorModel:
type: object
properties:
flow:
type: string
step:
type: string
line:
type: integer
column:
type: integer
message:
type: string
example: "An explicit error message"
RunRequestBot:
type: object
description: Handle chat requests with the full target bot specified in the body
required:
- bot
- event
properties:
bot:
$ref: "#/components/schemas/BotModel"
event:
$ref: "#/components/schemas/EventModel"
RunRequestLatestVersion:
type: object
description: Handle chat requests with the latest saved version of a given bot_id
required:
- bot_id
- event
properties:
bot_id:
type: string
example: MyBotID
fn_endpoint:
$ref: "#/components/schemas/FnEndpoint"
event:
$ref: "#/components/schemas/EventModel"
RunRequestSpecificVersion:
type: object
description: Handle chat requests with a specific saved version of a given bot_id
required:
- bot_id
- version_id
- event
properties:
bot_id:
type: string
example: MyBotID
version_id:
type: string
example: "86ba492a-b6fe-4c22-95ec-55be4e1c83f0"
fn_endpoint:
$ref: "#/components/schemas/FnEndpoint"
event:
$ref: "#/components/schemas/EventModel"
RunResponse:
type: object
properties:
messages:
type: array
items:
$ref: "#/components/schemas/MessageModel"
conversation_end:
type: boolean
description: Whether the conversation ends after this (either it continues to a new flow or a goto end is found)
request_id:
type: string
example: "cc3ecb87-68f9-4e2b-86e0-d6483210c69e"
received_at:
type: string
format: date-time
interaction_id:
type: string
example: "08d620f3-c2b9-4814-b228-56e7810e8e23"
client:
$ref: "#/components/schemas/ClientModel"
ValidateResponse:
type: object
properties: