-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yml
382 lines (379 loc) · 9.12 KB
/
swagger.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
openapi: 3.0.3
info:
title: Andela Capstone Blog Api V.1
description: |-
This is an Andela Capstone Blog api built with Nodejs technology.
The purpose of this api is to have users be able to Signup/Login(Authentication) and View posted blogs.
Only an Admin Can Delete,Post,Edit a blog. An admin can also grant another user admin priveleges!
contact:
email: [email protected]
servers:
- url: https://odd-teal-jellyfish-wig.cyclic.app/api/
tags:
- name: Blog API
description: All Endpoints of the blog Api
paths:
/user/signup:
post:
tags:
- Signup
summary: New User Registration process
description: Register a new user if he's not already registered
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Signup'
required: true
responses:
'200':
description: 'User Registered Successfully'
content:
application/json:
schema:
$ref: '#components/schemas/SignupResponse'
/user/login:
post:
tags:
- Login
summary: Login User process
descriptions: Login a user if they already exist
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/Login'
required: true
responses:
'200':
description: 'User logged in successfully'
content:
application/json:
schema:
$ref: '#components/schemas/LoginResponse'
/posts:
post:
tags:
- Post
summary: Post a Blog
description: Post a blog and it gets saved to MongoDB
parameters:
- in: header
name: Bearer
schema:
type: string
required: true
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/Post'
required: true
get:
tags:
- Post
summary: Get all saved Blogs
description: This will fetch all posts saved in MongoDB
parameters:
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: 'Fetched posts successfully'
content:
application/json:
schema:
type: array
items:
$ref: '#components/schemas/Post'
/posts/{postId}:
get:
tags:
- Post
summary: Find a post by ID
description: This will return a post based off it's ID
operationId: getPostById
parameters:
- in: path
name: postId
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Fetched post by id
content:
application/json:
schema:
$ref: '#components/schemas/Post'
put:
tags:
- Post
summary: Update a post by ID
description: This will update a post based off it's ID
operationId: Update by id
parameters:
- in: path
name: updatedpostbyid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Update post by id
content:
application/json:
schema:
$ref: '#components/schemas/Post'
delete:
tags:
- Post
summary: Delete a post by ID
description: This will Delete a post based off it's ID
operationId: Delete by id
parameters:
- in: path
name: deletedpostbyid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Update post by id
content:
application/json:
schema:
$ref: '#components/schemas/Post'
/post/comments/{postId}:
get:
tags:
- Comments
summary: This will return comments associated to the post
description: This will return comments associated to the post
operationId: Comment by id
parameters:
- in: path
name: getcommentbypostid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Get post comments by id
content:
application/json:
schema:
type: array
items:
$ref: '#components/schemas/Comments'
post:
tags:
- Comments
summary: This will post a comment associated to the post
operationId: Comment by id
parameters:
- in: path
name: getcommentbypostid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Get post comments by id
content:
application/json:
schema:
$ref: '#components/schemas/Comments'
/post/likes/{postId}:
post:
tags:
- Likes
summary: This will like a post associated to the post
operationId: Comment by id
parameters:
- in: path
name: getcommentbypostid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Get post comments by id
content:
application/json:
schema:
$ref: '#components/schemas/Likes'
get:
tags:
- Likes
summary: This will like a post associated to the post
operationId: Comment by id
parameters:
- in: path
name: getcommentbypostid
description: ID of the post
required: true
schema:
type: string
- in: header
name: Bearer
schema:
type: string
required: true
responses:
'200':
description: Get post comments by id
content:
application/json:
schema:
type: array
$ref: '#components/schemas/Likes'
components:
schemas:
Signup:
title: Signup
required:
- name
- email
- password
type: object
properties:
name:
type: string
email:
type: string
password:
type: string
example:
name: Test User
email: [email protected]
password: test123
SignupResponse:
type: object
properties:
name:
type: string
email:
type: string
token:
type: string
example:
name: Test User
email: [email protected]
token: '143253256'
Login:
title: Login
required:
- email
- password
type: object
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: test123
LoginResponse:
type: object
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: [email protected]
token: '143253256'
Post:
title: Post
required:
- title
- content
- author
type: object
properties:
title:
type: string
content:
type: string
author:
type: string
example:
title: Sample title
content: Sample content
author: Fred
Comments:
title: Comments
required:
- user
- post
- content
type: object
properties:
user:
type: string
post:
type: string
content:
type: string
example:
user: Fred
post: 6a4ga5w7ea4g5w5
content: Sample comment
Likes:
title: Likes
required:
- user
- post
type: object
properties:
user:
type: string
post:
type: string
example:
user: Fred
post: 6a4ga5w7ea4g5w5
likeCount: 5