-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
231 lines (231 loc) · 6.07 KB
/
swagger.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
{
"swagger" : "2.0",
"info" : {
"description" : "This is a Review API for Atelier e-commerse shop.",
"version" : "1.0.0",
"title" : "Review API",
"contact" : {
"email" : "sejin.maxine@gmail.com"
}
},
"schemes" : [ "http" ],
"host" : "54.90.132.109",
"basePath" : "/reviews",
"tags" : [ {
"name" : "reviews",
"description" : "Operations available to all users"
} ],
"paths" : {
"/" : {
"get" : {
"tags" : [ "reviews" ],
"summary" : "Search reviews",
"description" : "By passing in the appropriate options, you can search for\nregistered reviews to given product-id in the system\n",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "query",
"name" : "product_id",
"description" : "pass `product-id` for looking up reviews to given product-id",
"required" : true,
"type" : "integer"
}, {
"in" : "query",
"name" : "page",
"description" : "number of records to skip for pagination",
"type" : "integer"
}, {
"in" : "query",
"name" : "count",
"description" : "number of records to return",
"type" : "integer"
} ],
"responses" : {
"200" : {
"description" : "search results matching product-id",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Reviews"
}
}
},
"404" : {
"description" : "bad input parameter"
}
}
},
"post" : {
"tags" : [ "reviews" ],
"summary" : "Add new review to database",
"description" : "adds new review to database",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "review",
"description" : "new review object to add",
"schema" : {
"$ref" : "#/definitions/NewReview"
}
} ],
"responses" : {
"201" : {
"description" : "review created"
},
"400" : {
"description" : "invalid input, object invalid"
}
}
}
}
},
"definitions" : {
"Reviews" : {
"type" : "object",
"required" : [ "product", "page", "count", "results" ],
"properties" : {
"product" : {
"type" : "integer",
"example" : 59556
},
"page" : {
"type" : "integer",
"example" : 0
},
"count" : {
"type" : "integer",
"example" : 5
},
"results" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Review"
}
}
}
},
"Review" : {
"type" : "object",
"required" : [ "product_id" ],
"properties" : {
"_id" : {
"type" : "string",
"example" : "61de37530278bfe503a2b276"
},
"body" : {
"type" : "string",
"example" : "I really did or did not like this product based on whether it was sustainably sourced. Then I found out that its made from nothing at all."
},
"date" : {
"type" : "string",
"format" : "date-time",
"example" : "2020-07-30T03:41:21.467Z"
},
"helpfulness" : {
"type" : "integer",
"example" : 8
},
"photos" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Photo"
}
},
"product_id" : {
"type" : "integer",
"example" : 59556
},
"rating" : {
"type" : "integer",
"example" : 5
},
"recommend" : {
"type" : "boolean",
"example" : true
},
"reported" : {
"type" : "boolean",
"example" : false
},
"response" : {
"type" : "string",
"example" : "Thank you for the great review!"
},
"review_id" : {
"type" : "integer",
"example" : 578413
},
"reviewer_email" : {
"type" : "string",
"example" : "Davion59@gmail.com"
},
"reviewer_name" : {
"type" : "string",
"example" : "Alverta"
},
"summary" : {
"type" : "string",
"example" : "This product was ok!"
}
}
},
"NewReview" : {
"type" : "object",
"required" : [ "product_id" ],
"properties" : {
"product_id" : {
"type" : "integer",
"example" : 59556
},
"name" : {
"type" : "string",
"example" : "Alverta"
},
"email" : {
"type" : "string",
"example" : "Davion59@gmail.com"
},
"recommend" : {
"type" : "boolean",
"example" : true
},
"summary" : {
"type" : "string",
"example" : "This product was ok!"
},
"body" : {
"type" : "string",
"example" : "I really did or did not like this product based on whether it was sustainably sourced. Then I found out that its made from nothing at all."
},
"rating" : {
"type" : "integer",
"example" : 5
},
"photos" : {
"type" : "array",
"items" : {
"example" : "https://ucarecdn.com/f1f74d13-d6fb-410d-881b-abbb552f8c80/OlaSittingontheFloor.svg"
}
},
"characteristics" : {
"type" : "object",
"example" : {
"2761908" : 2,
"2761910" : 3,
"2761911" : 1,
"2761909" : 4
}
}
}
},
"Photo" : {
"type" : "object",
"properties" : {
"url" : {
"type" : "string",
"example" : "https://ucarecdn.com/f1f74d13-d6fb-410d-881b-abbb552f8c80/OlaSittingontheFloor.svg"
}
}
}
}
}