-
Notifications
You must be signed in to change notification settings - Fork 31
Expand file tree
/
Copy pathapi.yaml
More file actions
568 lines (567 loc) · 17.2 KB
/
Copy pathapi.yaml
File metadata and controls
568 lines (567 loc) · 17.2 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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
openapi: 3.0.3
tags: []
info:
title: CMU Dining API
description: Hello!~ Thanks for checking out the cmueats api. Have a great day!
version: 2.0.0
paths:
/whoami:
get:
description: If you have an active login session with cmueats, this will return
your user info. (this is NOT intended to work cross-site)
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: object
properties:
user:
nullable: true
anyOf:
- type: object
properties:
googleId:
type: string
id:
type: number
email:
type: string
firstName:
nullable: true
anyOf:
- type: string
- type: "null"
lastName:
nullable: true
anyOf:
- type: string
- type: "null"
pictureUrl:
nullable: true
anyOf:
- type: string
- type: "null"
required:
- googleId
- id
- email
- firstName
- lastName
- pictureUrl
- type: "null"
required:
- user
additionalProperties: false
operationId: getWhoami
/:
get:
responses:
"200":
description: Response for status 200
content:
text/plain:
schema:
examples:
- ScottyLabs Dining API
type: string
operationId: getIndex
/v2/locations:
get:
description: The times array is guaranteed to be sorted and non-overlapping.
Both start and end are inclusive boundaries
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: array
items:
type: object
properties:
times:
type: array
items:
type: object
properties:
start:
examples:
- 1771714397336
type: number
end:
examples:
- 1771714397336
type: number
required:
- start
- end
todaysSoups:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
required:
- name
- description
todaysSpecials:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
required:
- name
- description
name:
nullable: true
anyOf:
- examples:
- Schatz
type: string
- type: "null"
location:
type: string
ratingsAvg:
nullable: true
anyOf:
- type: number
- type: "null"
ratingsCount:
type: number
shortDescription:
nullable: true
anyOf:
- type: string
- type: "null"
description:
type: string
url:
type: string
menu:
nullable: true
anyOf:
- type: string
- type: "null"
coordinateLat:
nullable: true
anyOf:
- type: number
- type: "null"
coordinateLng:
nullable: true
anyOf:
- type: number
- type: "null"
acceptsOnlineOrders:
type: boolean
id:
type: string
conceptId:
nullable: true
anyOf:
- type: string
- type: "null"
required:
- times
- todaysSoups
- todaysSpecials
- name
- location
- ratingsAvg
- ratingsCount
- shortDescription
- description
- url
- menu
- coordinateLat
- coordinateLng
- acceptsOnlineOrders
- id
- conceptId
operationId: getV2Locations
/emails:
get:
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
example: Alice
type: string
email:
example: alice72@andrew.cmu.edu
type: string
required:
- name
- email
operationId: getEmails
/report:
post:
description: Endpoint for reporting errors in information
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
locationId:
type: string
message:
minLength: 1
maxLength: 512
type: string
required:
- locationId
- message
application/x-www-form-urlencoded:
schema:
type: object
properties:
locationId:
type: string
message:
minLength: 1
maxLength: 512
type: string
required:
- locationId
- message
multipart/form-data:
schema:
type: object
properties:
locationId:
type: string
message:
minLength: 1
maxLength: 512
type: string
required:
- locationId
- message
operationId: postReport
/v2/locations/{locationId}/reviews/summary:
get:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: object
properties:
starData:
type: object
properties:
avg:
nullable: true
anyOf:
- type: number
- type: "null"
personalRating:
nullable: true
anyOf:
- type: number
- type: "null"
buckets:
example:
- 0
- 1
- 0
- 4
- 12
- 4
description: Count of ratings of star rating
[{.5},{1,1.5},{2,2.5},{3,3.5},{4,4.5},{5}]
type: array
items:
type: number
required:
- avg
- personalRating
- buckets
tagData:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
totalVotes:
type: number
totalLikes:
type: number
myReview:
nullable: true
anyOf:
- type: object
properties:
vote:
type: boolean
text:
nullable: true
anyOf:
- type: string
- type: "null"
createdAt:
type: number
updatedAt:
type: number
required:
- vote
- text
- createdAt
- updatedAt
- type: "null"
required:
- id
- name
- totalVotes
- totalLikes
- myReview
required:
- starData
- tagData
additionalProperties: false
operationId: getV2LocationsByLocationIdReviewsSummary
/v2/locations/{locationId}/reviews/stars/me:
put:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
stars:
minimum: 0.5
maximum: 5
multipleOf: 0.5
type: number
required:
- stars
application/x-www-form-urlencoded:
schema:
type: object
properties:
stars:
minimum: 0.5
maximum: 5
multipleOf: 0.5
type: number
required:
- stars
multipart/form-data:
schema:
type: object
properties:
stars:
minimum: 0.5
maximum: 5
multipleOf: 0.5
type: number
required:
- stars
operationId: putV2LocationsByLocationIdReviewsStarsMe
delete:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
operationId: deleteV2LocationsByLocationIdReviewsStarsMe
/v2/locations/{locationId}/reviews/tags/{tagId}/me:
put:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
- name: tagId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
voteUp:
nullable: true
anyOf:
- type: boolean
- type: "null"
text:
nullable: true
anyOf:
- maxLength: 1000
type: string
- type: "null"
required:
- voteUp
- text
application/x-www-form-urlencoded:
schema:
type: object
properties:
voteUp:
nullable: true
anyOf:
- type: boolean
- type: "null"
text:
nullable: true
anyOf:
- maxLength: 1000
type: string
- type: "null"
required:
- voteUp
- text
multipart/form-data:
schema:
type: object
properties:
voteUp:
nullable: true
anyOf:
- type: boolean
- type: "null"
text:
nullable: true
anyOf:
- maxLength: 1000
type: string
- type: "null"
required:
- voteUp
- text
operationId: putV2LocationsByLocationIdReviewsTagsByTagIdMe
/v2/locations/{locationId}/reviews/tags:
get:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: array
items:
type: object
properties:
writtenReview:
type: string
tagName:
type: string
id:
type: number
tagId:
type: number
userId:
type: number
locationId:
type: string
vote:
type: boolean
createdAt:
type: number
updatedAt:
type: number
required:
- writtenReview
- tagName
- id
- tagId
- userId
- locationId
- vote
- createdAt
- updatedAt
operationId: getV2LocationsByLocationIdReviewsTags
/v2/locations/{locationId}/reports:
get:
parameters:
- name: locationId
in: path
required: true
schema:
type: string
responses:
"200":
description: Response for status 200
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: number
userId:
nullable: true
anyOf:
- type: number
- type: "null"
createdAt:
anyOf:
- type: Date
- format: date-time
type: string
- format: date
type: string
- type: number
locationId:
type: string
message:
type: string
required:
- id
- userId
- createdAt
- locationId
- message
operationId: getV2LocationsByLocationIdReports
components:
schemas: {}