-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathendpoints.json
533 lines (504 loc) · 26.6 KB
/
endpoints.json
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
{
"GET /api": {
"description": "serves up a json representation of all the available endpoints of the api",
"queries": [],
"requestBody": {},
"exampleResponse": { "data": "The content of THIS file. Obiously, the exact response cannot be typed out because it would be infinitelly recursive"}
},
"GET /api/exampletable": {
"description": "all data from the exampletable",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"id": 1,
"counter": 12,
"name": "Anna",
"birthday": "2015-02-02T06:04:00.000Z",
"createdAt": "2024-02-19T09:35:22.430Z",
"updatedAt": "2024-02-19T09:35:22.430Z"
},
{
"id": 2,
"counter": 17,
"name": "Peter",
"birthday": "2015-02-02T06:04:00.000Z",
"createdAt": "2024-02-19T10:24:37.962Z",
"updatedAt": "2024-02-19T10:24:37.962Z"
}]}
},
"GET /api/exampletable/:exampletable_id": {
"description": "returns single record from exampletable by record id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"id": 1,
"counter": 12,
"name": "Anna",
"birthday": "2015-02-02T06:04:00.000Z",
"createdAt": "2024-02-19T09:35:22.430Z",
"updatedAt": "2024-02-19T09:35:22.430Z"
}]}
},
"DELETE /api/exampletable/:exampletable_id": {
"description": "deletes a single record from exampletable by record Id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status":"Deleted!",
"message": "Successfully deleted a record!"}
},
"POST /api/exampletable": {
"description": "adds a record to exmapletable",
"queries": [],
"requestBody": {"counter": 18,
"name":"Sarah",
"birthday": "2012-02-02T06:04:00Z"},
"exampleResponse": {"status":"Created!",
"message": "Successfully created a record!"}
},
"PATCH /api/exampletable/:exampletable_id": {
"description": "updates a record in exmapletable by record Id",
"queries": [],
"requestBody": {"counter": 77,
"name":"Peter",
"birthday": "2011-01-01T06:04:00Z"},
"exampleResponse": {"status":"Updated!",
"message": "Successfully updated a record!"}
},
"GET /api/profile": {
"description": "returns all data from the profile table",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"profile_id": 2,
"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Sarah Smith",
"bio": "My name is Sarah and I like woodworking",
"latitude": -33.68595,
"longitude": 144.25855,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/7/75/Avatar-gwen.jpg",
"address": "99 SomeStreet, Sometown, Somewhere",
"createdAt": "2024-02-19T21:03:51.595Z",
"updatedAt": "2024-02-19T21:03:51.595Z"
},
{
"profile_id": 3,
"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Paul is my name",
"bio": "I am Paul, please take a look at my listings",
"latitude": 39.58557,
"longitude": -116.14166,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e0/Alxira5_Avatar.svg/640px-Alxira5_Avatar.svg.png",
"address": "CB1 0AA",
"createdAt": "2024-02-19T21:22:07.727Z",
"updatedAt": "2024-02-19T21:22:07.727Z"
}
]}
},
"GET /api/profile/:profile_id": {
"description": "returns single record from profile table by profile id, if exists, otherwise returns an empty array",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"profile_id": 3,
"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Paul is my name",
"bio": "I am Paul, please take a look at my listings",
"latitude": 39.58557,
"longitude": -116.14166,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e0/Alxira5_Avatar.svg/640px-Alxira5_Avatar.svg.png",
"address": "99 SomeStreet, Sometown, Somewhere",
"createdAt": "2024-02-19T21:22:07.727Z",
"updatedAt": "2024-02-19T21:22:07.727Z"
}]}
},
"DELETE /api/profile/:profile_id": {
"description": "deletes a single record from profile table by record Id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status":"Deleted!",
"message": "Successfully deleted a record!"}
},
"GET /api/profile/email/:email": {
"description": "returns a single record from profile table by email address, if exists, otherwise returns an empty array",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"profile_id": 3,
"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Paul is my name",
"bio": "I am Paul, please take a look at my listings",
"latitude": 39.58557,
"longitude": -116.14166,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e0/Alxira5_Avatar.svg/640px-Alxira5_Avatar.svg.png",
"address": "99 SomeStreet, Sometown, Somewhere",
"createdAt": "2024-02-19T21:22:07.727Z",
"updatedAt": "2024-02-19T21:22:07.727Z"
}]}
},
"GET /api/profile/auth": {
"description": "returns a single record from profile table by email address and password in the query. If such record does not exist this endpoint returns an empty array",
"queries": ["email", "password"],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"profile_id": 3,
"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Paul is my name",
"bio": "I am Paul, please take a look at my listings",
"latitude": 39.58557,
"longitude": -116.14166,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e0/Alxira5_Avatar.svg/640px-Alxira5_Avatar.svg.png",
"address": "99 SomeStreet, Sometown, Somewhere",
"createdAt": "2024-02-19T21:22:07.727Z",
"updatedAt": "2024-02-19T21:22:07.727Z"
}]}
},
"POST /api/profile": {
"description": "adds a record to profile table",
"queries": [],
"requestBody":{"password":"passowrd",
"email": "[email protected]",
"verified": false,
"display_name": "Sarah Sarah",
"bio": "",
"latitude": -33.68595,
"longitude": 144.25855,
"search_radius": 15,
"picture_url": "",
"formattedAddress": "99 SomeStreet, Sometown, Somewhere"},
"minimumRequestBody":{"email": "[email protected]"},
"exampleResponse": {"status":"Created!",
"message": "Successfully created a record!"}
},
"PATCH /api/profile/:profile_id": {
"description": "updates a record in profile table by profile id. All properties in the body are optional, the properties that are not sent will retain existing values",
"queries": [],
"requestBody":{"verified": true,
"display_name": "Sarah Smith",
"bio": "I love cats",
"latitude": 54,
"longitude": 2,
"search_radius": 15,
"picture_url": "https://upload.wikimedia.org/wikipedia/commons/7/75/Avatar-gwen.jpg",
"formattedAddress": "99 SomeStreet, Sometown, Somewhere"},
"exampleResponse": {"status":"Updated!",
"message": "Successfully updated a record!"}
},
"GET /api/listing": {
"description": "returns all data from the listing table. Can be filtered by category and/or subcategory. Expects spaces in URL to be encoded as %20.",
"queries": ["category", "subcategory"],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"listing_id": 2,
"owner_id": 504,
"tool": "Chainsaw",
"category": "Scary Things",
"subcategory": "Loud scary things",
"deposit_required": false,
"deposit_amount": 0,
"description": "You can use this to cut down a large tree and to scare people",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/67/Lhalhiklhik%E9%8B%B8%E5%AD%90.jpg/640px-Lhalhiklhik%E9%8B%B8%E5%AD%90.jpg",
"createdAt": "2024-02-21T15:45:55.613Z",
"updatedAt": "2024-02-21T15:45:55.613Z"
},
{
"listing_id": 3,
"owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers",
"deposit_required": false,
"deposit_amount": 0,
"description": "Are you worthy to pick it up?",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Edsring_och_hammare.jpg/640px-Edsring_och_hammare.jpg",
"createdAt": "2024-02-21T15:46:30.334Z",
"updatedAt": "2024-02-21T15:46:30.334Z"
}
]}
},
"GET /api/listing/:listing_id": {
"description": "returns single record from listing table by listing id, if exists, otherwise returns an empty array",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"listing_id": 3,
"owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers",
"deposit_required": false,
"deposit_amount": 0,
"description": "Are you worthy to pick it up?",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Edsring_och_hammare.jpg/640px-Edsring_och_hammare.jpg",
"createdAt": "2024-02-21T15:46:30.334Z",
"updatedAt": "2024-02-21T15:46:30.334Z"
}]}
},
"GET /api/listing/owner/:owner_id": {
"description": "returns all record from listing table for the given owner_id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"listing_id": 3,
"owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers",
"deposit_required": false,
"deposit_amount": 0,
"description": "Are you worthy to pick it up?",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Edsring_och_hammare.jpg/640px-Edsring_och_hammare.jpg",
"createdAt": "2024-02-21T15:46:30.334Z",
"updatedAt": "2024-02-21T15:46:30.334Z"
}]}
},
"GET /api/listing/categories": {
"description": "returns all categories that exist on listings in the database",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
"Power Tools",
"Hand Tools"
]}
},
"GET /api/listing/subcategories/:category": {
"description": "returns all subcategories that exist on listings in the database for the given category. Expects spaces in URL to be encoded as %20.",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
"Cutting Tools",
"Digging Tools",
"Rakes and Cultivators",
"Hammers",
"Clamps and Vises",
"Chisels and Pry Bars",
"Saws",
"Axes",
"Pliers and Grippers",
"Gardening Tools",
"Measuring and Layout Tools",
"Screwdrivers",
"Scrapers and Putty Knives",
"Wrenches"
]}
},
"DELETE /api/listing/:listing_id": {
"description": "deletes a single record from listing table by record Id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status":"Deleted!",
"message": "Successfully deleted a record!"}
},
"POST /api/listing": {
"description": "add a record to listing table",
"queries": [],
"requestBody":{
"owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers",
"deposit_required": false,
"deposit_amount": 0,
"description": "",
"photo_url": ""
},
"minimumRequestBody":{ "owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers"
},
"exampleResponse": {"status":"Created!",
"message": "Successfully created a record!"}
},
"GET /api/chat/user/:user_id": {
"description": "returns all chats that a user is participant in",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"chat_id": 523,
"otherName": "Amir Mahmoud",
"otherUserAvatar": "https://upload.wikimedia.org/wikipedia/commons/5/53/Bumblebee_white_eyes_mad_clipart.svg",
"lastMessage": "How about tomorrow afternoon? I will be home all day, so just let me know when you are on your way.",
"lastMessageDate": "2024-02-25T15:43:27.646Z",
"chatCreatedByUserId": 524
},
{
"chat_id": 501,
"otherName": "Leila Naseri",
"otherUserAvatar": "https://upload.wikimedia.org/wikipedia/commons/e/ed/Head_of_a_Woman_in_Profile_MET_DP817933.jpg",
"lastMessage": "Hi!",
"lastMessageDate": "2024-02-25T15:43:27.333Z",
"chatCreatedByUserId": 519
}]}
},
"POST /api/chat": {
"description": "if chat does not exist, will create a new chat and return the chat id. Otherwise returns the id of an existing chat",
"queries": [],
"requestBody": {
"listingId": 505,
"userId":500
},
"exampleResponse": {
"status": "Created! | Retrieved!",
"message": "Successfully created a record! | Chat record already exists.",
"recordId": 3
}
},
"GET /api/message/chat/:chat_id": {
"description": "returns all messages from a chat by chat id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"id": 500,
"username": "Mary Jane",
"userId": 505,
"userAvatar": "",
"text": "Hey, could I rent the rottary cutter for a few days? I have some fabric I need to cut for a project.",
"date": "2024-02-24T23:18:17.179Z"
},
{
"id": 501,
"username": "Peter Parker",
"userId": 500,
"userAvatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/9/95/Spider-Man2.jpg/640px-Spider-Man2.jpg",
"text": "Sure thing! I actually just got it not too long ago. It has been a lifesaver for my quilting projects.",
"date": "2024-02-24T23:18:17.212Z"
}]}
},
"POST /api/message/:chat_id": {
"description": "adds a message onto a chat by chat id",
"queries": [],
"requestBody": {
"userId": 519,
"text":"Helloooo"
},
"exampleResponse": {
"status": "Created!",
"message": "Successfully created a record!"
}
},
"PATCH /api/message/:message_id": {
"description": "updates a record in message table by message id. All properties in the body are optional, the properties that are not sent will retain existing values",
"queries": [],
"requestBody":{"status": 2,
"text": "this message has been edited"},
"exampleResponse": {"status":"Updated!",
"message": "Successfully updated a record!"}
},
"DELETE /api/message/:message_id": {
"description": "deletes a single record from message table by record Id",
"queries": [],
"requestBody": {},
"exampleResponse": {"status":"Deleted!",
"message": "Successfully deleted a record!"}
},
"POST /api/interest": {
"description": "adds a record that the user is interested in a listing",
"queries": [],
"requestBody": {
"listingId": 509,
"userId":500
},
"exampleResponse": {
"status": "Created!",
"message": "Successfully created a record!"
}
},
"DELETE /api/interest": {
"description": "removes a record that the user is interested in a listing",
"queries": [],
"requestBody": {
"listingId": 509,
"userId":500
},
"exampleResponse": {
"status": "Deleted!",
"message": "Successfully deleted a record!"
}
},
"GET /api/interest/lendee/:lendee_id": {
"description": "returns all listings that the user is interested in",
"queries": [],
"requestBody": {},
"exampleResponse": {"status": "OK!",
"message": "Here is your data:",
"data": [
{
"listing_id": 3,
"owner_id": 2,
"tool": "Big Old Hammer",
"category": "Hand Tools",
"subcategory": "Hammers",
"deposit_required": false,
"deposit_amount": 0,
"description": "Are you worthy to pick it up?",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Edsring_och_hammare.jpg/640px-Edsring_och_hammare.jpg",
"createdAt": "2024-02-21T15:46:30.334Z",
"updatedAt": "2024-02-21T15:46:30.334Z"
},
{
"listing_id": 515,
"owner_id": 501,
"tool": "Chainsaw",
"category": "Power Tools",
"subcategory": "Saws",
"deposit_required": false,
"deposit_amount": 92,
"description": "The chainsaw is the ultimate tool for cutting through thick branches, logs, and trees with power and precision. Its robust design and sharp chain make it ideal for forestry, landscaping, and DIY projects. Whether youre felling trees or cutting firewood, the chainsaws efficiency and cutting power make it a go-to tool for any outdoor task.",
"photo_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/6/61/Chainsaw_Pioneer_600_-_1958.jpg/640px-Chainsaw_Pioneer_600_-_1958.jpg",
"createdAt": "2024-02-25T15:42:11.543Z",
"updatedAt": "2024-02-25T15:42:11.543Z"
}]}
}
}