-
Notifications
You must be signed in to change notification settings - Fork 1
/
matchmaking.schema.yaml
283 lines (283 loc) · 7.36 KB
/
matchmaking.schema.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
openapi: 3.0.1
info:
title: Matchmaking service
description: "Because we need machmatking"
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 0.0.1
servers:
- url: http://127.0.0.1:3334
tags:
- name: matches
description: Everything related to a match
- name: round
description: Rounds stats
- name: internal
description: For internal communication
paths:
/matchs:
get:
tags:
- matches
summary: Get all matches
operationId: getAllMatches
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
description: Array of matches id
items:
type: string
description: The id of the match
put:
tags:
- matches
summary: Create a match
operationId: createMatch
security:
- bearerAuth: []
requestBody:
description: Match to create
content:
application/json:
schema:
$ref: "#/components/schemas/CreateMatchDto"
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/MatchDto"
400:
$ref: "#/components/responses/ErrorResponse"
/matchs/{id}:
get:
tags:
- matches
summary: Get a match by id
operationId: getMatchById
parameters:
- name: id
in: path
required: true
description: Id of the match
schema:
type: integer
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/MatchDto"
/matchs/invitation:
get:
tags:
- matches
summary: Get all matches that are waiting for an invitation for the connected player
operationId: getAllMatchesWaitingForInvitation
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
description: Array of awaiting matches
items:
type: object
required:
- id
- opponent
properties:
id:
type: integer
description: The id of the match
authorId:
type: string
description: The id of the player opponent
/matchs/{id}/join:
post:
tags:
- matches
summary: Join a match
operationId: joinMatch
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
description: Id of the match
schema:
type: integer
requestBody:
description: Deck
content:
application/json:
schema:
$ref: "#/components/schemas/DeckDto"
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/MatchDto"
400:
$ref: "#/components/responses/ErrorResponse"
/internal/matches/{id}/close:
post:
tags:
- internal
summary: Close a match
operationId: closeMatch
parameters:
- name: id
in: path
required: true
description: Id of the match
schema:
type: integer
requestBody:
description: Post match winner and close it
content:
application/json:
schema:
oneOf:
- type: object
required:
- winnerId
properties:
winnerId:
type: number
description: The id of the winner. If the winner is a draw, the winnerId is null and the match status is set to finished
- type: object
required:
- isDraw
properties:
isDraw:
type: boolean
description: If the match is a draw
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/MatchDto"
400:
$ref: "#/components/responses/ErrorResponse"
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
DeckDto:
type: array
description: Deck of the player
minItems: 10
maxItems: 10
items:
$ref: "#/components/schemas/PokemonID"
CreateMatchDto:
type: object
required:
- opponentId
properties:
opponentId:
type: integer
description: Id of the opponent
deck:
type: array
description: Deck of the player
minItems: 10
maxItems: 10
items:
$ref: "#/components/schemas/PokemonID"
MatchDto:
type: object
required:
- id
- createdAt
- updatedAt
- authorId
- opponentId
- status
- authorPokemons
properties:
id:
type: integer
description: The id of the match
createdAt:
type: string
description: The date of the creation
format: date-time
updatedAt:
type: string
description: The date of the last update
format: date-time
authorPokemons:
type: array
description: The pokemons ids of the author
maxItems: 10
minItems: 10
items:
type: integer
opponentPokemons:
type: array
description: The pokemons ids of the opponent
maxItems: 10
minItems: 10
items:
type: integer
authorId:
type: integer
description: The id of the author
opponentId:
type: integer
description: The id of the opponent
status:
type: string
description: The status of the match
enum:
- waitingInvite
- started
- finished
winnerId:
default: null
type: integer
description: The id of the winner. If the winner is a draw, the winnerId is null and the match status is set to finished
PokemonID:
type: integer
minimum: 0
AppError:
type: "object"
required:
- code
- message
properties:
code:
type: integer
format: int32
description: Error code
message:
type: string
description: Error message
example: "Internal error"
responses:
ErrorResponse:
description: An error caused by the client
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/AppError"