forked from quarkusio/quarkus-super-heroes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-schema.yml
291 lines (291 loc) · 8.26 KB
/
openapi-schema.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
---
openapi: 3.0.3
info:
title: Hero API
description: This API allows CRUD operations on a hero
contact:
name: Quarkus
url: https://github.com/quarkusio
version: "1.0"
tags:
- name: hello
- name: heroes
paths:
/api/heroes:
get:
tags:
- heroes
summary: Returns all the heroes from the database
parameters:
- name: name_filter
in: query
description: An optional filter parameter to filter results by name
required: false
schema:
type: string
responses:
"200":
description: Gets all heroes
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Hero'
examples:
heroes:
value:
- id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
put:
tags:
- heroes
summary: Completely replace all heroes with the passed-in heroes
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Hero'
examples:
heroes:
value:
- id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
required: true
responses:
"201":
description: The URI to retrieve all the created heroes
headers:
Location:
style: simple
schema:
format: uri
type: string
"400":
description: Invalid heroes passed in (or no request body found)
post:
tags:
- heroes
summary: Creates a valid hero
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
valid_hero:
value:
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
required: true
responses:
"201":
description: The URI of the created hero
headers:
Location:
style: simple
schema:
format: uri
type: string
"400":
description: Invalid hero passed in (or no request body found)
delete:
tags:
- heroes
summary: Delete all heroes
responses:
"204":
description: Deletes all heroes
/api/heroes/hello:
get:
tags:
- hello
summary: Ping hello
responses:
"200":
description: Ping hello
content:
text/plain:
schema:
type: string
examples:
hello_success:
value: Hello Hero Resource
/api/heroes/random:
get:
tags:
- heroes
summary: Returns a random hero
responses:
"200":
description: Gets a random hero
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
hero:
value:
id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
"404":
description: No hero found
/api/heroes/{id}:
get:
tags:
- heroes
summary: Returns a hero for a given identifier
parameters:
- name: id
in: path
required: true
schema:
format: int64
type: integer
responses:
"200":
description: Gets a hero for a given id
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
hero:
value:
id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
"404":
description: The hero is not found for a given identifier
put:
tags:
- heroes
summary: Completely updates/replaces an exiting hero by replacing it with the
passed-in hero
parameters:
- name: id
in: path
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
valid_hero:
value:
id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
required: true
responses:
"204":
description: Replaced the hero
"400":
description: Invalid hero passed in (or no request body found)
"404":
description: No hero found
delete:
tags:
- heroes
summary: Deletes an exiting hero
parameters:
- name: id
in: path
required: true
schema:
format: int64
type: integer
responses:
"204":
description: Deletes a hero
patch:
tags:
- heroes
summary: Partially updates an exiting hero
parameters:
- name: id
in: path
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
valid_hero:
value:
id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
required: true
responses:
"200":
description: Updated the hero
content:
application/json:
schema:
$ref: '#/components/schemas/Hero'
examples:
hero:
value:
id: 1
name: Luke Skywalker
level: 10
picture: https://raw.githubusercontent.com/quarkusio/quarkus-super-heroes/characterdata/images/luke-skywalker-2563509063968639219.jpg
powers: "Uses light sabre, The force"
"400":
description: Null hero passed in (or no request body found)
"404":
description: No hero found
components:
schemas:
Hero:
required:
- name
- level
type: object
properties:
id:
format: int64
type: integer
name:
maxLength: 50
minLength: 3
type: string
otherName:
type: string
level:
format: int32
minimum: 0
exclusiveMinimum: true
type: integer
picture:
type: string
powers:
type: string