forked from Technigo/project-express-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.json
More file actions
244 lines (243 loc) · 5.7 KB
/
swagger.json
File metadata and controls
244 lines (243 loc) · 5.7 KB
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
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Netflix details about Movies and TV-shows"
},
"host": "project-express-api-g54dl7acxq-lz.a.run.app",
"basePath": "/",
"schemes": [
"https"
],
"paths": {
"/": {
"get": {
"description": "Index route - displays all endpoints",
"produces": [
"text/plain"
],
"responses": {
"200": {
"description": "All endpoints displayed succesful"
}
}
}
},
"/titles": {
"get": {
"tags": ["Titles"],
"description": "Returns the full data for all titles, with queries to limit the search result",
"produces": [
"application/json"
],
"parameters": [
{
"name": "page",
"in":"query",
"description": "Page number",
"required": false,
"type": "integer"
},
{
"name": "size",
"in":"query",
"description": "Amount of search results on page",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"500": {
"description": "Something went wrong"
}
}
}
},
"/titles/genres/{genres}": {
"get": {
"tags": ["Titles"],
"description": "Returns titles based on genres",
"produces": [
"application/json"
],
"parameters": [
{
"name": "genres",
"in":"path",
"description": "Listed in genre",
"required": false,
"type": "string",
"enum": [
"International TV Shows",
"Korean TV Shows",
"Romantic TV Shows",
"Kids' TV",
"Crime TV Shows",
"Spanish-Language TV Shows",
"Reality TV",
"TV Comedies",
"Docuseries",
"Anime Series",
"Stand-Up Comedy & Talk Shows",
"TV Dramas",
"TV Mysteries",
"Documentaries",
"International Movies",
"Comedies",
"Dramas",
"Independent Movies",
"Thrillers",
"Action & Adventure",
"Children & Family Movies",
"Romantic Movies"
]
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"404": {
"description": "Genre not found"
}
}
}
},
"/titles/country/{country}": {
"get": {
"tags": ["Titles"],
"description": "Returns titles based on country",
"produces": [
"application/json"
],
"parameters": [
{
"name": "country",
"in":"path",
"description": "filtered based on country",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"404": {
"description": "No match for that country"
}
}
}
},
"/titles/id/{id}": {
"get": {
"tags": ["Titles"],
"description": "Returns specific title based on ID",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in":"path",
"description": "Find specific id",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"404": {
"description": "Title id not found"
}
}
}
},
"/titles/movies": {
"get": {
"tags": ["Movies"],
"description": "Data filtered to show all Movies, query to search for Movie based on released year",
"produces": [
"application/json"
],
"parameters": [
{
"name": "year",
"in":"query",
"description": "Year released",
"required": false,
"type": "integer"
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"404": {
"description": "Not found"
}
}
}
},
"/titles/tv-shows": {
"get": {
"tags": ["TV Shows"],
"description": "Data filtered to show all TV shows. Queries to filter on year, seasons, genres",
"produces": [
"application/json"
],
"parameters": [
{
"name": "year",
"in":"query",
"description": "Year released",
"required": false,
"type": "integer"
},
{
"name": "seasons",
"in":"query",
"description": "Amount of seasons, example 2 Seasons",
"required": false,
"type": "string"
},
{
"name": "genres",
"in":"query",
"description": "Listed in genre",
"required": false,
"type": "string",
"enum": [
"International TV Shows",
"Korean TV Shows",
"Romantic TV Shows",
"Kids' TV",
"Crime TV Shows",
"Spanish-Language TV Shows",
"Reality TV",
"TV Comedies",
"Docuseries",
"Anime Series",
"Stand-Up Comedy & Talk Shows",
"TV Dramas",
"TV Mysteries"
]
}
],
"responses": {
"200": {
"description": "Data returned successfully"
},
"404": {
"description": "Not found"
}
}
}
}
}
}