This repository has been archived by the owner on Dec 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
294 lines (294 loc) · 9.11 KB
/
openapi.yaml
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
openapi: 3.0.2
info:
title: Apollo
version: '0'
description: Generates bus routes
contact:
name: Neel Kamath
email: neelkamath@icloud.com
url: https://github.com/neelkamath/apollo-prototype
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://apollo-prototype.herokuapp.com
description: This is a temporary development server which may be offline or serving a different API in the future.
paths:
/tag:
get:
tags: [tag]
description: Gets all tags
operationId: getTags
responses:
200:
$ref: '#/components/responses/TagsResponse'
post:
tags: [tag]
description: Create a tag
operationId: createTag
requestBody:
content:
application/json:
example:
tag: 2nd Semester
schema:
type: object
properties:
tag:
type: string
required: [tag]
responses:
204:
description: Created tag
delete:
tags: [tag]
description: Delete tag
operationId: deleteTag
requestBody:
content:
application/json:
example:
tag: 2nd Semester
schema:
type: object
properties:
tag:
type: string
required: [tag]
responses:
204:
description: Tag deleted
/user:
get:
tags: [user]
description: Gets all users
operationId: getUsers
responses:
200:
$ref: '#/components/responses/UsersResponse'
post:
tags: [user]
description: Create a user
operationId: createUser
requestBody:
content:
application/json:
example:
name: Neel Kamath
id: PES2201800467
address: 311/3, 23rd Cross, 2nd Main, 6th Block, Jayanagar, Bangalore, Karnataka, India
longitude: 77.6727
latitude: 12.8458
tags: [2nd Year, CSE]
schema:
type: object
properties:
name:
type: string
id:
type: string
address:
type: string
longitude:
type: number
latitude:
type: number
tags:
type: array
items:
type: string
required: [name, id, tags, address, longitude, latitude]
responses:
204:
description: Created user
delete:
tags: [user]
description: Delete user
operationId: deleteUser
requestBody:
content:
application/json:
example:
id: PES2201800467
schema:
type: object
properties:
id:
type: string
required: [id]
responses:
204:
description: User deleted
/generate:
post:
tags: [generate]
description: Generate bus routes
operationId: generateRoute
requestBody:
content:
application/json:
example:
address: PESU, Electronic City Campus
longitude: 77.6727
latitude: 12.8458
tags: [CSE, 2nd Semester]
schema:
type: object
properties:
address:
description: The address of the college, etc. the buses are being driven to
type: string
longitude:
description: The longitude of the college, etc. the buses are being driven to
type: number
latitude:
description: The latitude of the college, etc. the buses are being driven to
type: number
tags:
description: The bus routes will be generated only for people having these tags.
type: array
items:
type: string
required: [tags, address, longitude, latitude]
responses:
200:
description: Generated routes
content:
application/json:
example:
routes:
- route: 1
passengers:
- id: PES2201800467
longitude: 77.56029
latitude: 12.97021
proximity: CLOSE
schema:
type: object
properties:
routes:
type: array
items:
type: object
properties:
route:
type: integer
description: Route number
passengers:
type: array
description: Passengers of this vehicle's route
items:
type: object
properties:
id:
type: string
description: Passenger's ID
longitude:
type: number
description: The longitude of the passenger's residence
latitude:
type: number
description: The latitude of the passenger's residence
proximity:
type: string
enum: [CLOSE, NORMAL, FAR]
description:
Whether the passenger's residence is a `"CLOSE"`, `"NORMAL"`, or `"FAR"` distance from
the institute
required: [id, longitude, latitude, proximity]
required: [route, passengers]
required: [routes]
/eta:
post:
tags: [eta]
description: The estimated time of arrival
operationId: eta
requestBody:
content:
application/json:
example:
current_longitude: 77.610995
current_latitude: 12.97
destination_longitude: 77.6727
destination_latitude: 12.8458
schema:
type: object
properties:
current_longitude:
type: number
description: Longitude of the place they are currently in
current_latitude:
type: number
description: Latitude of the place they are currently in
destination_longitude:
type: number
description: Longitude of the destination
destination_latitude:
type: number
description: Latitude of the destination
required: [current_longitude, current_latitude, destination_longitude, destination_latitude]
responses:
200:
description: ETA
content:
application/json:
schema:
type: object
example:
eta: 135
properties:
eta:
type: number
description: Number of seconds to destination
required: [eta]
components:
responses:
TagsResponse:
description: Every tag
content:
application/json:
schema:
example:
tags: [CSE, 3rd Semester, 7th Semester, ME]
type: object
properties:
tags:
type: array
items:
type: string
required: [tags]
UsersResponse:
description: Every user
content:
application/json:
schema:
example:
users:
- name: Neel Kamath
id: PES2201800467
address: 311/3, 23rd Cross, 2nd Main, 6th Block, Jayanagar, Bangalore, Karnataka, India
longitude: 77.6727
latitude: 12.8458
tags: [CSE, 2nd Year]
properties:
users:
type: array
items:
type: object
properties:
name:
type: string
id:
type: string
address:
type: string
longitude:
type: number
latitude:
type: number
tags:
type: array
items:
type: string
required: [name, id, tags, address, longitude, latitude]
required: [users]