-
Notifications
You must be signed in to change notification settings - Fork 5
/
deck-of-cards.yaml
461 lines (456 loc) · 13.6 KB
/
deck-of-cards.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
openapi: 3.0.0
info:
title: Deck of Cards API
version: 1.0.0
description:
The Deck of Cards API is a RESTful API that allows developers to interact with a virtual deck of playing cards.
Piles can be used for discarding, players hands, or whatever else. Piles are created on the fly, just give a pile a name and add a drawn card to the pile. If the pile didn't exist before, it does now. After a card has been drawn from the deck it can be moved from pile to pile.
Cards need to be drawn from a deck before they can be added to a pile.
The card codes are two character case-insensitive strings that represent a playing card. The first character represents the value of the card, one of A (for an ace), 2, 3, 4, 5, 6, 7, 8, 9, 0 (for a ten), J (jack), Q (queen), or K (king). The second character represents the suit of the card, one of S (Spades), D (Diamonds), C (Clubs), or H (Hearts).
servers:
- url: https://deckofcardsapi.com/api
paths:
/deck/new/:
get:
operationId: newDeck
tags:
- Deck
summary: A brand new deck
parameters:
- name: jokers_enabled
in: query
description: Whether to include two Jokers in the deck.
schema:
type: boolean
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
shuffled:
type: boolean
remaining:
type: integer
/deck/new/shuffle/:
get:
operationId: neweDeckShuffled
tags:
- Deck
summary: Shuffle the Cards
parameters:
- name: deck_count
in: query
description: The number of decks you want to use. Blackjack typically uses 6 decks. The default is 1.
schema:
type: integer
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
shuffled:
type: boolean
remaining:
type: integer
/deck/{deck_id}/draw/:
get:
tags:
- Deck
summary: Draw a Card from top of a deck
description: Draw a Card from top of a deck
operationId: drawCardFromDeckTop
parameters:
- name: deck_id
required: true
in: path
description: The identifier of the deck.
schema:
type: string
- name: count
in: query
description: The number of cards to draw from the deck.
schema:
type: integer
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
cards:
type: array
items:
type: object
properties:
code:
type: string
image:
type: string
images:
type: object
properties:
svg:
type: string
png:
type: string
value:
type: string
suit:
type: string
remaining:
type: integer
/deck/{deck_id}/shuffle/:
get:
tags:
- Deck
summary: Reshuffle the Cards
description: Reshuffle the Cards
operationId: shuffleDeckById
parameters:
- name: deck_id
in: path
required: true
description: The identifier of the deck.
schema:
type: string
- name: remaining
in: query
description: Whether to shuffle only the remaining cards in the main stack.
schema:
type: boolean
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
shuffled:
type: boolean
remaining:
type: integer
# /deck/new/:
/deck/{deck_id}/pile/{pile_name}/add/:
get:
operationId: addToPile
tags:
- Deck
summary: Adding to Piles
description: Add card from a Deck to a Pile
parameters:
- name: deck_id
in: path
required: true
description: The identifier of the deck.
schema:
type: string
- name: pile_name
in: path
required: true
description: The name of the pile.
schema:
type: string
- name: cards
in: query
description: The card codes to add to the pile, separated by commas.
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
remaining:
type: integer
/deck/{deck_id}/pile/{pile_name}/shuffle/:
get:
tags:
- Deck
summary: Shuffle Piles
description: Shuffle a pile
operationId: shufflePile
parameters:
- name: deck_id
in: path
required: true
description: The identifier of the deck.
schema:
type: string
- name: pile_name
in: path
required: true
description: The name of the pile.
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
remaining:
type: integer
/deck/{deck_id}/pile/{pile_name}/list/:
get:
operationId: listPileCards
tags:
- Deck
summary: Listing Cards in Piles
description: List Cards in pile
parameters:
- name: deck_id
in: path
description: The identifier of the deck.
required: true
schema:
type: string
- name: pile_name
in: path
description: The name of the pile.
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
cards:
type: array
items:
type: object
properties:
image:
type: string
value:
type: string
suit:
type: string
code:
type: string
remaining:
type: integer
/deck/{deck_id}/pile/{pile_name}/draw/:
get:
operationId: drawCardsFromPileTop
tags:
- Deck
summary: Drawing from a pile (top as a stack)
description: Draw cards from pile
parameters:
- name: deck_id
in: path
required: true
description: The identifier of the deck.
schema:
type: string
- name: pile_name
in: path
required: true
description: The name of the pile.
schema:
type: string
- name: cards
in: query
description: The card codes to draw from the pile, separated by commas.
schema:
type: string
- name: count
in: query
description: The number of cards to draw from the pile.
schema:
type: integer
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
remaining:
type: integer
cards:
type: array
items:
type: object
properties:
image:
type: string
value:
type: string
suit:
type: string
code:
type: string
/deck/{deck_id}/return/:
get:
operationId: returnCardsToDeck
tags:
- Deck
summary: Returning cards to the deck
description: Returning cards to the deck
parameters:
- name: deck_id
required: true
in: path
description: The identifier of the deck.
schema:
type: string
- name: cards
in: query
description: The card codes to return to the deck, separated by commas.
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
shuffled:
type: boolean
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
remaining:
type: integer
/deck/{deck_id}/pile/{pile_name}/return/:
get:
operationId: returnCardsToPile
tags:
- Deck
summary: Returning cards to pile
description: Returning cards to pile
parameters:
- name: deck_id
required: true
in: path
description: The identifier of the deck.
schema:
type: string
- name: pile_name
in: path
required: true
description: The name of the pile.
schema:
type: string
- name: cards
in: query
description: The card codes to return to the deck, separated by commas.
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
deck_id:
type: string
remaining:
type: integer
piles:
type: object
properties:
pile_name:
type: object
properties:
remaining:
type: integer