-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathspecification.yaml
401 lines (400 loc) · 10.3 KB
/
specification.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
openapi: "3.0.0"
info:
version: 1.0.0
title: ugamela api
contact:
email: "[email protected]"
license:
name: AGPL
url: "https://www.gnu.org/licenses/agpl-3.0.en.html"
servers:
- url: https://api.mamen.at/v1/
paths:
/player/get/:
get:
summary: Get a player by his ID
operationId: getUser
tags:
- Player
parameters:
- name: id
in: query
required: true
description: The ID of the player
schema:
type: integer
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/PlayerGet"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'404':
description: Player not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/player/create:
post:
summary: Creates a new player
operationId: createPlayer
tags:
- Player
requestBody:
$ref: '#/components/requestBodies/PlayerPost'
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/planet/get:
get:
summary: Get a specific planet
operationId: getPlanet
tags:
- Planet
parameters:
- name: id
in: query
required: true
description: The ID of the planet
schema:
type: integer
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/PlanetGet"
- $ref: "#/components/schemas/PlanetSelfGet"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'404':
description: Player not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/planet/create:
post:
summary: Creates a new planet
operationId: createPlanet
tags:
- Planet
requestBody:
$ref: '#/components/requestBodies/PlanetPost'
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Success"
'400':
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/building/get/{planetID}:
get:
summary: Get all buildings on a planet.
operationId: getAllBuildings
tags:
- Building
parameters:
- name: planetID
in: path
required: true
description: The ID of the planet
schema:
type: integer
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/PlanetGet"
- $ref: "#/components/schemas/PlanetSelfGet"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'404':
description: Player not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/building/get/{planetID}/{buildingID}:
get:
summary: Get a specific building on a planet.
operationId: getBuilding
tags:
- Building
parameters:
- name: planetID
in: path
required: true
description: The ID of the planet
schema:
type: integer
- name: buildingID
in: path
required: true
description: The ID of the building
schema:
type: integer
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/PlanetGet"
- $ref: "#/components/schemas/PlanetSelfGet"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
'404':
description: Player not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/building/build:
post:
summary: Get a specific building on a planet.
operationId: buildBuilding
tags:
- Building
parameters:
- name: planetID
in: path
required: true
description: The ID of the planet
schema:
type: integer
- name: buildingID
in: path
required: true
description: The ID of the building
schema:
type: integer
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/PlanetGet"
- $ref: "#/components/schemas/PlanetSelfGet"
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Authentication failed
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
# /technology/get:
# /technology/get/{techID}:
# /technology/build:
# /ship/get:
# /ship/get/{shipID}:
# /ship/build:
# /defense/get:
# /defense/get/{defenseID}:
# /defense/build:
# /alliance/get:
# /galaxy/get:
# /message/get:
# /message/send:
# /stats/get:
# /event/get:
# /event/create:
# /search:
# /settings/get:
# /settings/set:
components:
schemas:
Success:
properties:
message:
type: string
PlayerGet:
required:
- id
- username
properties:
id:
type: integer
format: int64
username:
type: string
PlayerPost:
required:
- username
properties:
username:
type: string
email:
type: string
password:
type: string
PlanetGet:
properties:
id:
type: integer
format: int64
ownerID:
type: integer
format: int64
name:
type: string
posGalaxy:
type: integer
format: int32
posSystem:
type: integer
format: int32
posPlanet:
type: integer
format: int32
planetType:
type: integer
format: int32
image:
type: integer
format: int32
destroyed:
type: boolean
PlanetSelfGet:
properties:
id:
type: integer
format: int64
ownerID:
type: integer
format: int64
name:
type: string
posGalaxy:
type: integer
format: int32
posSystem:
type: integer
format: int32
posPlanet:
type: integer
format: int32
PlanetPost:
required:
- id
- username
properties:
id:
type: integer
format: int64
username:
type: string
password:
type: string
email:
type: string
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
requestBodies:
PlayerPost:
description: A JSON object containing player information
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerPost'
PlanetPost:
description: A JSON object containing player information
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PlanetPost'