-
Notifications
You must be signed in to change notification settings - Fork 0
/
challenge.json
4963 lines (4963 loc) · 176 KB
/
challenge.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": {
"description": "Justice Challenge Service",
"title": "justice-challenge-service",
"version": "1.0.0"
},
"schemes": [
"https"
],
"externalDocs": {
"description": "API Docs",
"url": "https://stage.accelbyte.io/challenge/apidocs"
},
"securityDefinitions": {
"authorization": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
},
"swagger": "2.0",
"paths": {
"/challenge/v1/admin/namespaces/{namespace}/challenges": {
"get": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]",
"operationId": "adminGetChallenges",
"parameters": [
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"description": "limit the amount of data retrieved",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"default": 0,
"description": "offset",
"in": "query",
"name": "offset",
"type": "integer"
},
{
"description": "sort list by attributes.\n\t\t\tdefault value: updatedAt:desc.",
"enum": [
"createdAt",
"createdAt:asc",
"createdAt:desc",
"updatedAt",
"updatedAt:asc",
"updatedAt:desc"
],
"in": "query",
"name": "sortBy",
"type": "string"
},
{
"description": "challenge status",
"enum": [
"INIT",
"RETIRED",
"TIED"
],
"in": "query",
"name": "status",
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.ListChallengeResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List Challenges",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]"
]
}
]
},
"post": {
"consumes": [
"application/json"
],
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [CREATE]\nChallenge is a collection of goals that can be completed by players. Challenge can have rules that specify what and when goals will be available for players to be taken.\n#### Request body:\n- code: only lowercase letters, numbers, and the separator - are allowed; must start and end with letter\n- name: name of the challenge\n- description: text describing about the challenge (optional)\n- startDate: timestamp of when the challenge is started\n- endDate: timestamp of when the challenge is ended (optional)\n- endAfter: describe number of period challenge will be retired after (optional). To configure challenge that never end, leave the endDate and endAfter field null/empty.\n- repeatAfter: describe number of period challenge\u0026#39;s goals will be repeated after. Leave it empty if you don\u0026#39;t want to repeat the challenge.\n- rotation: describe how long goals in a challenge will be available for players to progress before rotated with another goals. (DAILY|WEEKLY|MONTHLY|NONE)\n- activeGoalsPerRotation: number of goals per rotation (currently only applicable for RANDOMIZE assignment)\n- assignmentRule: describe how the goals will be assigned and scheduled to users. (FIXED|RANDOMIZED|UNSCHEDULED|CUSTOM)\n- goalsVisibility: describe whether users can see all goals under challenge, or only active goal in one rotation period only. (SHOWALL|PERIODONLY)\n- resetConfig: describe when rotation reset will happen (optional).\n\t- resetTime: Reset time must follow hours:minutes in 24 hours format (e.g. 01:30, 23:15) and in UTC timezone. Default to \u0026#34;00:00\u0026#34;\n\t- resetDay: Reset Day follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). Default to 1 in WEEKLY rotation.\n\t- resetDate: Reset Date must be a number 1 - 31. Default to 1 in MONTHLY rotation.\n- randomizedPerRotation:\n\t- true: each goal will be randomly assigned to multiple periods\n\t- false: a goal will only be assigned to one period",
"operationId": "adminCreateChallenge",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.CreateChallengeRequest"
}
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/model.ChallengeResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"409": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e99002\u003c/td\u003e\u003ctd\u003eduplicate key error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"422": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e99003\u003c/td\u003e\u003ctd\u003echallenge validation error: {{message}}\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\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create New Challenge",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission",
"20018": "bad request: {{message}}",
"99002": "duplicate key error: {{message}}",
"99003": "challenge validation error: {{message}}"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [CREATE]"
]
}
]
}
},
"/challenge/v1/admin/namespaces/{namespace}/challenges/users/{userId}": {
"get": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]\nThe endpoint provides you an access to list of currently active challenges in which the player is participating\n",
"operationId": "adminGetActiveChallenges",
"parameters": [
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user id",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"default": 20,
"description": "limit the amount of data retrieved",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"default": 0,
"description": "offset",
"in": "query",
"name": "offset",
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.ListChallengeResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List User's Active Challenges",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]"
]
}
]
}
},
"/challenge/v1/admin/namespaces/{namespace}/challenges/{challengeCode}": {
"delete": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [DELETE]",
"operationId": "adminDeleteChallenge",
"parameters": [
{
"description": "the code of the challenge data to be deleted",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\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\u003e20013\u003c/td\u003e\u003ctd\u003einsufficient permission\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\u003e20029\u003c/td\u003e\u003ctd\u003enot 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\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete a Challenge",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission",
"20018": "bad request: {{message}}",
"20029": "not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [DELETE]"
]
}
]
},
"get": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]",
"operationId": "adminGetChallenge",
"parameters": [
{
"description": "the code of the challenge data to get",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.ChallengeResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20029\u003c/td\u003e\u003ctd\u003enot 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\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get a Challenge",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission",
"20029": "not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]"
]
}
]
},
"put": {
"consumes": [
"application/json"
],
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [UPDATE]\nRequest body:\n- name: name of the challenge\n- description: text describing about the challenge (optional)\n- startDate: timestamp of when the challenge is started\n- endDate: timestamp of when the challenge is ended (optional)\n- endAfter: describe number of period challenge will be retired after (optional). To configure challenge that never end, leave the endDate and endAfter field null/empty.\n- repeatAfter: describe number of period challenge\u0026#39;s goals will be repeated after. Leave it empty if you don\u0026#39;t want to repeat the challenge.\n- rotation: describe how long goals in a challenge will be available for players to progress before rotated with another goals. (DAILY|WEEKLY|MONTHLY|NONE)\n- activeGoalsPerRotation: number of goals per rotation (currently only applicable for RANDOMIZE assignment)\n- assignmentRule: describe how the goals will be assigned and scheduled to users. (FIXED|RANDOMIZED|UNSCHEDULED|CUSTOM)\n- goalsVisibility: describe whether users can see all goals under challenge, or only active goal in one rotation period only. (SHOWALL|PERIODONLY)\n- resetConfig: describe when rotation reset will happen (optional).\n\t- resetTime: Reset time must follow hours:minutes in 24 hours format (e.g. 01:30, 23:15) and in UTC timezone. Default to \u0026#34;00:00\u0026#34;\n\t- resetDay: Reset Day follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). Default to 1 in WEEKLY rotation.\n\t- resetDate: Reset Date must be a number 1 - 31. Default to 1 in MONTHLY rotation.\n- randomizedPerRotation:\n\t- true: each goal will be randomly assigned to multiple periods\n\t- false: a goal will only be assigned to one period",
"operationId": "adminUpdateChallenge",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.UpdateChallengeRequest"
}
},
{
"description": "the code of the challenge data to update",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.ChallengeResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"422": {
"description": "Unprocessable Entity",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update a Challenge",
"tags": [
"Challenge Configuration"
],
"x-errorCodes": {
"20018": "bad request: {{message}}"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [UPDATE]"
]
}
]
}
},
"/challenge/v1/admin/namespaces/{namespace}/challenges/{challengeCode}/goals": {
"get": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]",
"operationId": "adminGetGoals",
"parameters": [
{
"description": "challenge code",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"description": "limit the amount of data retrieved",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"default": 0,
"description": "offset",
"in": "query",
"name": "offset",
"type": "integer"
},
{
"description": "sort list by attributes.\n\t\t\tdefault value: updatedAt:desc.",
"enum": [
"createdAt",
"createdAt:asc",
"createdAt:desc",
"updatedAt",
"updatedAt:asc",
"updatedAt:desc"
],
"in": "query",
"name": "sortBy",
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.GetGoalsResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20029\u003c/td\u003e\u003ctd\u003enot 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\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List Goals of a Challenge",
"tags": [
"Goal Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission",
"20029": "not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]"
]
}
]
},
"post": {
"consumes": [
"application/json"
],
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [CREATE]\nRequest body:\n- code: unique within a challenge.\n- name: name of the goal.\n- description: text describing the goal (optional).\n- schedule: a time range that indicated the availability of a goal within a timeframe. Used in FIXED assignment rule, this will be required in that case.\n- requirementGroups: contains array of objects consisting of operator and predicates attribute. When requirements evaluation happened, each item\u0026#39;s predicates will be evaluated first, by operating the predicates with given operator.\n\tAfter all items evaluated, the results of the evaluation on each item then will be logically evaluated using OR operator.\n\t- operator: logical operator used to validate the completion of a goal. a goal is considered complete once complete predicates operated with operator result in true.\n\t- predicates: list of progression parameters to be tracked.\n\t\t- parameterType: the type of parameter for challenge to be progressed with. the available options are:\n\t\t\t- STATISTIC: progress by user statistic item value.\n\t\t\t- STATISTIC_CYCLE: progress user statistic cycle item value. statCycleId must be included.\n\t\t\t- ACHIEVEMENT: progress by user achievement.\n\t\t\t- USERACCOUNT: progress by user account event.\n\t\t\t- ENTITLEMENT: progress by user\u0026#39;s item entitlement ownership. Supported item types are APP, CODE, INGAMEITEM, LOOTBOX, MEDIA, and OPTIONBOX.\n\t\t- parameterName: the name of the parameter for challenge to be progressed with.\n\t\t\t- STATISTIC: refers to stat code.\n\t\t\t- STATISTIC_CYCLE: refers to stat code with statCycleId must be included.\n\t\t\t- ACHIEVEMENT: refers to achievement code.\n\t\t\t- USERACCOUNT: refers to a specific event related to user accounts. The current possible events include: userAccountCreated, gameUserAccountCreated, userAccountVerified, userAccountLinked, userAccountUpgraded, thirdPartyAccountCreated, userLoggedIn, userThirdPartyLoggedIn and fullAccount.\n\t\t\t\t- For the **userAccountLinked** event, **parameterName** will utilize **platformId** rather than the event name. This will be validated against the list of active third-party accounts configuration within the namespace, such as *psn*, *steam*, or *device*.\n\t\t\t- ENTITLEMENT: ecommerce store\u0026#39;s item SKU.\n\t\t- matcher: the comparison operator used to compare the current value of a parameter and targetValue to validate the completion of a predicate. Possible values are EQUAL, LESS_THAN, GREATER_THAN, LESS_THAN_EQUAL, and GREATER_THAN_EQUAL.\n\t\t- targetValue: the target number to be reached by the parameter.\n\t\t- statCycleId: specify the statCycleId used to track statistic value in a cycle with STATISTIC_CYCLE parameterType (optional).\n- rewards: list of rewards that will be claimable once a goal is complete.\n- tag: goal\u0026#39;s labels.\n- isActive: when goal is in a schedule, isActive determine whether goal is active to progress or not.\nGoal describe set of requirements that need to be fulfilled by players in order to complete it and describe what is the rewards given to player when they complete the goal.\nThe requirement will have target value and a operator that will evaluate that against an observable player’s attribute (e.g. statistic, entitlement). Goal belongs to a challenge.\nSupported item type for ENTITLEMENT reward type: APP, BUNDLE, CODE, COINS, EXTENSION, INGAMEITEM, LOOTBOX, MEDIA, OPTIONBOX.\nNumber of goals per challenge is **limited to 100 goals**.",
"operationId": "adminCreateGoal",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.CreateGoalRequest"
}
},
{
"description": "challenge code",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/model.GoalResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/iam.ErrorResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"404": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20029\u003c/td\u003e\u003ctd\u003enot 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\u003e99002\u003c/td\u003e\u003ctd\u003eduplicate key error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"422": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e99004\u003c/td\u003e\u003ctd\u003eunprocessable entity: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/iam.ErrorResponse"
}
},
"500": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create New Goal",
"tags": [
"Goal Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20001": "unauthorized access",
"20013": "insufficient permission",
"20018": "bad request: {{message}}",
"20029": "not found",
"99002": "duplicate key error: {{message}}",
"99004": "unprocessable entity: {{message}}"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [CREATE]"
]
}
]
}
},
"/challenge/v1/admin/namespaces/{namespace}/challenges/{challengeCode}/goals/{code}": {
"delete": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [DELETE]",
"operationId": "adminDeleteGoal",
"parameters": [
{
"description": "challenge code",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "goal code",
"in": "path",
"name": "code",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\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\u003e20029\u003c/td\u003e\u003ctd\u003enot 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\u003e20000\u003c/td\u003e\u003ctd\u003einternal server error: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete Goal",
"tags": [
"Goal Configuration"
],
"x-errorCodes": {
"20000": "internal server error: {{message}}",
"20018": "bad request: {{message}}",
"20029": "not found"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [DELETE]"
]
}
]
},
"get": {
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]",
"operationId": "adminGetGoal",
"parameters": [
{
"description": "challenge code",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "goal code",
"in": "path",
"name": "code",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.GoalResponse"
}
},
"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/iam.ErrorResponse"
}
},
"403": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\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/iam.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/response.Error"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get Goal",
"tags": [
"Goal Configuration"
],
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission"
},
"x-security": [
{
"userPermissions": [
"ADMIN:NAMESPACE:{namespace}:CHALLENGE [READ]"
]
}
]
},
"put": {
"consumes": [
"application/json"
],
"description": "- Required permission: ADMIN:NAMESPACE:{namespace}:CHALLENGE [UPDATE]\n### Request body:\n- name: name of the goal.\n- description: text describing the goal (optional).\n- schedule: a time range that indicated the availability of a goal within a timeframe. Used in FIXED assignment rule, this will be required in that case.\n- requirementGroups: contains array of objects consisting of operator and predicates attribute. When requirements evaluation happened, each item\u0026#39;s predicates will be evaluated first, by operating the predicates with given operator. After all items evaluated, the results of the evaluation on each item then will be logically evaluated using OR operator.\n\t- operator: logical operator used to validate the completion of a goal. a goal is considered complete once complete predicates operated with operator result in true.\n\t- predicates: list of progression parameters to be tracked.\n\t\t- parameterType: the type of parameter for challenge to be progressed with. the available options are:\n\t\t\t- STATISTIC: progress by user statistic item value.\n\t\t\t- STATISTIC_CYCLE: progress user statistic cycle item value. statCycleId must be included.\n\t\t\t- ACHIEVEMENT: progress by user achievement.\n\t\t\t- USERACCOUNT: progress by user account event.\n\t\t\t- ENTITLEMENT: progress by user\u0026#39;s item entitlement ownership. Supported item types are APP, CODE, INGAMEITEM, LOOTBOX, MEDIA, and OPTIONBOX.\n\t\t- parameterName: the name of the parameter for challenge to be progressed with.\n\t\t\t- STATISTIC: refers to stat code.\n\t\t\t- STATISTIC_CYCLE: refers to stat code with statCycleId must be included.\n\t\t\t- ACHIEVEMENT: refers to achievement code.\n\t\t\t- USERACCOUNT: one of the user account event. Current possible values are (userAccountCreated, gameUserAccountCreated, userAccountVerified, userAccountLinked, userAccountUpgraded,thirdPartyAccountCreated).\n\t\t\t- ENTITLEMENT: ecommerce store\u0026#39;s item SKU.\n\t- matcher: the comparison operator used to compare the curent value of a parameter and targetValue to validate the completion of a predicate. Possible values are EQUAL, LESS_THAN, GREATER_THAN, LESS_THAN_EQUAL, and GREATER_THAN_EQUAL.\n\t- targetValue: the target number to be reached by the parameter.\n\t- statCycleId: specify the statCycleId used to track statistic value in a cycle with STATISTIC_CYCLE parameterType (optional).\n- rewards: list of rewards that will be claimable once a goal is complete.\n- tag: goal\u0026#39;s labels.\n- isActive: when goal is in a schedule, isActive determine whether goal is active to progress or not (optional).\nGoal describe set of requirements that need to be fulfilled by players in order to complete it and describe what is the rewards given to player when they complete the goal.\nThe requirement will have target value and a operator that will evaluate that against an observable player’s attribute (e.g. statistic, entitlement). Goal belongs to a challenge.\nSupported item type for ENTITLEMENT reward type: APP, BUNDLE, CODE, COINS, EXTENSION, INGAMEITEM, LOOTBOX, MEDIA, OPTIONBOX",
"operationId": "adminUpdateGoals",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/model.UpdateGoalRequest"
}
},
{
"description": "challenge code",
"in": "path",
"name": "challengeCode",
"required": true,
"type": "string"
},
{
"description": "goal code",
"in": "path",
"name": "code",
"required": true,
"type": "string"
},
{
"description": "namespace of the game",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/model.GoalResponse"
}
},
"400": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e20018\u003c/td\u003e\u003ctd\u003ebad request: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/response.Error"
}
},
"422": {
"description": "\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eerrorCode\u003c/td\u003e\u003ctd\u003eerrorMessage\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e99004\u003c/td\u003e\u003ctd\u003eunprocessable entity: {{message}}\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e",
"schema": {