-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathDTC-API-v1.0.0.yaml
887 lines (887 loc) · 23 KB
/
DTC-API-v1.0.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
openapi: 3.0.3
info:
title: DeckTechCentral - OpenAPI 3.0
description: |-
This is an api for the management, creation, and viewing of decks for the service known as
DeckTechCentral
contact: {}
version: 1.0.11
externalDocs:
description: Development Progress of DeckTechCentral
url: https://paulshriner.github.io/
servers:
- url: http://localhost/5272
tags:
- name: deck
description: Information of decks
- name: user
description: User information
- name: card
description: card information
externalDocs:
description: card information gain from
url: https://scryfall.com/
paths:
/user:
post:
tags:
- user
summary: Create user
description: This can only be done by the logged in user.
operationId: createUser
requestBody:
description: Created user object
content:
application/json:
schema:
$ref: '#/components/schemas/User'
application/xml:
schema:
$ref: '#/components/schemas/User'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/User'
responses:
default:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/User'
application/xml:
schema:
$ref: '#/components/schemas/User'
/user/login:
get:
tags:
- user
summary: Logs user into the system
description: ''
operationId: loginUser
parameters:
- name: username
in: query
description: The user name for login
required: false
schema:
type: string
- name: password
in: query
description: The password for login in clear text
required: false
schema:
type: string
responses:
'200':
description: successful operation
headers:
X-Rate-Limit:
description: calls per hour allowed by the user
schema:
type: integer
format: int32
X-Expires-After:
description: date in UTC when token expires
schema:
type: string
format: date-time
content:
application/xml:
schema:
type: string
application/json:
schema:
type: string
'400':
description: Invalid username/password supplied
/user/logout:
get:
tags:
- user
summary: Logs out current logged in user session
description: ''
operationId: logoutUser
parameters: []
responses:
default:
description: successful operation
/user/{username}:
get:
tags:
- user
summary: Get user by user name
description: ''
operationId: getUserByName
parameters:
- name: username
in: path
description: 'The name that needs to be fetched. Use user1 for testing. '
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/User'
application/xml:
schema:
$ref: '#/components/schemas/User'
'400':
description: Invalid username supplied
'404':
description: User not found
put:
tags:
- user
summary: Update user
description: This can only be done by the logged in user.
operationId: updateUser
parameters:
- name: username
in: path
description: name that need to be deleted
required: true
schema:
type: string
requestBody:
description: Update an existent user in the store
content:
application/json:
schema:
$ref: '#/components/schemas/User'
application/xml:
schema:
$ref: '#/components/schemas/User'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/User'
responses:
default:
description: successful operation
delete:
tags:
- user
summary: Delete user
description: This can only be done by the logged in user.
operationId: deleteUser
parameters:
- name: username
in: path
description: The name that needs to be deleted
required: true
schema:
type: string
responses:
'400':
description: Invalid username supplied
'404':
description: User not found
/deck:
tags:
- deck
post:
parameters:
- name: deck
in: requestBody
description: the deck creation request for the created deck
required: true
schemas:
$ref: '#/components/schemas/DeckCreationRequest'
responses:
'200':
description: deck was created
security:
- deckmanagement_auth:
/deck/{deckId}:
parameters:
- name: deckId
in: path
description: a guid of the deck that is wanted
required: true
- write:dekcs
schema:
type: string
get:
tags:
- deck
summary: Get the specified deck
responses:
'200':
description: deck was found
content:
application/json:
schema:
$ref: '#/components/schemas/Deck'
'400':
description: Invalid deckId supplied
'404':
description: Deck not found
security:
- deckmanagement_auth:
- read:decks
put:
tags:
- deck
summary: Update a specified deck
requestBody:
description: Deck object to update using
content:
application/json:
schema:
$ref: '#/components/schemas/Deck'
responses:
default:
description: deck successfully updated
'401':
description: Unauthorized
delete:
tags:
- deck
summary: Get the specified deck
responses:
'200':
description: deck was deleted
'400':
description: Invalid deckId supplied
'401':
description: Aunauthorized
'404':
description: Deck not found
/deck/users/{userName}:
parameters:
- name: userId
in: path
description: the id of the user to see the decks
required: true
schema:
type: string
get:
tags:
- deck
summary: Get all visible decks from the user
responses:
'200':
description: decks were found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DeckSearchResponse'
/deck/search:
parameters:
- name: name
in: query
description: A fuzzy search based on the name of the deck
required: false
schema:
type: string
- name: format
in: query
description: the format the deck should be in
required: false
schema:
type: string
- name: commander_1
in: query
description: the commander of a deck list
required: false
schema:
type: string
- name: commander_2
in: query
description: second commander of the deck
required: false
schema:
type: string
- name: sortBy
in: query
description: how to sort the decks uses name by default, can be sorted by name, likes, views, and creators
required: false
schema:
type: string
get:
tags:
- deck
summary: Search for deck
responses:
'200':
description: decks were found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DeckSearchResponse'
/deck/like/{deckId}:
parameters:
- name: deckId
in: path
description: a guid of the deck that is wanted
required: true
schema:
type: string
patch:
tags:
- deck
summary: likes or removes like from a deck
responses:
'200':
description: deck was liked/disliked
'404':
description: deck not found
/deck/like/{deckId}/{userId}:
parameters:
- name: deckId
in: path
description: a guid of the deck that is wanted
required: true
schema:
type: string
- name: userId
in: path
description: a guid of the user
required: true
schema:
type: string
get:
tags:
- deck
summary: returns if a user likes a given deck
responses:
'200':
description: deck and user found
content:
application/json:
schema:
type: boolean
'404':
description: either deck does not exist
/card/{cardId}:
parameters:
- name: cardId
in: path
description: a guid of the card that is wanted
required: true
schema:
type: string
get:
tags:
- card
summary: Get the specified card
responses:
'200':
description: card was found
content:
application/json:
schema:
$ref: '#/components/schemas/Card'
'400':
description: Invalid cardId supplied
'404':
description: Card not found
/card/bulk:
parameters:
- name: cardArray
in: requestBody
description: an array of guids for cards that are wanted
required: true
schema:
type: array
items:
type: string
post:
tags:
- card
summary: Get a list of cards
responses:
'200':
description: cards were found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Card'
/card/search:
parameters:
- name: q
in: query
description: a full text query using percent encododing using scryfall syntax see https://scryfall.com/docs/syntax for more details
required: true
schema:
type: string
maxLength: 1000
- name: page
in: query
description: the page number for cards to display assumed to be first page if not given
required: false
schema:
type: number
minimum: 0
- name: pageSize
in: query
description: the maximum number of cards to display per page
required: false
schema:
type: number
minimum: 1
get:
tags:
- card
summary: search for cards
responses:
'200':
description: cards found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Card'
components:
schemas:
User:
type: object
required:
- id
- username
- email
- userStatus
properties:
id:
type: string
username:
type: string
example: theUser
email:
type: string
example: [email protected]
userStatus:
type: string
description: User Status
example: 'moderator'
DeckSearchResponse:
type: object
required:
- id
- name
- likes
- dislikes
- views
- editors
- created_date
- modified_date
properties:
id:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
name:
type: string
example: 'My Deck!'
cover_image:
type: string
format: url
example: 'https://cards.scryfall.io/art_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
likes:
type: number
minimum: 0
dislikes:
type: number
minimum: 0
views:
type: number
minimum: 0
format:
type: string
example: 'standard'
editors:
type: array
items:
type: string
example: '1103efb6-b3db-409b-951f-896efa60f59e'
created_date:
type: date-time
modified_date:
type: date-time
Deck:
type: object
required:
- id
- name
- mainbaord
- sideboard
- considering
- likes
- dislikes
- views
- cover_image
- editors
- created_date
- modified_date
properties:
id:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
editors:
type: array
items:
type: string
example: '1103efb6-b3db-409b-951f-896efa60f59e'
name:
type: string
example: 'My Deck!'
format:
type: string
example: 'standard'
mainboard:
type: array
items:
$ref: '#/components/schemas/CardDeckResponse'
sideboard:
type: array
items:
$ref: '#/components/schemas/CardDeckResponse'
considering:
type: array
items:
$ref: '#/components/schemas/CardDeckResponse'
likes:
type: number
minimum: 0
dislikes:
type: number
minimum: 0
views:
type: number
minimum: 0
description:
type: string
maxLength: 100000
cover_image:
type: string
format: url
example: 'https://cards.scryfall.io/art_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
commander_1:
type: string
commander_2:
type: string
created_date:
type: date-time
modified_date:
type: date-time
privacy:
type: string
example: 'public'
DeckCreationRequest:
type: object
required:
- id
- name
- mainbaord
- sideboard
- considering
- likes
- dislikes
- views
- cover_image
- editors
properties:
editors:
type: array
items:
type: string
example: '1103efb6-b3db-409b-951f-896efa60f59e'
name:
type: string
example: 'My Deck!'
format:
type: string
example: 'standard'
mainboard:
type: array
items:
schema:
type: string
format: guid
sideboard:
type: array
items:
schema:
type: string
format: guid
considering:
type: array
items:
schema:
type: string
format: guid
description:
type: string
maxLength: 100000
cover_image:
type: string
format: url
example: 'https://cards.scryfall.io/art_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
commander_1:
type: string
commander_2:
type: string
CardDeckResponse:
type: object
required:
- number
- Card
properties:
number:
type: number
minimum: 1
CardInfo:
$ref: '#/components/schemas/CardInfo'
CardInfo:
type: object
required:
- name
- id
- cmc
- type_line
- image_uris
properties:
name:
type: string
id:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
mana_cost:
type: string
format: mc
example: '{4}{W}{W}'
pattern: '(\d|[WUBRG])+'
cmc:
type: number
minimum: 0
type_line:
type: string
example: 'Sorcery'
image_uris:
type: array
items:
type: object
properties:
small:
type: string
format: url
example: 'https://cards.scryfall.io/small/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
normal:
type: string
format: url
example: 'https://cards.scryfall.io/normal/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
large:
type: string
format: url
example: 'https://cards.scryfall.io/large/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
png:
type: string
format: url
example: 'https://cards.scryfall.io/png/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.png?1706240553'
art_crop:
type: string
format: url
example: 'https://cards.scryfall.io/art_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
border_crop:
type: string
format: url
example: 'https://cards.scryfall.io/border_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
Card:
type: object
required:
- id
- oracle_id
- name
- uri
- cmc
- legalities
- artist
properties:
id:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
oracle_id:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
multiverse_ids:
type: array
items:
type: string
format: guid
example: '1103efb6-b3db-409b-951f-896efa60f59e'
tcgplayer_id:
type: number
minimum: 0
cardmarket_id:
type: number
minimum: 0
name:
type: string
example: 'Austere Command'
lang:
type: string
example: 'en'
release_at:
type: string
format: date
example: '2024-02-16'
uri:
type: string
format: url
example: 'https://api.scryfall.com/cards/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b'
scryfall_uri:
type: string
format: url
example: 'https://scryfall.com/card/mkc/56/austere-command?utm_source=api'
layout:
type: string
example: 'normal'
highres_image:
type: boolean
image_status:
type: string
example: 'high_res_scan'
image_uris:
type: array
items:
type: object
properties:
small:
type: string
format: url
example: 'https://cards.scryfall.io/small/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
normal:
type: string
format: url
example: 'https://cards.scryfall.io/normal/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
large:
type: string
format: url
example: 'https://cards.scryfall.io/large/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
png:
type: string
format: url
example: 'https://cards.scryfall.io/png/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.png?1706240553'
art_crop:
type: string
format: url
example: 'https://cards.scryfall.io/art_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
border_crop:
type: string
format: url
example: 'https://cards.scryfall.io/border_crop/front/a/3/a31ffc9e-d21b-4a8f-ac67-695e38e09e3b.jpg?1706240553'
mana_cost:
type: string
format: mc
example: '{4}{W}{W}'
pattern: '(\d|[WUBRG])+'
cmc:
type: number
minimum: 0
power:
type: number
toughness:
type: number
type_line:
type: string
example: 'Sorcery'
colors:
type: array
items:
type: string
example: 'B'
pattern: '[WUBRG]'
color_identity:
type: array
items:
type: string
example: 'B'
pattern: '[WUBRG]'
keywords:
type: array
items:
type: string
example: 'Treasure'
legalities:
type: array
items:
type: string
example: '"standard": "legal"'
pattern: '"\w+": "\w+"'
games:
type: array
items:
type: string
example: 'mtgo'
reserved:
type: boolean
foil:
type: boolean
nonfoil:
type: boolean
finishes:
type: array
items:
type: string
oversized:
type: boolean
promo:
type: boolean
reprint:
type: boolean
variation:
type: boolean
set_id:
type: string
format: guid
example: 'a944551a-73fa-41cd-9159-e8d0e4674403'
set:
type: string
example: 'vma'
pattern: '\w\w\w'
set_name:
type: string
example: "Vintage Masters"
set_type:
type: string
example: 'masters'
rarity:
type: string
example: 'common'
artist:
type: string
example: 'Chris Rahn'
securitySchemes:
deckmanagement_auth:
type: oauth2
flows:
implicit:
authorizationUrl: https://petstore3.swagger.io/oauth/authorize
scopes:
write:dekcs: modify decks in your account
read:decks: read your privated decks
usermanagement_auth:
type: oauth2
flows:
implicit:
authorizationUrl: temp
scopes:
manage:users: manage Users
api_key:
type: apiKey
name: api_key
in: header