-
Notifications
You must be signed in to change notification settings - Fork 18
/
openapi.yml
394 lines (391 loc) · 9.88 KB
/
openapi.yml
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
openapi: 3.0.0
info:
title: OpenAPI definition
version: v0
servers:
- url: http://localhost:8082
tags:
- name: maintenance-controller
description: Endpoint which enables maintenance
- name: book-controller
description: Endpoints related to books
paths:
/maintenance:
get:
tags:
- maintenance-controller
operationId: retreiveInMaintenance
responses:
'200':
description: Checks if the application in under maitenance
content:
application/json:
schema:
"$ref": "#/components/schemas/Maintenance"
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
put:
tags:
- maintenance-controller
operationId: initInMaintenance
requestBody:
content:
"*/*":
schema:
type: string
required: true
responses:
'204':
description: Put the app under maitenance
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
/books:
get:
tags:
- book-controller
summary: Gets all books
operationId: getAllBooks
responses:
'200':
description: Found books
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Book"
'204':
description: No books found
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Book"
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
put:
tags:
- book-controller
summary: Updates a book
operationId: updateBook
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/Book"
required: true
responses:
'202':
description: Books found
content:
application/json:
schema:
"$ref": "#/components/schemas/Book"
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
post:
tags:
- book-controller
summary: Creates a book
operationId: createBook
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/Book"
required: true
responses:
'201':
description: Book created. The URI is filled in the Location header
headers:
location:
description: The generated book's URI
style: simple
schema:
type: string
content:
application/json:
schema:
type: string
format: uri
'202':
description: The book has not been yet created but will be ASAP
content:
application/json:
schema:
type: string
format: uri
'408':
description: The number api is unreachable
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: An unexpected error has occured
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
/books/{id}:
get:
tags:
- book-controller
summary: Gets a book from its ID
operationId: getBook
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Found book
content:
application/json:
schema:
"$ref": "#/components/schemas/Book"
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
delete:
tags:
- book-controller
summary: Removes a book
operationId: deleteBook
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
description: Book removed
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
/books/random:
get:
tags:
- book-controller
summary: Gets a random book
operationId: getRandomBook
responses:
'200':
description: Found the book
content:
application/json:
schema:
"$ref": "#/components/schemas/Book"
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
/books/count:
get:
tags:
- book-controller
summary: Gets the number of books
operationId: count
responses:
'200':
description: Number of books
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
format: int64
'408':
description: Request Timeout
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'418':
description: I'm a teapot
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
'500':
description: Internal Server Error
content:
"*/*":
schema:
"$ref": "#/components/schemas/APIError"
components:
schemas:
APIError:
type: object
properties:
code:
type: integer
format: int32
reason:
type: string
Book:
required:
- title
type: object
properties:
title:
type: string
isbn13:
type: string
isbn10:
type: string
author:
type: string
yearOfPublication:
type: integer
format: int32
nbOfPages:
type: integer
format: int32
rank:
maximum: 10
minimum: 1
type: integer
format: int32
price:
type: number
smallImageUrl:
type: string
format: url
mediumImageUrl:
type: string
format: url
description:
type: string
id:
type: integer
format: int64
Maintenance:
type: object
properties:
from:
type: string
format: date-time
inMaintenance:
type: boolean