Repository navigation
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2092 lines (2092 loc) · 59.5 KB
/
Copy pathopenapi.yaml
File metadata and controls
2092 lines (2092 loc) · 59.5 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: TOMEET API
version: 1.0.0
description: TOMEET backend API。Agent routes use Supabase Bearer access tokens; the public WeChat QR flow uses a one-time session token.
servers:
- url: https://{apiHost}
description: Railway production
variables:
apiHost:
default: your-api.up.railway.app
security:
- bearerAuth: []
tags:
- name: Operations
- name: Agent
- name: Uploads
- name: Users
- name: Matchmaking
- name: AdventureX Testing
- name: Rooms
- name: Jobs
- name: Authentication
- name: WeChat QR
paths:
/health:
get:
tags: [Operations]
summary: 进程存活检查
security: []
responses:
"200":
description: API 进程正常
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
/ready:
get:
tags: [Operations]
summary: 依赖服务就绪检查
security: []
responses:
"200":
description: Supabase 可访问
content:
application/json:
schema:
$ref: "#/components/schemas/ReadyResponse"
"503":
description: 依赖服务暂不可用
content:
application/json:
schema:
$ref: "#/components/schemas/NotReadyResponse"
/agent/messages:
post:
tags: [Agent]
summary: 发送用户消息
description: 写入用户消息并创建 agent_reply 异步任务。生产环境通常返回 202。
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AgentMessageInput"
responses:
"200":
description: Demo 内联处理已完成
content:
application/json:
schema:
$ref: "#/components/schemas/AgentMessageResponse"
"202":
description: 已接受,等待 Worker 处理
content:
application/json:
schema:
$ref: "#/components/schemas/AgentMessageResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
"429":
$ref: "#/components/responses/RateLimited"
/agent/messages/{userId}:
get:
tags: [Agent]
summary: 获取最近对话
parameters:
- $ref: "#/components/parameters/UserId"
responses:
"200":
description: 最近 100 条消息,按时间正序
content:
application/json:
schema:
type: object
required: [messages]
properties:
messages:
type: array
items:
$ref: "#/components/schemas/Message"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
/agent/multimodal-inputs:
post:
tags: [Agent]
summary: 登记多模态输入
description: 文件应先上传到私有 Bucket;本接口登记文件并创建理解任务。
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MultimodalInput"
responses:
"200":
description: Demo 内联处理已完成
content:
application/json:
schema:
$ref: "#/components/schemas/MultimodalResponse"
"202":
description: 已接受,等待 Worker 处理
content:
application/json:
schema:
$ref: "#/components/schemas/MultimodalResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/uploads/sign:
post:
tags: [Uploads]
summary: 创建一次性上传凭据
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/SignUploadInput"
responses:
"200":
description: Supabase signed upload path 与 token
content:
application/json:
schema:
$ref: "#/components/schemas/SignUploadResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
/uploads:
post:
tags: [Uploads]
summary: Base64 图片上传兼容接口
description: 支持 JPG、PNG、WebP,解码后最大 10MB。生产前端优先使用 /uploads/sign。
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/Base64UploadInput"
responses:
"200":
description: 文件已保存
content:
application/json:
schema:
$ref: "#/components/schemas/UploadResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
"413":
$ref: "#/components/responses/PayloadTooLarge"
/users/{userId}/model:
get:
tags: [Users]
summary: 获取公开用户模型
parameters:
- $ref: "#/components/parameters/UserId"
responses:
"200":
description: 用户模型;不包含内部记忆 profile
content:
application/json:
schema:
type: object
required: [userModel]
properties:
userModel:
$ref: "#/components/schemas/UserModel"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
/users/{userId}/adventurex-onboarding/start:
post:
tags: [Users]
summary: 幂等开始 AdventureX 引导
parameters:
- $ref: "#/components/parameters/UserId"
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
language:
type: string
enum: [zh, en]
default: zh
responses:
"200":
description: 当前引导状态和首次开场消息
content:
application/json:
schema:
type: object
required: [state, message, messages]
properties:
state:
$ref: "#/components/schemas/AdventurexOnboardingState"
message:
anyOf:
- $ref: "#/components/schemas/Message"
- type: "null"
messages:
type: array
maxItems: 1
items:
$ref: "#/components/schemas/Message"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
/offline-games:
get:
tags: [Matchmaking]
summary: 获取启用的线下游戏
responses:
"200":
description: 当前游戏目录
content:
application/json:
schema:
type: object
required: [games]
properties:
games:
type: array
items:
$ref: "#/components/schemas/OfflineGame"
"401":
$ref: "#/components/responses/Unauthenticated"
/adventurex/test-pool:
get:
tags: [AdventureX Testing]
summary: 读取当前白名单账号的虚拟测试池状态
responses:
"200":
description: 测试池状态
content:
application/json:
schema:
type: object
required: [testPool]
properties:
testPool:
$ref: "#/components/schemas/AdventurexTestPoolStatus"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"503":
description: 虚拟测试池功能未启用
post:
tags: [AdventureX Testing]
summary: 开关并配置当前白名单账号的隔离虚拟测试池
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [enabled]
properties:
enabled:
type: boolean
desiredUserCount:
type: integer
minimum: 3
maximum: 12
default: 5
responses:
"200":
description: 更新后的测试池状态
content:
application/json:
schema:
type: object
required: [testPool]
properties:
testPool:
$ref: "#/components/schemas/AdventurexTestPoolStatus"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"503":
description: 虚拟测试池功能未启用
/match-requests:
post:
tags: [Matchmaking]
summary: 创建匹配请求
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateMatchRequestInput"
responses:
"201":
description: 请求内已完成匹配
content:
application/json:
schema:
$ref: "#/components/schemas/CreateMatchRequestResponse"
"202":
description: 已进入匹配队列
content:
application/json:
schema:
$ref: "#/components/schemas/CreateMatchRequestResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/match-requests/{id}:
get:
tags: [Matchmaking]
summary: 查询匹配请求
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 匹配请求
content:
application/json:
schema:
type: object
required: [matchRequest]
properties:
matchRequest:
$ref: "#/components/schemas/MatchRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
/match-requests/{id}/cancel:
post:
tags: [Matchmaking]
summary: 取消等待中的匹配请求
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 已取消
content:
application/json:
schema:
type: object
required: [matchRequest]
properties:
matchRequest:
$ref: "#/components/schemas/MatchRequest"
canRematch:
type: boolean
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/match-requests/{id}/options:
get:
tags: [Matchmaking]
summary: 获取当前公开候选
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 不包含 hook ID、候选成员 ID 的 1–3 个候选
content:
application/json:
schema:
$ref: "#/components/schemas/PublicMatchOptions"
"404":
$ref: "#/components/responses/NotFound"
/match-requests/{id}/choices:
post:
tags: [Matchmaking]
summary: 提交结构化候选选择
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/MatchChoicesInput"
responses:
"200":
description: 选择已保存,或已加入开放局
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/match-requests/{id}/options/refresh:
post:
tags: [Matchmaking]
summary: 放弃本批候选并进入下一轮
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 已计划下一轮
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/match-requests/{id}/rematch:
post:
tags: [Matchmaking]
summary: 从已取消或已超时请求创建全新匹配请求
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 新请求和计划轮次
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/match-requests/{id}/open-room/{roomId}/join:
post:
tags: [Matchmaking]
summary: 使用 offer 版本原子加入开放局
parameters:
- $ref: "#/components/parameters/ResourceId"
- name: roomId
in: path
required: true
schema:
$ref: "#/components/schemas/Uuid"
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [offerId, sourceVersion]
properties:
offerId:
$ref: "#/components/schemas/Uuid"
sourceVersion:
type: integer
minimum: 0
responses:
"200":
description: 已加入开放局
"409":
$ref: "#/components/responses/Conflict"
/match-invites/{id}:
get:
tags: [Matchmaking]
summary: 查询匹配邀请
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 当前用户参与的匹配邀请
content:
application/json:
schema:
type: object
required: [invite]
properties:
invite:
$ref: "#/components/schemas/MatchInvite"
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
/match-invites/{id}/accept:
post:
tags: [Matchmaking]
summary: 接受初始匹配或入房邀请
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserIdBody"
responses:
"200":
description: 邀请接受结果;初始邀请双方接受后才创建房间
content:
application/json:
schema:
$ref: "#/components/schemas/MatchInviteResolution"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/match-invites/{id}/decline:
post:
tags: [Matchmaking]
summary: 拒绝初始匹配或入房邀请
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserIdBody"
responses:
"200":
description: 邀请拒绝及重新入队结果
content:
application/json:
schema:
$ref: "#/components/schemas/MatchInviteResolution"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/jobs/{id}:
get:
tags: [Jobs]
summary: 查询异步任务
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 当前用户的任务
content:
application/json:
schema:
type: object
required: [job]
properties:
job:
$ref: "#/components/schemas/LlmJob"
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
/rooms/{id}:
get:
tags: [Rooms]
summary: 查询匹配房间
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 当前用户所在的房间
content:
application/json:
schema:
type: object
required: [room]
properties:
room:
$ref: "#/components/schemas/MatchRoom"
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
/rooms/{id}/event-plan:
patch:
tags: [Rooms]
summary: 创建活动清单的新草稿版本
description: 仅初始两位 founder 可调用;expectedVersion 用于防止并发覆盖。
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventPlanInput"
responses:
"200":
description: 新草稿及更新后的房间
content:
application/json:
schema:
$ref: "#/components/schemas/EventPlanMutationResult"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/event-plan/confirm:
post:
tags: [Rooms]
summary: 确认指定活动清单版本
description: 仅 founder 可确认;两位 founder 确认同一版本后原子发布。
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ConfirmEventPlanInput"
responses:
"200":
description: 确认进度或发布结果
content:
application/json:
schema:
$ref: "#/components/schemas/EventPlanMutationResult"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/confirm:
post:
tags: [Rooms]
summary: 确认参加房间
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserIdBody"
responses:
"200":
description: 更新后的房间
content:
application/json:
schema:
type: object
required: [room]
properties:
room:
$ref: "#/components/schemas/MatchRoom"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/stop-match:
post:
tags: [Rooms]
summary: 停止房间继续匹配新成员
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserIdBody"
responses:
"200":
description: 已停止继续匹配;待处理候选重新入队
content:
application/json:
schema:
type: object
required: [room, requeuedRequestIds]
properties:
room:
$ref: "#/components/schemas/MatchRoom"
requeuedRequestIds:
type: array
items:
$ref: "#/components/schemas/Uuid"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/complete:
post:
tags: [Rooms]
summary: 标记线下活动完成
parameters:
- $ref: "#/components/parameters/ResourceId"
responses:
"200":
description: 已完成的房间
content:
application/json:
schema:
type: object
required: [room]
properties:
room:
$ref: "#/components/schemas/MatchRoom"
"401":
$ref: "#/components/responses/Unauthenticated"
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/leave:
post:
tags: [Rooms]
summary: 退出已确认房间
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RoomLeaveBody"
responses:
"200":
description: 已退出;响应包含 canRematch=false、最新匹配请求与 watching/ended 意愿状态
"404":
$ref: "#/components/responses/NotFound"
"409":
$ref: "#/components/responses/Conflict"
/rooms/{id}/feedback:
post:
tags: [Rooms]
summary: 提交活动反馈
parameters:
- $ref: "#/components/parameters/ResourceId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PostEventFeedbackInput"
responses:
"200":
description: Demo 内联更新已完成
content:
application/json:
schema:
$ref: "#/components/schemas/FeedbackResponse"
"202":
description: 反馈已保存,等待模型更新
content:
application/json:
schema:
$ref: "#/components/schemas/FeedbackResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthenticated"
"403":
$ref: "#/components/responses/Forbidden"
"409":
$ref: "#/components/responses/Conflict"
/auth/wechat/claim:
post:
tags: [Authentication]
summary: Redeem a one-time WeChat Web registration claim
description: |
The registration page reads the claim from the URL fragment and sends it
in the JSON body. A successful response returns the Supabase anonymous
session that already owns the WeChat profile. The client must call
supabase.auth.setSession before upgrading that same user with email and
password, phone and password, or a linked Google identity. If the browser
already has a session, send its optional Bearer token; a different account
receives a non-consuming 409 account-switch response.
security:
- {}
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WechatWebClaimInput"
responses:
"200":
description: Claim consumed; continue registration with the returned session
headers:
Cache-Control:
schema:
type: string
const: no-store
Referrer-Policy:
schema:
type: string
const: no-referrer
content:
application/json:
schema:
$ref: "#/components/schemas/WechatWebClaimResponse"
"400":
$ref: "#/components/responses/BadRequest"
"401":
description: Claim is invalid, expired, or already consumed
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"409":
description: The browser is signed in to a different TOMEET account; the claim is not consumed
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"429":
$ref: "#/components/responses/RateLimited"
"503":
description: WeChat Web registration is not configured
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
/wechat/connect/sessions:
post:
tags: [WeChat QR]
summary: Create a one-time WeChat QR connection session
description: |
Anonymous kiosk clients should omit Authorization. A signed-in client may
optionally send a Supabase Bearer token to bind the activated WeChat
identity to its existing profile. The session token and QR content are
returned only by this response and must not be logged or persisted.
security:
- {}
- bearerAuth: []
responses:
"201":
description: One-time QR session created
headers:
Cache-Control:
schema:
type: string
const: no-store
content:
application/json:
schema:
$ref: "#/components/schemas/WechatQrSessionCreated"
"401":
$ref: "#/components/responses/Unauthenticated"
"429":
$ref: "#/components/responses/RateLimited"
"503":
description: WeChat QR runtime is not configured
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
/wechat/connect/sessions/{sessionId}:
get:
tags: [WeChat QR]
summary: Read the current QR session state
security:
- wechatSessionToken: []
parameters:
- $ref: "#/components/parameters/WechatSessionId"
responses:
"200":
description: Current public session state
content:
application/json:
schema:
$ref: "#/components/schemas/WechatQrSession"
"401":
description: Missing or invalid one-time session token
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"404":
description: Session does not exist
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"409":
description: Session activation conflicts with an existing profile binding
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"503":
description: WeChat QR runtime is not configured
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
/wechat/connect/sessions/{sessionId}/events:
get:
tags: [WeChat QR]
summary: Stream QR session state through server-sent events
description: |
Use fetch with a readable stream because the native EventSource API
cannot set X-WeChat-Session-Token. The server immediately emits
`event: session`, emits state changes, and emits `event: done` before
closing after active, expired, or failed.
security:
- wechatSessionToken: []
parameters:
- $ref: "#/components/parameters/WechatSessionId"
responses:
"200":
description: |
SSE stream whose `session` and `done` data payloads conform to
WechatQrSession. Creation-only secrets are never included.
content:
text/event-stream:
schema:
type: string
"401":
description: Missing or invalid one-time session token
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"404":
description: Session does not exist
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
"503":
description: WeChat QR runtime is not configured
content:
application/json:
schema:
$ref: "#/components/schemas/WechatSessionError"
/wechat/connect/sessions/{sessionId}/verify:
post:
tags: [WeChat QR]
summary: Submit the verification code shown by WeChat
security:
- wechatSessionToken: []
parameters:
- $ref: "#/components/parameters/WechatSessionId"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WechatVerificationCodeInput"
responses:
"200":
description: Updated public session state
content:
application/json:
schema: