-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathapiary.apib
399 lines (309 loc) · 10.6 KB
/
apiary.apib
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
395
396
397
398
399
FORMAT: 1A
HOST: https://jatto-postit-app.herokuapp.com/api/v1
# POSTIT
Is a simple application that allows friends and colleagues create groups for notifications. This way one person can post notifications to everyone by sending a message once - a broadcast message. The application allows people create accounts, create groups and add registered users to the groups, and then send messages out to these groups whenever they want.
# Allowed HTTPs requests:
<pre>
POST : To create resource
GET : Get a resource or list of resources
DELETE : To delete resource
</pre>
# Description Of Usual Server Responses:
- 200 `OK` - the request was successful (some API calls may return 201 instead).
- 201 `Created` - the request was successful and a resource was created.
- 400 `Bad Request` - the request could not be understood or was missing required parameters.
- 401 `Unauthorized` - authentication failed or user doesn't have permissions for requested operation.
- 404 `Not Found` - resource was not found.
## Create a new user [/users/signup]
### signup [POST]
+ Request (application/x-www-form-urlencoded)
{
"username": "jhartman",
"email": [email protected],
"password": jasabs1993,
"fullName": Aminu Jatto Abdul,
"phoneNumber": 08162740850
}
+ Response 201 (application/json)
{
"data": {
"id": 90,
"username": "jhartman",
"email": "[email protected]",
"fullName": "Amin Jatto Abdul",
"phoneNumber": "08162740850",
"lastLogin": "2017-09-11T10:51:01.145Z",
"createdAt": "2017-09-11T10:51:01.067Z"
}
}
+ Response 400 (application/json)
{
"err": {
"message": "username already exists"
}
}
## Login a user [/users/signin]
### signin [POST]
+ Request (application/x-www-form-urlencoded)
{
"username": "jhartman",
"password": "jasabs1993"
}
+ Response 202 (application/json)
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7ImlkIjo4OCwidXNlcm5hbWUiOiJqYXR0b2FkZSIsImVtYWlsIjoiamF0dG9hZGVAZ21haWwuY29tIiwiZnVsbE5hbWUiOiJBbWludWphdHRvIEFiZHVscWFoaGFyIiwicGhvbmVOdW1iZXIiOiIwODE2Mjc0MDg1MCJ9LCJpYXQiOjE1MDUxMjczOTUsImV4cCI6MTUwNTIxMzc5NX0.k4rzXdeGLeBICBMOBh4TYim57taKXYoGNXOHuA8sHAc",
"message": "jhartman has successfully logged in"
}
+ Response 400 (application/json)
{
"message": "username does not exist"
}
## Request for a password change [/users/reset/request]
### requestpassword [POST]
+ Request (application/x-www-form-urlencoded)
{
"email": "[email protected]"
}
+ Response 200 (application/json)
{
"data": {
"message": {
"accepted": [
],
"rejected": [],
"response": "250 2.0.0 OK 1505127850 o49sm1954305edo.69 - gsmtp",
"envelope": {
"from": "[email protected]",
"to": [
]
},
"messageId": "<[email protected]>"
}
}
}
+ Response 400 (application/json)
{
"data": {
"error": {
"message": "email is not valid"
}
}
}
## Update password [/users/reset/${hash}]
### Get password token [POST]
+ Parameters
+ hash (required) - params for the url
+ Request (application/x-www-form-urlencoded)
{
"password": "NewJasabs"
}
+ Response 200 (application/json)
{
"data": {
"message": "Password Reset Successful"
}
}
+ Response 400 (application/json)
{
"data": {
"error": {
"message": "Expired or Invalid link"
}
}
}
## Authenticated user creates a new Group [/groups]
### Create Group [POST]
+ Request (application/x-www-form-urlencoded)
{
name: Django Lovers,
desc: A brief description about the group,
isArchived: '0'
}
+ Response 201 (application/json)
{
"group": {
"id": 45,
"name": "My Beatiful Group",
"desc": "a brief desc about the beautiful group",
"isArchived": "0",
"updatedAt": "2017-09-11T11:28:17.660Z",
"createdAt": "2017-09-11T11:28:17.660Z"
},
"message": "group created successfully"
}
+ Response 400 (application/json)
{
"data": {
"message": "Group Already Exist"
}
}
### Get Groups [GET]
+ Request (application/x-www-form-urlencoded)
+ Response 200 (application/json)
[
{
"id": 17,
"name": "Django Developers",
"desc": "a group for developing django app by collaborating",
"isArchived": "0",
"createdAt": "2017-09-06T18:17:59.682Z",
"updatedAt": "2017-09-06T18:17:59.682Z",
"users": [
{
"id": 88,
"username": "jattoade",
"fullName": "Aminujatto Abdulqahhar",
"lastLogin": "2017-09-06T18:13:23.483Z",
"email": "[email protected]",
"phoneNumber": "08162740850",
"createdAt": "2017-09-06T18:13:23.452Z",
"updatedAt": "2017-09-06T18:13:23.452Z",
"GroupsUsers": {}
}
]
},
{
"id": 18,
"name": "Django Developers",
"desc": "a group for developing django app by collaborating",
"isArchived": "0",
"createdAt": "2017-09-06T18:18:07.440Z",
"updatedAt": "2017-09-06T18:18:07.440Z",
"users": [
{
"id": 88,
"username": "jattoade",
"fullName": "Aminujatto Abdulqahhar",
"lastLogin": "2017-09-06T18:13:23.483Z",
"email": "[email protected]",
"phoneNumber": "08162740850",
"createdAt": "2017-09-06T18:13:23.452Z",
"updatedAt": "2017-09-06T18:13:23.452Z",
"GroupsUsers": {}
}
]
}
]
+ Response 400 (application/json)
[
]
## Add User to Created Group [/groups/${id}/user]
### Post user to GroupUser [POST]
+ Parameters
+ id (required) - Group ID params for the url
+ Request (application/x-www-form-urlencoded)
{
"userId": 3,
"groupId": id
}
+ Response 200 (application/json)
{
"userId": 89,
"groupId": 18,
"isAdmin": "0",
"updatedAt": "2017-09-11T11:58:28.149Z",
"createdAt": "2017-09-11T11:58:28.149Z",
"id": 63
}
+ Response 400 (application/json)
{
"data": {
"error": {
"message": "user already exist in group"
}
}
}
## Add Message to Created Group [/groups/${id}/message]
### Post message [POST]
+ Parameters
+ id (required) - Group ID params for the url
+ Request (application/x-www-form-urlencoded)
{
"userId": 89,
"groupId": id,
"text": "hello, how do tyou do?",
"priority": "Normal"
}
+ Response 200 (application/json)
{
"isArchived": "0",
"id": 22,
"userId": 88,
"groupId": 18,
"text": "some newest text",
"priority": "Normal",
"readBy": [
"jhartman"
],
"updatedAt": "2017-09-11T12:10:01.555Z",
"createdAt": "2017-09-11T12:10:01.555Z"
}
+ Response 400 (application/json)
{
"data": {
"error": {
"message": "error occured sending message"
}
}
}
## Get Message From Group [/groups/${id}/messages]
### Get Messages [GET]
+ Parameters
+ id (required) - Group ID params for the url
+ Request (application/x-www-form-urlencoded)
+ Response 200 (application/json)
[
{
"id": 20,
"text": "some new text",
"userId": 88,
"groupId": 18,
"priority": "Normal",
"readBy": [
"jattoade"
],
"createdAt": "2017-09-10T21:47:11.436Z",
"user": {
"id": 88,
"username": "jattoade",
"fullName": "Aminujatto Abdulqahhar"
}
},
{
"id": 21,
"text": "some newest text",
"userId": 88,
"groupId": 18,
"priority": "Normal",
"readBy": [
"jattoade"
],
"createdAt": "2017-09-10T22:04:28.776Z",
"user": {
"id": 88,
"username": "jattoade",
"fullName": "Aminujatto Abdulqahhar"
}
},
{
"id": 22,
"text": "some newest text",
"userId": 88,
"groupId": 18,
"priority": "Normal",
"readBy": [
"jattoade"
],
"createdAt": "2017-09-11T12:10:01.555Z",
"user": {
"id": 88,
"username": "jattoade",
"fullName": "Aminujatto Abdulqahhar"
}
}
]
+ Response 400 (application/json)
[
]