-
Notifications
You must be signed in to change notification settings - Fork 0
/
endpoints.json
241 lines (241 loc) · 7.23 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
{
"GET /api": {
"description": "Serves up a json representation of all the available endpoints of the API"
},
"GET /api/topics": {
"description": "Serves an array of all topics",
"example response": {
"topics": [{ "slug": "football", "description": "Footie!" }]
}
},
"GET /api/articles": {
"description": "Serves an array of all articles, defaults to ten per page",
"queries": ["sort_by", "author", "title", "comment_count", "topic", "order", "asc", "desc"],
"example response": {
"articles": [
{
"title": "Seafood substitutions are increasing",
"topic": "cooking",
"author": "weegembump",
"created_at": 1527695953341,
"votes": 0
}
]
}
},
"GET /api/articles/:article_id": {
"description": "Serves an article specified by id",
"queries": ["id"],
"example response": {
"article": [
{
"title": "The Rise Of Thinking Machines: How IBM's Watson Takes On The World",
"topic": "coding",
"author": "jessjelly",
"body": "Many people know Watson as the IBM-developed cognitive super computer that won the Jeopardy! gameshow in 2011. In truth, Watson is not actually a computer but a set of algorithms and APIs, and since winning TV fame (and a $1 million prize) IBM has put it to use tackling tough problems in every industry from healthcare to finance. Most recently, IBM has announced several new partnerships which aim to take things even further, and put its cognitive capabilities to use solving a whole new range of problems around the world.",
"created_at": 1589418120000,
"votes": 0
}
]
}
},
"PATCH /api/articles/:article_id": {
"description": "Updates the votes on an article specified by id, or patches the body",
"queries": ["id"],
"example request": {
"inc_votes": 40,
"body": "edited"
},
"example response": {
"article": [
{
"title": "The Rise Of Thinking Machines: How IBM's Watson Takes On The World",
"topic": "coding",
"author": "jessjelly",
"body": "edited",
"created_at": 1589418120000,
"votes": 40
}
]
}
},
"GET /api/articles/:article_id/comments": {
"description": "Serves an array of comments specified by article id",
"queries": ["id", "sort_by", "created_at", "votes"],
"example response": {
"comments": [
{
"body": "Facilis corporis animi et non non minus nisi. Magnam et sequi dolorum fugiat ab assumenda.",
"votes": 12,
"author": "tickle122",
"article_id": 17,
"created_at": 1586387400000
}
]
}
},
"POST /api/articles/:article_id/comments": {
"description": "Adds a comment with reference to article id",
"queries": ["id"],
"example request": {
"username": "tickle122",
"body": "Facilis corporis animi et non non minus nisi. Magnam et sequi dolorum fugiat ab assumenda."
},
"example response": {
"comment": [
{
"body": "Facilis corporis animi et non non minus nisi. Magnam et sequi dolorum fugiat ab assumenda.",
"votes": 0,
"author": "tickle122",
"article_id": 17,
"created_at": 1586387400000
}
]
}
},
"DELETE /api/comments/:comment_id": {
"description": "Deletes a comment specified by id",
"queries": ["id"],
"example response": {
"status": 204,
"msg": "No content"
}
},
"GET /api/users":{
"description": "Serves an array of all users",
"example response": {
"users": [
{
"username": "butter_bridge",
"name": "jonny",
"avatar_url":
"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
},
{
"username": "icellusedkars",
"name": "sam",
"avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
}
]
}
},
"GET /api/users/:username": {
"description": "Serves a user specified by username",
"queries": ["id"],
"example response": {
"user": [
{
"username": "butter_bridge",
"name": "jonny",
"avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
}
]
}
},
"PATCH /api/comments/:comment_id": {
"description": "Updates a comment vote or updates the body of a comment specified by id",
"queries": ["id"],
"example request": {
"inc_votes": "40",
"body": "add comment"
},
"example response": {
"comment": [
{
"body": "add comment",
"votes": 40,
"author": "tickle122",
"article_id": 17,
"created_at": 1586387400000
}
]
}
},
"POST /api/articles": {
"description": "Posts a new article",
"example request": {
"author": "butter_bridge",
"title": "accepts a title",
"body": "accepts a body",
"topic": "existing topic"
},
"example response": {
"comment": {
"article_id": "8",
"title": "accepts a title",
"body": "accepts a body",
"votes": 0,
"topic": "existing topic",
"author": "butter_bridge",
"created_at": 1586387400000,
"comment_count": "0"
}
}
},
"POST /api/topics": {
"description": "Posts a new topic",
"example request": {
"slug": "new topic",
"description": "new topic description"
},
"example response": {
"topic": {
"slug": "new topic",
"description": "new topic description"
}
}
},
"DELETE /api/articles/:article_id": {
"description": "Deletes an article specified by id",
"queries": ["id"],
"example response": {
"status": 204,
"msg": "No content"
}
},
"GET /api/comments/:comment_id": {
"description": "Gets a comment specified by id",
"queries": ["id"],
"example response": {
"comment": {
"comment_id": 1,
"votes": -1,
"created_at": "2020-05-21T23:19:00.000Z",
"author": "tickle122",
"body": "Itaque quisquam est similique et est perspiciatis reprehenderit voluptatem autem. Voluptatem accusantium eius error adipisci quibusdam doloribus."
}
}
},
"PATCH /api/users/:username": {
"description": "Updates a user specified by id",
"queries": ["id"],
"example request": {
"name": "new",
"avatar_url":
"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
},
"example response": {
"user": {
"username": "example_user",
"name": "new",
"avatar_url":
"https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
}
}
},
"POST /api/users": {
"description": "Posts a new user",
"example request": {
"username": "icellusedkars",
"name": "sam",
"avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
},
"example response": {
"user": {
"username": "icellusedkars",
"name": "sam",
"avatar_url": "https://avatars2.githubusercontent.com/u/24604688?s=460&v=4"
}
}
}
}