-
Notifications
You must be signed in to change notification settings - Fork 4
/
openapi.yaml
290 lines (284 loc) · 8.34 KB
/
openapi.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
openapi: "3.0.0"
info:
version: "1.1"
title: AlgaStock
description: "This is the API spect used during the \"Ignição React\" course"
contact:
name: Daniel Bonifacio
email: [email protected]
servers:
- url: https://localhost:3024
description: Local server
paths:
/products:
get:
summary: "Get all products"
description: "Get all products stored and they relative id, price, available stock and a bunch of metadata."
operationId: getAllProducts
tags:
- products
responses:
200:
description: Sunrise and sunset times response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Product'
post:
summary: "Insert a new product"
description: "Insert a new product on the store"
operationId: addProduct
security:
- BearerAuth: [admin]
tags:
- products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Cookie
price:
type: number
minimum: 0
format: float
example: 1.5
stock:
type: number
minimum: 0
format: integer
example: 25
responses:
201:
description: Product sucessfully created
401:
description: You don't have permission to create products
403:
$ref: '#/components/responses/UnauthorizedError'
/products/{productId}:
get:
summary: "Get single product"
description: "Get a single product and they relative id, price, available stock and a bunch of metadata."
operationId: getSingleProduct
tags:
- products
parameters:
- name: productId
in: path
description: "Id of the single product that you want to retrieve information."
required: true
schema:
type: string
example: "CTcswP9kijnxwFp6"
responses:
200:
description: Single product response
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
404:
description: Product not found
delete:
summary: "Delete single product"
description: "Deletes a product and all him information"
operationId: deleteSingleProduct
security:
- BearerAuth: [admin]
tags:
- products
parameters:
- name: productId
in: path
description: "ID of the single product that you want to delete."
required: true
schema:
type: string
example: "CTcswP9kijnxwFp6"
responses:
200:
description: Product sucessfully deleted
401:
description: You don't have permission to delete this product
403:
$ref: '#/components/responses/UnauthorizedError'
patch:
summary: "Update product fields"
description: "Update specific product fields that"
operationId: updateProduct
security:
- BearerAuth: [admin]
tags:
- products
parameters:
- name: productId
in: path
description: "ID of the single product that you want to update."
required: true
schema:
type: string
example: "CTcswP9kijnxwFp6"
requestBody:
description: '**Note:** You can provide only the fields that you want to update, like: `{ price: 1.75 }`'
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Cookie
price:
type: number
minimum: 0
format: float
example: 1.75
stock:
type: number
minimum: 0
format: integer
example: 35
responses:
200:
description: Product sucessfully updated
401:
description: You don't have permission to update products
403:
$ref: '#/components/responses/UnauthorizedError'
/buy/{productId}:
get:
summary: "Buy one product"
description: "Buy a product if it has available stock"
operationId: buyOneProduct
parameters:
- name: productId
in: path
description: The ID of the product that you want to buy
required: true
schema:
type: string
example: "CTcswP9kijnxwFp6"
security:
- BearerAuth: [customer]
tags:
- products
responses:
200:
description: Product successfully bought
404:
description: Product not found
401:
description: 'Product has no more stock'
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: 'Product has no more stock'
403:
$ref: '#/components/responses/UnauthorizedError'
/authentication/login:
post:
description: "SignIn User"
operationId: signInUser
tags:
- authentication
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
user:
type: string
example: daniel
pass:
type: string
example: s3curepassword123
responses:
200:
description: Successful login
content:
application/json:
schema:
type: object
properties:
_id:
type: string
description: 'The logged in user ID'
example: 'mvpht5Ylt3GaGIeE'
user:
type: string
description: 'The logged in user name'
example: 'danielbonifacio'
email:
type: string
description: 'The logged in user email'
example: '[email protected]'
role:
type: string
description: 'User role (admin or customer)'
example: 'customer'
token:
type: string
description: 'The logged in user unique token'
example: 'Ge6HkvYS9dtypYl6?Ge6HkvYS9dtypYl6?Ge6HkvYS9dtypYl6'
createdAt:
type: string
example: '2020-08-04T12:45:28.612Z'
updatedAt:
type: string
example: '2020-08-04T12:45:28.612Z'
401:
description: Wrong credentials
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "We could not log you in"
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
responses:
UnauthorizedError:
description: Access token is missing or invalid
schemas:
Product:
type: object
properties:
_id:
type: string
description: 'The product ID'
example: "CTcswP9kijnxwFp6"
name:
type: string
description: 'The product name'
example: "Cookie"
price:
type: number
description: 'The product price'
example: 1.5
stock:
type: string
description: "The available stock of the product"
example: 25
tags:
- name: products
description: Everything about products
- name: authentication
description: User access