-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
311 lines (311 loc) · 8.61 KB
/
swagger.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
swagger: '2.0'
info:
title: Beaver Bus API
description: Get Corvallis campus bus routes, stops, ETAs, and current GPS locations.
version: '1.0'
license:
name: GNU Affero General Public License Version 3
url: http://www.gnu.org/licenses/agpl-3.0.en.html
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/beaver-bus-api
schemes:
- https
host: api.oregonstate.edu
basePath: /v1/beaverbus
produces:
- application/json
security:
- OAuth2:
- full
paths:
/routes:
get:
description: "Get bus routes."
operationId: getRoutes
parameters:
- $ref: '#/parameters/pretty'
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/RoutesResultObject'
/routes/{routeID}:
get:
description: "Get bus route by routeID"
operationId: getRouteByID
parameters:
- in: path
name: routeID
required: true
description: "routeID for route"
type: string
- $ref: '#/parameters/pretty'
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/RouteResultObject'
404:
description: Route not found
schema:
$ref: "#/definitions/Error"
/vehicles:
get:
description: "Get current locations of vehicles"
operationId: getVehicles
parameters:
- in: query
name: routeID
required: false
description: "Filter by route"
type: string
- $ref: '#/parameters/pretty'
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/VehiclesResultObject'
/vehicles/{vehicleID}:
get:
description: "Get current location of a vehicle by vehicleID"
operationId: getVehicleByID
parameters:
- in: path
name: vehicleID
required: true
description: "vehicleID for vehicle"
type: string
- $ref: '#/parameters/pretty'
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/VehicleResultObject'
404:
description: Vehicle not found
schema:
$ref: "#/definitions/Error"
/arrivals:
get:
description: Get arrival times for stops
operationId: getArrivals
parameters:
- in: query
name: routeID
required: false
description: "Filter by routeID"
type: string
- in: query
name: stopId
required: false
description: "Filter by stopID"
type: string
- $ref: '#/parameters/pretty'
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/ArrivalsResultObject'
404:
description: No arrivals match the query
schema:
$ref: "#/definitions/Error"
parameters:
pretty:
name: pretty
in: query
type: boolean
required: false
description: If true, JSON response will be pretty-printed
securityDefinitions:
OAuth2:
type: oauth2
flow: application
tokenUrl: https://api.oregonstate.edu/oauth2/token
scopes:
full: Full access to the API
definitions:
RoutesResultObject:
properties:
data:
type: array
items:
$ref: "#/definitions/RouteResourceObject"
RouteResultObject:
properties:
data:
$ref: "#/definitions/RouteResourceObject"
RouteResourceObject:
properties:
id:
type: string
description: routeID
type:
type: string
description: route
links:
$ref: "#/definitions/SelfLink"
attributes:
properties:
description:
type: string
description: Description of bus route
encodedPolyline:
type: string
description: Encoded polyline for mapping route using Google's mapping APIs
mapColor:
type: string
description: Hexadecimal color value for route line on map
latitude:
type: number
format: float
description: Default latitude to go to when selecting route on map
longitude:
type: number
format: float
description: Default longitude to go to when selecting route on map
zoomLevel:
type: integer
description: Default zoom level to use when selecting route on map
stops:
type: array
description: Locations where the bus stops along the route. Stops are in the order at which they are arrived at.
items:
properties:
stopID:
type: string
description:
type: string
latitude:
type: number
format: float
description: Latitude of stop
longitude:
type: number
format: float
description: Longitude of stop
VehiclesResultObject:
properties:
data:
type: array
items:
$ref: "#/definitions/VehicleResourceObject"
VehicleResultObject:
properties:
data:
$ref: "#/definitions/VehicleResourceObject"
VehicleResourceObject:
properties:
id:
type: string
description: vehicleID
type:
type: string
description: vehicle
links:
$ref: "#/definitions/SelfLink"
attributes:
properties:
routeID:
type: string
description: routeID for route of vehicle
name:
type: string
description: Name of vehicle
latitude:
type: number
format: float
description: Latitude of vehicle's position
longitude:
type: number
format: float
description: Longitude of vehicle's position
speed:
type: number
format: float
description: Speed of vehicle (MPH)
heading:
type: integer
description: Compass heading of vehicle (0-359, where 0 is north)
lastUpdated:
type: string
format: date
description: Time at which vehicle's position was updated
onRoute:
type: boolean
description: Whether the vehicle is on its route
delayed:
type: boolean
description: Whether the vehicle is delayed
ArrivalsResultObject:
properties:
data:
type: array
items:
$ref: "#/definitions/ArrivalResourceObject"
ArrivalResultObject:
properties:
data:
$ref: "#/definitions/ArrivalResourceObject"
ArrivalResourceObject:
properties:
id:
type: string
description: arrivalID
type:
type: string
description: arrival
links:
properties:
route:
type: string
format: url
description: Link to route resource associated with arrival
self:
type: string
format: url
description: Self link of arrival in format /arrivals?routeID=x&stopID=y
attributes:
properties:
routeID:
type: string
description: routeID for route of vehicle
stopID:
type: string
description: Unique identifier for a stop
arrivals:
type: array
description: Times that this route is arriving at this stop
items:
properties:
eta:
type: string
format: date
description: Time and date that route is expected to arrive at stop
vehicleID:
type: string
description: vehicleID of vehicle that is arriving
SelfLink:
properties:
self:
type: string
format: url
description: Self link of resource
Error:
properties:
status:
type: integer
description: HTTP status code.
developerMessage:
type: string
description: An error string aimed at developers.
userMesage:
type: string
description: An error string aimed at end users.
code:
type: integer
description: Error code.
details:
type: string
description: A link to further information about the error.