DipAdvisor_API/endpoints.json at main · Wiggy93/DipAdvisor_API · GitHub

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
{
  "GET /api/locations": {
    "Description": "Returns a list of all locations.",
    "Queries": "dangerous (boolean) public (boolean).",
    "Response body": {
      "locations": [
        {
          "_id": 1,
          "location_name": "Agden Resevoir",
          "coordinates": [],
          "created_by": "Mitchel",
          "image_urls": [
            "https://fastly.picsum.photos/id/125/1500/1000.jpg?hmac=s6pniw6JFp6F753Ow9mnVAVqt8tOcP8ZlZE5-aJ22co"
          ],
          "votes": 0,
          "comments": [],
          "description": "A water storage resevoir 6.5 miles west of Sheffield.",
          "public": true,
          "dangerous": false,
          "created_at": "2023-02-23T09:26:05.040Z",
          "__v": 0
        }
      ]
    }
  },

  "GET /api/locations/:location_id": {
    "Description": "Returns a single location.",
    "Response body": {
      "location": [
        {
          "_id": 1,
          "location_name": "Agden Resevoir",
          "coordinates": [],
          "created_by": "Mitchel",
          "image_urls": [
            "https://fastly.picsum.photos/id/125/1500/1000.jpg?hmac=s6pniw6JFp6F753Ow9mnVAVqt8tOcP8ZlZE5-aJ22co"
          ],
          "votes": 0,
          "comments": [],
          "description": "A water storage resevoir 6.5 miles west of Sheffield.",
          "public": true,
          "dangerous": false,
          "created_at": "2023-02-23T09:26:05.040Z",
          "__v": 0
        }
      ]
    },
    "Request body example": ""
  },
  "PATCH /api/locations/:location_id": {
    "Description": "Change the details of a location",
    "Request body": "Any valid field from the location schema",
    "Response body": {
      "location": {
        "_id": 1,
        "location_name": "Agden Resevoir",
        "coordinates": [],
        "created_by": "Mitchel",
        "image_urls": [
          "https://fastly.picsum.photos/id/125/1500/1000.jpg?hmac=s6pniw6JFp6F753Ow9mnVAVqt8tOcP8ZlZE5-aJ22co"
        ],
        "votes": 0,
        "comments": [],
        "description": "A water storage resevoir 6.5 miles west of Sheffield.",
        "public": true,
        "dangerous": false,
        "created_at": "2023-02-23T09:26:05.040Z",
        "__v": 0
      }
    }
  },
  "POST /api/locations": {
    "Description": "Adds a new location.",
    "Request body": "An object with keys of location_name, created_by, description and public",
    "Response body example": {
      "location": {
        "_id": 1,
        "location_name": "Agden Resevoir",
        "coordinates": [],
        "created_by": "Mitchel",
        "image_urls": [
          "https://fastly.picsum.photos/id/125/1500/1000.jpg?hmac=s6pniw6JFp6F753Ow9mnVAVqt8tOcP8ZlZE5-aJ22co"
        ],
        "votes": 0,
        "comments": [],
        "description": "A water storage resevoir 6.5 miles west of Sheffield.",
        "public": true,
        "dangerous": false,
        "created_at": "2023-02-23T09:26:05.040Z",
        "__v": 0
      }
    }
  },
  "GET /api": {
    "Description": "Returns all of the endpoints.",
    "Response body example": "All endpoints on a key of endpoint"
  },
  "ENDPOINT PROFORMA": {
    "Description": "",
    "Queries": "",
    "Response body example": "",
    "Request body example": ""
  }
}