-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi-3.0.yaml
5233 lines (5206 loc) · 151 KB
/
openapi-3.0.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
x-stoplight:
id: ezdjxlif28ceb
info:
title: dofusdude
version: 1.0.0-rc.8
description: "# Open Ankama Developer Community\nThe all-in-one toolbelt for your next Ankama related project.\n\n## Versions\n- [Dofus 2](https://docs.dofusdu.de/dofus2/)\n- [Dofus 3](https://docs.dofusdu.de/dofus3/)\n - v1 [latest] (you are here) \n\n## Client SDKs\n- [Javascript](https://github.com/dofusdude/dofusdude-js) `npm i dofusdude-js --save`\n- [Typescript](https://github.com/dofusdude/dofusdude-ts) `npm i dofusdude-ts --save`\n- [Go](https://github.com/dofusdude/dodugo) `go get -u github.com/dofusdude/dodugo`\n- [Python](https://github.com/dofusdude/dofusdude-py) `pip install dofusdude`\n- [Java](https://github.com/dofusdude/dofusdude-java) Maven with GitHub packages setup\n\nEverything, including this site, is generated out of the [Docs Repo](https://github.com/dofusdude/api-docs). Consider it the Single Source of Truth. If there is a problem with the SDKs, create an issue there.\n\nYour favorite language is missing? Please let me know!\n\n# Main Features\n- \U0001F977 **Seamless Auto-Update** load data in the background when a new Dofus version is released and serving it within 10 minutes with atomic data source switching. No downtime and no effects for the user, just always up-to-date.\n\n- ⚡ **Blazingly Fast** all data in-memory, aggressive caching over short time spans, HTTP/2 multiplexing, written in Go, optimized for low latency, hosted on bare metal in \U0001F1E9\U0001F1EA.\n\n- \U0001F4E8 **Almanax Discord Integration** Use the endpoints as a dev or the official [Web Client](https://discord.dofusdude.com) as a user.\n\n- \U0001FA78 **Dofus 3 Beta** from stable to bleeding edge by replacing /dofus3 with /dofus3beta.\n\n- \U0001F5E3️ **Multilingual** supporting _en_, _fr_, _es_, _pt_, _de_.\n\n- \U0001F9E0 **Search by Relevance** allowing typos in name and description, handled by language specific text analysis and indexing.\n\n- \U0001F575️ **Official Sources** generated from actual data from the game.\n\n... and much more on the Roadmap on my [Discord](https://discord.gg/3EtHskZD8h).\n"
contact:
name: Survival
url: "https://discord.gg/3EtHskZD8h"
email: stelzo@steado.de
license:
name: GPL-3.0
url: "https://github.com/dofusdude/doduapi/blob/main/LICENSE"
servers:
- url: "https://api.dofusdu.de"
description: API
paths:
"/{game}/v1/{language}/items/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
example: fr
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search All Items
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItemGeneral"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
headers: {}
operationId: get-items-all-search
description: Search in all names and descriptions of Dofus items (including all subtypes) with a query.
parameters:
- schema:
type: string
example: atcham
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
format: int32
example: 190
maximum: 200
minimum: 0
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
example: 200
maximum: 200
format: int32
minimum: 0
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
minimum: 1
maximum: 100
example: 8
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
items:
type: string
example:
- boots
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
tags:
- game
x-stoplight:
id: eeoi1h7wagrmw
"/{game}/v1/{language}/mounts/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
example: fr
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Mounts
tags:
- mounts
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Mount"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-mounts-search
description: Search in all names and descriptions of mounts with a query.
parameters:
- schema:
type: string
example: Dorée
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: string
example: Dragodinde
in: query
name: "filter[family.name]"
description: only results with the translated family name
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: integer
in: query
name: "filter[family.id]"
description: only results with the unique family id
x-stoplight:
id: 55fkjddmfhh7n
"/{game}/v1/{language}/sets/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Sets
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListEquipmentSet"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-sets-search
description: Search in all names and descriptions of sets with a query.
parameters:
- schema:
type: string
example: Des
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
minimum: 1
maximum: 200
format: int32
example: 195
in: query
name: "filter[min_highest_equipment_level]"
description: only results where the equipment with the highest level is above or equal to this value
- schema:
type: integer
minimum: 1
maximum: 200
format: int32
example: 200
in: query
name: "filter[max_highest_equipment_level]"
description: only results where the equipment with the highest level is below or equal to this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: boolean
in: query
name: "filter[contains_cosmetics_only]"
description: "filter sets based on if they only got cosmetic items in it. If true, the item ids are for the cosmetic endpoints instead of equipment."
- schema:
type: boolean
in: query
name: "filter[contains_cosmetics]"
description: filter sets based on if they got any cosmetic items in it
tags:
- sets
x-stoplight:
id: 7pwfbuzuxnnuq
"/{game}/v1/{language}/items/quest/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
example: es
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Quest Items
tags:
- quest items
responses:
"200":
description: Quest Items Found
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItem"
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-items-quest-search
description: Search in all names and descriptions of quest items with a query.
parameters:
- schema:
type: string
example: Ficha
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
example: 60
minimum: 0
maximum: 200
format: int32
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
format: int32
minimum: 0
maximum: 200
example: 70
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
description: maximum number of returned results
name: limit
- schema:
type: array
items:
type: string
example:
- vigilantes
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
x-stoplight:
id: e7dmshthuyg5m
"/{game}/v1/{language}/items/consumables/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Consumables
responses:
"200":
description: Consumables Found
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItem"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-items-consumables-search
description: Search in all names and descriptions of consumable items with a query.
parameters:
- schema:
type: string
example: Wholewrite
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
format: int32
maximum: 200
example: 1
minimum: 1
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
format: int32
maximum: 200
minimum: 1
example: 200
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
items:
type: string
example:
- bread
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
tags:
- consumables
x-stoplight:
id: 6ogh4aj4k3vns
"/{game}/v1/{language}/items/resources/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Resources
tags:
- resources
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItem"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-items-resource-search
description: Search in all names and descriptions of resource items with a query.
parameters:
- schema:
type: string
example: snowdew
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
format: int32
minimum: 1
maximum: 200
example: 150
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
format: int32
minimum: 1
maximum: 200
example: 200
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
items:
type: string
example:
- plant
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
x-stoplight:
id: l2f1uw9hdicac
"/{game}/v1/{language}/search":
get:
summary: Game Search
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
x-examples:
Example 1:
- name: Paztek Sandals
ankama_id: 20463
type: items-equipment
- name: Paztek Mask
ankama_id: 20465
type: items-equipment
- name: Paztek Cloak
ankama_id: 20464
type: items-equipment
items:
$ref: "#/components/schemas/GameSearch"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-game-search
description: Search in all names and descriptions of all supported types in the game. For the list of supported types see the endpoint /dofus3/meta/search/types.
parameters:
- schema:
type: string
example: paztek
in: query
name: query
description: search query
required: true
- schema:
type: array
uniqueItems: true
example:
- items-equipment
items:
type: string
enum:
- items-consumables
- items-cosmetics
- items-resources
- items-equipment
- items-quest_items
- mounts
- sets
in: query
name: "filter[search_index]"
description: only results with all specific type
explode: false
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
uniqueItems: true
example:
- level
items:
type: string
enum:
- level
- image_urls
- type
explode: false
in: query
name: "fields[item]"
description: adds fields from the item search to the list entries if the hit is an item. Multiple comma separated values allowed.
- schema:
type: array
items:
type: string
example:
- boots
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: 'multi-filter results with the english item type name, including "mount" and "set" from filter[search_index]. Add with "wood" or "+wood" and exclude with "-wood".'
explode: false
tags:
- game
x-stoplight:
id: zxx3tt0z25gz8
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
"/{game}/v1/{language}/items/equipment/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Equipment
tags:
- equipment
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItem"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-items-equipment-search
description: Search in all names and descriptions of equipment items with a query.
parameters:
- schema:
type: string
example: nidas
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
format: int32
minimum: 1
maximum: 200
example: 150
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
format: int32
example: 200
minimum: 1
maximum: 200
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
items:
type: string
example:
- boots
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
x-stoplight:
id: 4lzcb55gkjj2z
"/{game}/v1/{language}/items/cosmetics/search":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Search Cosmetics
tags:
- cosmetics
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ListItem"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
operationId: get-cosmetics-search
description: Search in all names and descriptions of cosmetic items with a query.
parameters:
- schema:
type: string
example: nedora
in: query
name: query
description: case sensitive search query
required: true
- schema:
type: integer
format: int32
minimum: 1
maximum: 200
example: 1
in: query
name: "filter[min_level]"
description: only results which level is equal or above this value
- schema:
type: integer
format: int32
minimum: 1
maximum: 200
example: 2
in: query
name: "filter[max_level]"
description: only results which level is equal or below this value
- schema:
type: integer
default: 8
example: 8
minimum: 1
maximum: 100
in: query
name: limit
description: maximum number of returned results
- schema:
type: array
items:
type: string
example:
- wings
uniqueItems: true
in: query
name: "filter[type.name_id]"
description: multi-filter results with the english type name. Add with "wood" or "+wood" and exclude with "-wood".
explode: false
x-stoplight:
id: mw8gyg65z17wf
"/{game}/v1/{language}/items/cosmetics/{ankama_id}":
parameters:
- schema:
type: string
enum:
- en
- fr
- de
- es
- pt
maxLength: 2
minLength: 2
name: language
in: path
required: true
description: a valid language code
- schema:
type: integer
example: 24132
name: ankama_id
in: path
required: true
description: identifier
- schema:
type: string
enum:
- dofus3
- dofus3beta
example: dofus3
name: game
in: path
required: true
description: game main 'dofus3' or beta channel 'dofus3beta'
get:
summary: Single Cosmetics
tags:
- cosmetics
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Equipment"
examples: {}
"400":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: ""