forked from bangumi/dev-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.yaml
1931 lines (1915 loc) · 51.3 KB
/
api.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
components:
schemas:
Avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
BasicReply:
properties:
createdAt:
type: integer
creator:
$ref: '#/components/schemas/User'
id:
type: integer
state:
type: integer
text:
type: string
required:
- id
- creator
- createdAt
- text
- state
type: object
CurrentUser:
properties:
avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
id:
examples:
- 1
type: integer
nickname:
examples:
- Sai🖖
type: string
permission:
properties:
subjectWikiEdit:
type: boolean
required:
- subjectWikiEdit
type: object
sign:
type: string
user_group:
type: integer
username:
examples:
- sai
type: string
required:
- id
- username
- nickname
- avatar
- sign
- user_group
- permission
type: object
Error:
description: fastify default error response
properties:
code:
type: string
error:
type: string
message:
type: string
statusCode:
type: integer
required:
- code
- error
- message
- statusCode
type: object
Group:
properties:
createdAt:
type: integer
description:
type: string
icon:
type: string
id:
type: integer
name:
type: string
nsfw:
type: boolean
title:
type: string
totalMembers:
type: integer
required:
- id
- name
- nsfw
- title
- icon
- description
- totalMembers
- createdAt
type: object
GroupMember:
properties:
avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
id:
type: integer
joinedAt:
type: integer
nickname:
type: string
username:
type: string
required:
- avatar
- id
- nickname
- username
- joinedAt
type: object
GroupProfile:
properties:
group:
$ref: '#/components/schemas/Group'
inGroup:
description: 是否已经加入小组
type: boolean
recentAddedMembers:
items:
$ref: '#/components/schemas/GroupMember'
type: array
topics:
items:
$ref: '#/components/schemas/Topic'
type: array
totalTopics:
type: integer
required:
- recentAddedMembers
- topics
- inGroup
- group
- totalTopics
type: object
HistorySummary:
properties:
commitMessage:
type: string
createdAt:
description: unix timestamp seconds
type: integer
creator:
properties:
username:
type: string
required:
- username
type: object
type:
description: 修改类型。`1` 正常修改， `11` 合并，`103` 锁定/解锁 `104` 未知
type: integer
required:
- creator
- type
- commitMessage
- createdAt
type: object
Notice:
properties:
createdAt:
description: unix timestamp in seconds
type: integer
id:
type: integer
postID:
type: integer
sender:
properties:
avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
id:
examples:
- 1
type: integer
nickname:
examples:
- Sai🖖
type: string
sign:
type: string
user_group:
type: integer
username:
examples:
- sai
type: string
required:
- id
- username
- nickname
- avatar
- sign
- user_group
title: User
type: object
title:
type: string
topicID:
type: integer
type:
description: 查看 `./lib/notify.ts` _settings
type: integer
required:
- id
- title
- type
- sender
- topicID
- postID
- createdAt
type: object
Permission:
properties:
subjectWikiEdit:
type: boolean
required:
- subjectWikiEdit
type: object
Reply:
properties:
createdAt:
type: integer
creator:
$ref: '#/components/schemas/User'
id:
type: integer
isFriend:
type: boolean
replies:
items:
$ref: '#/components/schemas/SubReply'
type: array
state:
type: integer
text:
type: string
required:
- id
- isFriend
- replies
- creator
- createdAt
- text
- state
type: object
SubReply:
properties:
createdAt:
type: integer
creator:
$ref: '#/components/schemas/User'
id:
type: integer
isFriend:
type: boolean
state:
type: integer
text:
type: string
required:
- id
- creator
- createdAt
- isFriend
- text
- state
type: object
SubjectEdit:
examples:
- infobox: |-
{{Infobox animanga/TVAnime
|中文名= 沙盒
|别名={
}
|话数= 7
|放送开始= 0000-10-06
|放送星期=
|官方网站=
|播放电视台=
|其他电视台=
|播放结束=
|其他=
|Copyright=
|平台={
[龟壳]
[Xbox Series S]
[Xbox Series X]
[Xbox Series X/S]
[PC]
[Xbox Series X|S]
}
}}
name: 沙盒
nsfw: false
platform: 0
summary: |-
本条目是一个沙盒，可以用于尝试bgm功能。
普通维基人可以随意编辑条目信息以及相关关联查看编辑效果，但是请不要完全删除沙盒说明并且不要关联非沙盒条目/人物/角色。
https://bgm.tv/group/topic/366812#post_1923517
properties:
date:
examples:
- '0000-00-00'
- '2007-01-30'
pattern: ^\d{4}-\d{2}-\d{2}$
type: string
infobox:
minLength: 1
type: string
name:
minLength: 1
type: string
nsfw:
type: boolean
platform:
type: integer
summary:
type: string
required:
- name
- infobox
- platform
- nsfw
- summary
type: object
SubjectType:
anyOf:
- enum:
- 1
type: number
- enum:
- 2
type: number
- enum:
- 3
type: number
- enum:
- 4
type: number
- enum:
- 6
type: number
title: SubjectType
SubjectWikiInfo:
properties:
availablePlatform:
items:
$ref: '#/components/schemas/WikiPlatform'
type: array
id:
type: integer
infobox:
type: string
name:
type: string
nsfw:
type: boolean
platform:
type: integer
summary:
type: string
typeID:
$ref: '#/components/schemas/SubjectType'
required:
- id
- name
- typeID
- infobox
- platform
- availablePlatform
- summary
- nsfw
type: object
Topic:
properties:
createdAt:
description: 发帖时间，unix time stamp in seconds
type: integer
creator:
properties:
avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
id:
examples:
- 1
type: integer
nickname:
examples:
- Sai🖖
type: string
sign:
type: string
user_group:
type: integer
username:
examples:
- sai
type: string
required:
- id
- username
- nickname
- avatar
- sign
- user_group
title: User
type: object
id:
description: topic id
type: integer
parentID:
description: 小组/条目ID
type: integer
repliesCount:
type: integer
title:
type: string
updatedAt:
description: 最后回复时间，unix time stamp in seconds
type: integer
required:
- id
- creator
- title
- parentID
- createdAt
- updatedAt
- repliesCount
title: Topic
type: object
TopicDetail:
properties:
createdAt:
type: integer
creator:
$ref: '#/components/schemas/User'
group:
$ref: '#/components/schemas/Group'
id:
type: integer
replies:
items:
$ref: '#/components/schemas/Reply'
type: array
state:
type: integer
text:
type: string
title:
type: string
required:
- id
- group
- creator
- title
- text
- state
- createdAt
- replies
type: object
User:
properties:
avatar:
properties:
large:
type: string
medium:
examples:
- sai
type: string
small:
type: string
required:
- small
- medium
- large
title: Avatar
type: object
id:
examples:
- 1
type: integer
nickname:
examples:
- Sai🖖
type: string
sign:
type: string
user_group:
type: integer
username:
examples:
- sai
type: string
required:
- id
- username
- nickname
- avatar
- sign
- user_group
title: User
type: object
ValidationError:
description: request data validation error
properties:
error:
type: string
message:
type: string
statusCode:
type: integer
required:
- error
- message
- statusCode
type: object
WikiPlatform:
properties:
id:
type: integer
text:
type: string
wiki_tpl:
type: string
required:
- id
- text
type: object
securitySchemes:
CookiesSession:
description: 使用 [login](#/auth/login2) 调用 API 登录，或者 使用 [demo](/demo/login) 登录
in: cookie
name: chiiNextSessionID
type: apiKey
info:
description: >-
关于订阅通知的 socket.io 相关的文档在
<https://github.com/bangumi/GraphQL/blob/master/docs/socket.io.md>
title: hello
openapi: 3.0.3
paths:
/p1/clear-notify:
post:
description: |-
标记通知为已读
不传id时会清空所有未读通知
operationId: clearNotice
requestBody:
content:
application/json:
examples:
ClearAll:
value: {}
ClearSome:
value:
id:
- 1
- 2
schema:
properties:
id:
items:
type: integer
type: array
type: object
responses:
'200':
description: 没有返回值
'401':
content:
application/json:
examples:
NeedLoginError:
value:
code: NEED_LOGIN
error: Unauthorized
message: you need to login before marking notifications as read
statusCode: 401
schema:
$ref: '#/components/schemas/Error'
description: 未登录
description: 未登录
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
security:
- CookiesSession: []
summary: 标记通知为已读
tags:
- user
/p1/groups/-/posts/{postID}:
put:
operationId: editReply
parameters:
- example: 2092074
in: path
name: postID
required: true
schema:
type: integer
requestBody:
content:
application/json:
example:
text: new post contents
schema:
properties:
text:
minLength: 1
type: string
required:
- text
type: object
required: true
responses:
'200':
content:
application/json:
schema:
properties: {}
type: object
description: Default Response
'401':
content:
application/json:
examples:
NOT_ALLOWED:
value:
code: NOT_ALLOWED
error: Unauthorized
message: you don't have permission to edit reply
statusCode: 401
schema:
$ref: '#/components/schemas/Error'
description: Default Response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
security:
- CookiesSession: []
tags:
- group
/p1/groups/-/topics/{id}:
get:
description: 获取帖子列表
operationId: getGroupTopicDetail
parameters:
- example: 371602
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TopicDetail'
description: Default Response
'404':
content:
application/json:
examples:
NotFoundError:
value:
code: NOT_FOUND
error: Not Found
message: topic not found
statusCode: 404
schema:
$ref: '#/components/schemas/Error'
description: 小组不存在
description: 小组不存在
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
tags:
- topic
/p1/groups/-/topics/{topicID}/replies:
post:
operationId: createGroupReply
parameters:
- example: 371602
in: path
name: topicID
required: true
schema:
type: integer
requestBody:
content:
application/json:
examples:
example1:
value:
content: post contents
example2:
value:
content: post contents
replyTo: 2
schema:
properties:
content:
minLength: 1
type: string
replyTo:
default: 0
description: 被回复的 topic ID, `0` 代表回复楼主
examples:
- 0
type: integer
required:
- content
type: object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BasicReply'
description: Default Response
'401':
content:
application/json:
examples:
NOT_JOIN_PRIVATE_GROUP_ERROR:
value:
code: NOT_JOIN_PRIVATE_GROUP_ERROR
error: Unauthorized
message: >-
you need to join private group '沙盒' before you create a
post or reply
statusCode: 401
schema:
$ref: '#/components/schemas/Error'
description: Default Response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
security:
- CookiesSession: []
tags:
- group
/p1/groups/{groupName}/members:
get:
description: 获取帖子列表
operationId: listGroupMembersByName
parameters:
- in: query
name: type
required: false
schema:
anyOf:
- enum:
- mod
type: string
- enum:
- normal
type: string
- enum:
- all
type: string
default: all
- in: query
name: limit
required: false
schema:
default: 30
type: integer
- in: query
name: offset
required: false
schema:
default: 0
type: integer
- in: path
name: groupName
required: true
schema:
minLength: 1
type: string
responses:
'200':
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/GroupMember'
type: array
total:
type: integer
required:
- data
- total
type: object
description: Default Response
'404':
content:
application/json:
examples:
NotFoundError:
value:
code: NOT_FOUND
error: Not Found
message: topic not found
statusCode: 404
schema:
$ref: '#/components/schemas/Error'
description: 小组不存在
description: 小组不存在
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
tags:
- topic
/p1/groups/{groupName}/profile:
get:
description: 获取小组首页
operationId: getGroupProfile
parameters:
- in: query
name: limit
required: false
schema:
default: 20
type: integer
- in: query
name: offset
required: false
schema:
default: 0
type: integer
- in: path
name: groupName
required: true
schema:
minLength: 1
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GroupProfile'
description: Default Response
'404':
content:
application/json:
examples:
NotFoundError:
value:
code: NOT_FOUND
error: Not Found
message: topic not found
statusCode: 404
schema:
$ref: '#/components/schemas/Error'
description: 小组不存在
description: 小组不存在
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 意料之外的服务器错误
description: 意料之外的服务器错误
tags:
- topic
/p1/groups/{groupName}/topics:
get:
description: 获取帖子列表
operationId: getGroupTopicsByGroupName
parameters:
- in: query
name: limit
required: false
schema:
default: 30
type: integer
- in: query
name: offset
required: false
schema:
default: 0
type: integer
- in: path
name: groupName
required: true
schema:
minLength: 1