-
Notifications
You must be signed in to change notification settings - Fork 1
/
endpoints.json
187 lines (187 loc) · 5.11 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
{
"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",
"queries": [],
"exampleResponse": {
"topics": [{ "slug": "football", "description": "Footie!" }]
}
},
"GET /api/articles": {
"description": "serves an array of all the articles",
"queries": ["author", "topic", "sort_by", "order", "search"],
"exampleResponse": {
"articles": [
{
"article_id": 2,
"title": "Seafood substitutions are increasing",
"topic": "cooking",
"author": "weegembump",
"body": "Text from the article..",
"created_at": 1527695953341,
"votes": 5,
"comment_count": 7
}
]
}
},
"GET /api/articles/:article_id": {
"description": "serves an array of the specified article by article_id",
"queries": [],
"exampleResponse": {
"article": [
{
"article_id": 2,
"title": "Seafood substitutions are increasing",
"topic": "cooking",
"author": "weegembump",
"body": "Text from the article..",
"created_at": 1527695953341,
"votes": 5,
"comment_count": 7
}
]
}
},
"GET /api/articles/:article_id/comments": {
"description": "serves an array of all comments for a specified article_id",
"queries": ["sort_by"],
"exampleResponse": {
"comments": [
{
"comment_id": 2,
"votes": 3,
"created_at": 1527695953341,
"author": "weegembump",
"body": "Comment text from a comment linked to an article by article_id"
}
]
}
},
"GET /api/users": {
"description": "serves an array of all users",
"queries": [],
"exampleResponse": {
"users": [
{
"username": "weegembump"
}
]
}
},
"GET /api/users/:username": {
"description": "serves an array of the specified user by username",
"queries": [],
"exampleResponse": {
"user": [
{
"username": "weegembump",
"avatar_url": "https://www.link.com/avatar_link.png",
"name": "Users name"
}
]
}
},
"POST /api/articles": {
"description": "posts a new article as an array into the database",
"queries": [],
"exampleResponse": {
"article": [
{
"article_id": 27,
"title": "This is a new article title",
"topic": "cooking",
"author": "rogersop",
"body": "Text from the article...",
"created_at": 1527695953341,
"votes": 5,
"comment_count": 7
}
]
}
},
"POST /api/articles/:article_id/comments": {
"description": "posts a new comment to an article by specified article_id",
"queries": [],
"exampleResponse": {
"newComment": [
{
"comment_id": 29,
"body": "This is a new comment!",
"votes": 0,
"author": "userA",
"article_id": 3,
"created_at": 1527695953341
}
]
}
},
"POST /api/topics": {
"description": "posts a new topic to the database",
"queries": [],
"exampleResponse": {
"topic": [
{
"slug": "Topic title",
"description": "Description of new topic title here"
}
]
}
},
"POST /api/users": {
"description": "posts a new user to the database",
"queries": [],
"exampleResponse": {
"user": [
{
"username": "username",
"name": "User's name",
"avatar_url": "https://www.link.com/avatar_link.png"
}
]
}
},
"PATCH /api/articles/:article_id": {
"description": "patches/updates an existing article by article_id and increases/decreases the votes property by the specified amount",
"queries": [],
"exampleResponse": {
"article": [
{
"article_id": 1,
"title": "Living in the shadow of a great man",
"topic": "mitch",
"author": "butter_bridge",
"body": "I find this existence challenging",
"created_at": "2020-07-08T23:00:00.000Z",
"votes": 101
}
]
}
},
"PATCH /api/comments/:comment_id": {
"description": "patches/updates an existing comment by comment_id and increases/decreases the votes property by the specified amount",
"queries": [],
"exampleResponse": {
"comment": [
{
"comment_id": 1,
"body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
"votes": 17,
"author": "butter_bridge",
"article_id": 9,
"created_at": "2020-04-05T23:00:00.000Z"
}
]
}
},
"DELETE /api/comments/:comment_id": {
"description": "deletes a specified comment by comment_id from the database - no response sent",
"queries": []
},
"DELETE /api/articles/:article_id": {
"description": "deletes a specified article by article_id from the database - no response send",
"queries": []
}
}