-
Notifications
You must be signed in to change notification settings - Fork 1
/
ugc.json
16774 lines (16774 loc) · 630 KB
/
ugc.json
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
{
"host": "demo.accelbyte.io",
"info": {
"contact": {
"email": "[email protected]",
"name": "Engineering Team at AccelByte",
"url": "https://accelbyte.io"
},
"description": "Justice UGC Service",
"title": "justice-ugc-service",
"version": "2.23.1"
},
"schemes": [
"https"
],
"externalDocs": {
"description": "API Docs",
"url": "https://stage.accelbyte.io/ugc/apidocs"
},
"securityDefinitions": {
"authorization": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
},
"swagger": "2.0",
"paths": {
"/ugc/v1/admin/namespaces/{namespace}/channels": {
"get": {
"consumes": [
"application/json"
],
"description": "Get official channel paginated",
"operationId": "SingleAdminGetChannel",
"parameters": [
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"description": "number of content per page",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"default": 0,
"description": "the offset number to retrieve",
"in": "query",
"name": "offset",
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Get channels",
"schema": {
"$ref": "#/definitions/models.PaginatedGetChannelResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770702\u003c/td\u003e\u003ctd\u003einvalid paging parameter\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770700\u003c/td\u003e\u003ctd\u003eUnable get user channels\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get Channels",
"tags": [
"Admin Channel"
],
"x-errorCodes": {
"20001": "unauthorized access",
"770700": "Unable get user channels",
"770702": "invalid paging parameter"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CHANNEL [READ]"
]
}
]
},
"post": {
"consumes": [
"application/json"
],
"description": "Create official channel",
"operationId": "AdminCreateChannel",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.ChannelRequest"
}
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Channel created",
"schema": {
"$ref": "#/definitions/models.ChannelResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770503\u003c/td\u003e\u003ctd\u003eInvalid channel {ID}: should uuid without hypen\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"409": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770504\u003c/td\u003e\u003ctd\u003eChannel already exist\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770502\u003c/td\u003e\u003ctd\u003eUnable to save channel\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create Channel",
"tags": [
"Admin Channel"
],
"x-errorCodes": {
"20001": "unauthorized access",
"770502": "Unable to save channel",
"770503": "Invalid channel {ID}: should uuid without hypen",
"770504": "Channel already exist"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CHANNEL [CREATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Delete official channel",
"operationId": "SingleAdminDeleteChannel",
"parameters": [
{
"description": "channelID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "Channel deleted"
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772502\u003c/td\u003e\u003ctd\u003eChannel not found\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772501\u003c/td\u003e\u003ctd\u003eUnable to delete channel\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete Channel",
"tags": [
"Admin Channel"
],
"x-errorCodes": {
"20001": "unauthorized access",
"772501": "Unable to delete channel",
"772502": "Channel not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CHANNEL [DELETE]"
]
}
]
},
"put": {
"consumes": [
"application/json"
],
"description": "Update official channel",
"operationId": "SingleAdminUpdateChannel",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.UpdateChannelRequest"
}
},
{
"description": "channelID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Channel updated",
"schema": {
"$ref": "#/definitions/models.ChannelResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770600\u003c/td\u003e\u003ctd\u003eInvalid request body\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770603\u003c/td\u003e\u003ctd\u003eChannel was not found\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770602\u003c/td\u003e\u003ctd\u003eUnable to save channel\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update Channel",
"tags": [
"Admin Channel"
],
"x-errorCodes": {
"20001": "unauthorized access",
"770600": "Invalid request body",
"770602": "Unable to save channel",
"770603": "Channel was not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CHANNEL [UPDATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents": {
"post": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [CREATE]\u0026lt;/b\u0026gt;.\\n \n\t\t\t\tAll request body are required except preview, tags and customAttributes.\n\t\t\t\t",
"operationId": "AdminUploadContentDirect",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.CreateContentRequest"
}
},
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Content uploaded",
"schema": {
"$ref": "#/definitions/models.CreateContentResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770100\u003c/td\u003e\u003ctd\u003eMalformed request/Invalid request body/channel do not exist\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770104\u003c/td\u003e\u003ctd\u003eUser has been banned to create content\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20013\u003c/td\u003e\u003ctd\u003einsufficient permission\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"409": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770103\u003c/td\u003e\u003ctd\u003eUnable to save ugc content: shareCode exceed the limit\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770102\u003c/td\u003e\u003ctd\u003eUnable to check user ban status/Unable to save ugc content: unable to get channel\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Upload content to a channel",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"770100": "Malformed request/Invalid request body/channel do not exist",
"770102": "Unable to check user ban status/Unable to save ugc content: unable to get channel",
"770103": "Unable to save ugc content: shareCode exceed the limit",
"770104": "User has been banned to create content"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [CREATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/s3": {
"post": {
"consumes": [
"application/json"
],
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [CREATE]\u0026lt;/b\u0026gt;.\n\nAll request body are required except \u0026lt;code\u0026gt;preview\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;tags\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;contentType\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;customAttributes\u0026lt;/code\u0026gt; and \u0026lt;code\u0026gt;shareCode\u0026lt;/code\u0026gt;.\n\n\u0026lt;code\u0026gt;contentType\u0026lt;/code\u0026gt; values is used to enforce the Content-Type header needed by the client when uploading the content using the S3 presigned URL. If not specified, it will use fileExtension value.\n\n\u0026lt;code\u0026gt;shareCode\u0026lt;/code\u0026gt; format should follows: \n\nLength: 7\nAvailable characters: abcdefhkpqrstuxyz\n\n\u0026lt;br\u0026gt;\u0026lt;p\u0026gt;\u0026lt;b\u0026gt;NOTE: Preview is Legacy Code, please use Screenshot for better solution to display preview of a content\u0026lt;/b\u0026gt;\u0026lt;/p\u0026gt;",
"operationId": "AdminUploadContentS3",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.CreateContentRequestS3"
}
},
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Content Uploaded to S3 bucket ",
"schema": {
"$ref": "#/definitions/models.CreateContentResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770100\u003c/td\u003e\u003ctd\u003eMalformed request/Invalid request body/channel do not exist\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770107\u003c/td\u003e\u003ctd\u003eUnable to update ugc content: invalid shareCode format\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770104\u003c/td\u003e\u003ctd\u003eUser has been banned to create content\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"409": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770103\u003c/td\u003e\u003ctd\u003eUnable to save ugc content: shareCode exceed the limit\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770102\u003c/td\u003e\u003ctd\u003eUnable to check user ban status/Unable to save ugc content: unable to get channel\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770103\u003c/td\u003e\u003ctd\u003eUnable to save ugc content: shareCode exceed the limit\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Upload content to S3 bucket",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"770100": "Malformed request/Invalid request body/channel do not exist",
"770102": "Unable to check user ban status/Unable to save ugc content: unable to get channel",
"770103": "Unable to save ugc content: shareCode exceed the limit",
"770104": "User has been banned to create content",
"770107": "Unable to update ugc content: invalid shareCode format"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [CREATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/s3/{contentId}": {
"put": {
"consumes": [
"application/json"
],
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [UPDATE]\u0026lt;/b\u0026gt;.\n\nAll request body are required except \u0026lt;code\u0026gt;payload\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;preview\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;tags\u0026lt;/code\u0026gt;,\u0026lt;code\u0026gt;contentType\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;updateContentFile\u0026lt;/code\u0026gt;, \u0026lt;code\u0026gt;customAttributes\u0026lt;/code\u0026gt; and \u0026lt;code\u0026gt;shareCode\u0026lt;/code\u0026gt;.\n\n\u0026lt;code\u0026gt;contentType\u0026lt;/code\u0026gt; values is used to enforce the Content-Type header needed by the client to upload the content using the S3 presigned URL.\n\nIf not specified, it will use \u0026lt;code\u0026gt;fileExtension\u0026lt;/code\u0026gt; value.\n\nTo update content file, set \u0026lt;code\u0026gt;updateContentFile\u0026lt;/code\u0026gt; to \u0026lt;code\u0026gt;true\u0026lt;/code\u0026gt; and upload the file using URL in \u0026lt;code\u0026gt;payloadURL.url\u0026lt;/code\u0026gt; in response body.\n\n\u0026lt;code\u0026gt;shareCode\u0026lt;/code\u0026gt; format should follows:\n\nMax length: 7\nAvailable characters: abcdefhkpqrstuxyz\n\n\u0026lt;br\u0026gt;\u0026lt;p\u0026gt;\u0026lt;b\u0026gt;NOTE: Preview is Legacy Code, please use Screenshot for better solution to display preview of a content\u0026lt;/b\u0026gt;\u0026lt;/p\u0026gt;",
"operationId": "SingleAdminUpdateContentS3",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.AdminUpdateContentRequest"
}
},
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "content ID",
"in": "path",
"name": "contentId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Content updated at s3",
"schema": {
"$ref": "#/definitions/models.CreateContentResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772601\u003c/td\u003e\u003ctd\u003eMalformed request\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772607\u003c/td\u003e\u003ctd\u003eUnable to update ugc content: invalid shareCode format\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772604\u003c/td\u003e\u003ctd\u003eUser has been banned to update content\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772603\u003c/td\u003e\u003ctd\u003eContent not found\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"409": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772606\u003c/td\u003e\u003ctd\u003eShare code already used\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772602\u003c/td\u003e\u003ctd\u003eUnable to check user ban status/Unable to get updated ugc content\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772605\u003c/td\u003e\u003ctd\u003eUnable to save ugc content: failed generate upload URL\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update content to S3 bucket",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"772601": "Malformed request",
"772602": "Unable to check user ban status/Unable to get updated ugc content",
"772603": "Content not found",
"772604": "User has been banned to update content",
"772605": "Unable to save ugc content: failed generate upload URL",
"772606": "Share code already used",
"772607": "Unable to update ugc content: invalid shareCode format"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [UPDATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/search": {
"get": {
"consumes": [
"application/json"
],
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:*:CONTENT [READ]\u0026lt;/b\u0026gt;\n\nFor advance tag filtering supports \u0026amp; as AND operator and | as OR operator and parentheses () for priority. e.g: \n\n\u0026lt;code\u0026gt;tags=red\u0026lt;/code\u0026gt;\n\n\u0026lt;code\u0026gt;tags=red\u0026amp;animal\u0026lt;/code\u0026gt;\n\n\u0026lt;code\u0026gt;tags=red|animal\u0026lt;/code\u0026gt;\n\n\u0026lt;code\u0026gt;tags=red\u0026amp;animal|wild\u0026lt;/code\u0026gt;\n\n\u0026lt;code\u0026gt;tags=red\u0026amp;(animal|wild)\u0026lt;/code\u0026gt;\n\nThe precedence of logical operator is AND \u0026gt; OR, so if no parentheses, AND logical operator will be executed first.\n\nAllowed character for operand: alphanumeric, underscore \u0026lt;code\u0026gt;_\u0026lt;/code\u0026gt; and dash \u0026lt;code\u0026gt;-\u0026lt;/code\u0026gt;\n\nAllowed character for operator: \u0026lt;code\u0026gt;\u0026amp;\u0026lt;/code\u0026gt; \u0026lt;code\u0026gt;|\u0026lt;/code\u0026gt; \u0026lt;code\u0026gt;(\u0026lt;/code\u0026gt; \u0026lt;code\u0026gt;)\u0026lt;/code\u0026gt;\n\n\u0026lt;b\u0026gt;Please note that value of tags query param should be URL encoded\u0026lt;/b\u0026gt;",
"operationId": "AdminSearchChannelSpecificContent",
"parameters": [
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "creator name",
"in": "query",
"name": "creator",
"type": "string"
},
{
"description": "set to true to list only hidden contents, false to list only non-hidden contents",
"in": "query",
"name": "ishidden",
"type": "string"
},
{
"description": "filter only official contents (boolean)",
"in": "query",
"name": "isofficial",
"type": "string"
},
{
"default": 20,
"description": "number of content per page",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"description": "content name",
"in": "query",
"name": "name",
"type": "string"
},
{
"default": 0,
"description": "the offset number to retrieve",
"in": "query",
"name": "offset",
"type": "integer"
},
{
"description": "sorting order: asc, desc. default=desc",
"in": "query",
"name": "orderby",
"type": "string"
},
{
"description": "sorting criteria: name,download,like,date,updatedTime. default=date",
"in": "query",
"name": "sortby",
"type": "string"
},
{
"description": "content subtype",
"in": "query",
"name": "subtype",
"type": "string"
},
{
"collectionFormat": "csv",
"description": "content tag",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"type": "array"
},
{
"description": "content type",
"in": "query",
"name": "type",
"type": "string"
},
{
"description": "user ID",
"in": "query",
"name": "userId",
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Search contents specific to a channel",
"schema": {
"$ref": "#/definitions/models.PaginatedContentDownloadResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770800\u003c/td\u003e\u003ctd\u003einvalid paging parameter/max allowed number of tags is {maxTags}/invalid official parameter/invalid ishidden parameter\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770801\u003c/td\u003e\u003ctd\u003eUnable to get ugc content: database/Unable to get creator\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e770803\u003c/td\u003e\u003ctd\u003eFailed generate download URL\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Search contents specific to a channel",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"770800": "invalid paging parameter/max allowed number of tags is {maxTags}/invalid official parameter/invalid ishidden parameter",
"770801": "Unable to get ugc content: database/Unable to get creator",
"770803": "Failed generate download URL"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:*:CONTENT [READ]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/channels/{channelId}/contents/{contentId}": {
"delete": {
"consumes": [
"application/json"
],
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [DELETE]\u0026lt;/b\u0026gt;.",
"operationId": "SingleAdminDeleteContent",
"parameters": [
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "content ID",
"in": "path",
"name": "contentId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "Content deleted"
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772702\u003c/td\u003e\u003ctd\u003eContent not found\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772701\u003c/td\u003e\u003ctd\u003eUnable to delete content/Unable to update user liked count/Unable to delete like state/Unable to delete like state\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete content",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"772701": "Unable to delete content/Unable to update user liked count/Unable to delete like state/Unable to delete like state",
"772702": "Content not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [DELETE]"
]
}
]
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "Required permission \u0026lt;b\u0026gt;ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [UPDATE]\u0026lt;/b\u0026gt;.\\n \n\t\t\t\t\tAll request body are required except preview, tags and customAttributes.\n\t\t\t\t\t",
"operationId": "SingleAdminUpdateContentDirect",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.CreateContentRequest"
}
},
{
"description": "channel ID",
"in": "path",
"name": "channelId",
"required": true,
"type": "string"
},
{
"description": "content ID",
"in": "path",
"name": "contentId",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Content updated",
"schema": {
"$ref": "#/definitions/models.CreateContentResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772601\u003c/td\u003e\u003ctd\u003eMalformed request\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20001\u003c/td\u003e\u003ctd\u003eunauthorized access\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772604\u003c/td\u003e\u003ctd\u003eUser has been banned to update content\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772603\u003c/td\u003e\u003ctd\u003eContent not found\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e772602\u003c/td\u003e\u003ctd\u003eUnable to check user ban status/Unable to get updated ugc content\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update content to a channel",
"tags": [
"Admin Content"
],
"x-errorCodes": {
"20001": "unauthorized access",
"772601": "Malformed request",
"772602": "Unable to check user ban status/Unable to get updated ugc content",
"772603": "Content not found",
"772604": "User has been banned to update content"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:USER:{userId}:CONTENT [UPDATE]"
]
}
]
}
},
"/ugc/v1/admin/namespaces/{namespace}/contents": {
"get": {
"consumes": [