-
Notifications
You must be signed in to change notification settings - Fork 2
/
djangoconus.yaml
294 lines (294 loc) · 8.42 KB
/
djangoconus.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
---
openapi: 3.0.0
info:
title: DjangoConUS Treasure
description: This is a test API for managing DjangoConUS Treasure to demonstrate how to create an API spec with atleast one endpoint.
version: 1.0.0
servers:
- url: https://virtserver.swaggerhub.com/veldakarimi/djangoconus/1.0.0
description: SwaggerHub API Auto Mocking
paths:
/treasures:
get:
summary: Get all treasures
operationId: getTreasures
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Treasure'
post:
summary: Create a new treasure
operationId: createTreasure
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Treasure'
required: true
responses:
"201":
description: Treasure created
content:
application/json:
schema:
$ref: '#/components/schemas/Treasure'
"400":
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
bad_request:
value:
message: The request body is invalid.
code: 400
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
unauthorized:
value:
message: The user is not authorized to access this resource.
code: 401
"500":
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: An unexpected error occurred while processing the request.
code: 500
/treasures/{id}:
get:
summary: Get a treasure by ID
operationId: getTreasureById
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: integer
format: int64
responses:
"200":
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Treasure'
"404":
description: treasure not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: treasure not found.
code: 400
"500":
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: An unexpected error occurred while processing the request.
code: 500
put:
summary: Update a treasure by ID
operationId: updateTreasureById
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Treasure'
required: true
responses:
"200":
description: Treasure updated
content:
application/json:
schema:
$ref: '#/components/schemas/Treasure'
"400":
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Bad request.
code: 400
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Unauthorized.
code: 401
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Access is forbidden.
code: 403
"404":
description: Merchandise not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: treasure not found.
code: 404
"500":
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: An unexpected error occurred while processing the request.
code: 500
delete:
summary: Delete a treasure by ID
operationId: deleteTreasureById
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: integer
format: int64
responses:
"204":
description: Treasure deleted
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Treasure has been deleted.
code: 204
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Unauthorized to view resource
code: 401
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: Access is forbidden.
code: 403
"404":
description: Treasure is not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: treasure is not found.
code: 404
"500":
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
internal_server_error:
value:
message: An unexpected error occurred while processing the request.
code: 500
components:
schemas:
Treasure:
type: object
properties:
id:
type: integer
name:
type: string
price:
type: number
description:
type: string
example:
- id: 1
name: Treasure 1
price: 39.99
description: A snow globe with the djangocon logo in the middle and laptops on the side
- id: 2
name: Treasure 2
price: 10.99
description: A djangocon green notebook with 100 squared pages and a hard cover logo
Error:
type: object
properties:
error_code:
type: number
message:
type: string
docs:
type: string
description: Represents an HTTP error