-
Notifications
You must be signed in to change notification settings - Fork 1
/
ergast-openapi-doc.yaml
589 lines (576 loc) · 16.1 KB
/
ergast-openapi-doc.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
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
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
openapi: 3.0.2
info:
title: Ergast F1 DB OpenAPI Spec
description: "This is a *partial* definition of the [Ergast F1 API](https://ergast.com/mrd/) in the OpenAPI 3.0 specification.\
\ Of the the endpoints that are implemented here, the url paths and return data schemas are structured\
\ to match the structure currently used on the live Ergast API.\n\n \
\ You should be able to use the as a starting\
\ point for [generating your client libraries](https://github.com/OpenAPITools/openapi-generator) for use with Ergast, or setting up your own API to use with a copy\
\ of the Ergast DB.\
\ \n\nSome notes:\n\n - This only defines the JSON data schema, not the XML version of the API return data\n\
- Outside of the year, most of the inline parameters used by the Ergast API are not defined here. \n
- The placeholder values for year are not currently implemented."
contact:
name: Contact the Developer
url: http://github.com/adampax
license:
name: This OpenAPI definition is under MIT License
url: https://opensource.org/licenses/MIT
version: 1.1.0
externalDocs:
description: The Ergast Developer API
url: https://ergast.com/mrd/
servers:
- url: https://ergast.com/api/f1
tags:
- name: Constructors
externalDocs:
description: Ergast Docs
url: https://ergast.com/mrd/methods/constructors/
- name: Drivers
externalDocs:
description: Ergast Docs
url: https://ergast.com/mrd/methods/drivers/
- name: Results
externalDocs:
description: Race Results
url: https://ergast.com/mrd/methods/results/
- name: Schedule
externalDocs:
description: Race Schedule
url: https://ergast.com/mrd/methods/schedule/
paths:
/{year}/constructors.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Constructors
description: ""
operationId: getConstructorsByYear
parameters:
- $ref: '#/components/parameters/yearParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ConstructorsByYearResponse"
/{year}/constructorStandings.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Constructors
description: ""
operationId: getConstructorStandingsByYear
parameters:
- $ref: '#/components/parameters/yearParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ConstructorStandingsByYearResponse"
/{year}/driverStandings.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Drivers
description: ""
operationId: getDriverStandingsByYear
parameters:
- $ref: '#/components/parameters/yearParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/DriverStandingsByYearResponse"
/{year}/results.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Results
description: ""
operationId: getResultsByYear
parameters:
- $ref: '#/components/parameters/yearParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ResultsByYearResponse"
/{year}/constructors/{constructorId}/results.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Results
description: ""
operationId: getResultsByYearAndConstructor
parameters:
- $ref: '#/components/parameters/yearParam'
- $ref: '#/components/parameters/constructorParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ResultsByYearResponse"
/{year}/{round}/results.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Results
description: ""
operationId: getResultsByYearAndRound
parameters:
- $ref: '#/components/parameters/yearParam'
- $ref: '#/components/parameters/roundParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/ResultsByYearResponse"
/{year}.json:
parameters:
- $ref: '#/components/parameters/offsetParam'
- $ref: '#/components/parameters/limitParam'
get:
tags:
- Schedule
description: ""
operationId: getSeasonByYear
parameters:
- $ref: '#/components/parameters/yearParam'
responses:
200:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/SeasonByYearResponse"
components:
schemas:
Circuit:
type: object
properties:
circuitId:
type: string
example: yas_marina
round:
type: string
example: 21
url:
type: string
example: http://en.wikipedia.org/wiki/Yas_Marina_Circuit
circuitName:
type: string
example: Yas Marina Circuit
Location:
type: object
properties:
lat:
type: string
example: 24.4672
long:
type: string
example: 54.6031
locality:
type: string
example: Abu Dhabi
country:
type: string
example: UAE
Constructor:
type: object
properties:
constructorId:
type: string
example: mercedes
url:
type: string
example: http://en.wikipedia.org/wiki/Mercedes-Benz_in_Formula_One
name:
type: string
example: Mercedes
nationality:
type: string
example: German
Driver:
type: object
properties:
driverId:
type: string
example: hamilton
permanentNumber:
type: string
example: 44
code:
type: string
example: HAM
url:
type: string
example: http://en.wikipedia.org/wiki/Lewis_Hamilton
givenName:
type: string
example: Lewis
familyName:
type: string
example: Hamilton
dateOfBirth:
type: string
example: "1985-01-07"
nationality:
type: string
example: British
Race:
type: object
properties:
season:
type: string
example: 2019
round:
type: string
example: 21
url:
type: string
example: https://en.wikipedia.org/wiki/2019_Abu_Dhabi_Grand_Prix
raceName:
type: string
example: Abu Dhabi Grand Prix
Circuit:
type: object
$ref: "#/components/schemas/Circuit"
date:
type: string
example: "2019-12-01"
time:
type: string
example: "13:10:00Z"
Results:
type: array
items:
$ref: '#/components/schemas/Result'
Result:
type: object
properties:
number:
type: string
example: 44
position:
type: string
example: 1
positionText:
type: string
example: 1
points:
type: string
example: 26
Driver:
type: object
$ref: "#/components/schemas/Driver"
Constructor:
type: object
$ref: "#/components/schemas/Constructor"
grid:
type: string
example: 1
laps:
type: string
example: 55
status:
type: string
example: Finished
Time:
type: object
properties:
millis:
type: string
example: 5645715
time:
type: string
example: '1:34:05.715'
FastestLap:
type: object
properties:
rank:
type: string
example: 1
lap:
type: string
example: 53
Time:
type: object
properties:
time:
type: string
example: '1:39.283'
AverageSpeed:
type: object
properties:
units:
type: string
example: kph
speed:
type: string
example: 201.387
ConstructorsByYearResponse:
type: object
properties:
MRData:
type: object
properties:
xmlns:
type: string
series:
type: string
url:
type: string
limit:
type: string
example: 30
offset:
type: string
example: 0
total:
type: string
example: 20
ConstructorTable:
type: object
properties:
season:
type: string
Constructors:
type: array
items:
$ref: '#/components/schemas/Constructor'
ConstructorStandingsByYearResponse:
type: object
properties:
MRData:
type: object
properties:
xmlns:
type: string
series:
type: string
url:
type: string
limit:
type: string
example: 30
offset:
type: string
example: 0
total:
type: string
example: 20
StandingsTable:
type: object
properties:
season:
type: string
StandingsLists:
type: array
items:
type: object
properties:
season:
type: string
round:
type: string
ConstructorStandings:
type: array
items:
type: object
properties:
position:
type: string
positionText:
type: string
points:
type: string
wins:
type: string
Constructor:
type: object
$ref: '#/components/schemas/Constructor'
DriverStandingsByYearResponse:
type: object
properties:
MRData:
type: object
properties:
xmlns:
type: string
series:
type: string
url:
type: string
limit:
type: string
example: 30
offset:
type: string
example: 0
total:
type: string
example: 20
StandingsTable:
type: object
properties:
season:
type: string
StandingsLists:
type: array
items:
type: object
properties:
season:
type: string
round:
type: string
DriverStandings:
type: array
items:
type: object
properties:
position:
type: string
positionText:
type: string
points:
type: string
wins:
type: string
Driver:
type: object
$ref: '#/components/schemas/Driver'
Constructors:
type: array
items:
$ref: '#/components/schemas/Constructor'
ResultsByYearResponse:
type: object
properties:
MRData:
type: object
properties:
xmlns:
type: string
series:
type: string
url:
type: string
limit:
type: string
example: 30
offset:
type: string
example: 0
total:
type: string
example: 20
RaceTable:
type: object
properties:
season:
type: string
round:
type: string
description: Only returned if round parameter used
Races:
type: array
items:
$ref: '#/components/schemas/Race'
SeasonByYearResponse:
properties:
MRData:
type: object
properties:
xmlns:
type: string
series:
type: string
url:
type: string
limit:
type: string
example: 30
offset:
type: string
example: 0
total:
type: string
example: 20
RaceTable:
type: object
properties:
season:
type: string
Races:
type: array
items:
$ref: '#/components/schemas/Race'
parameters:
offsetParam:
in: query
name: offset
required: false
schema:
type: integer
minimum: 0
description: The number of items to skip before starting to collect the result set.
limitParam:
in: query
name: limit
required: false
schema:
type: integer
minimum: 1
maximum: 1000
default: 30
description: The numbers of items to return.
constructorParam:
name: constructorId
in: path
description: "Limit results to this constructor"
required: true
schema:
type: string
example: mercedes
yearParam:
name: year
in: path
description: "Year in question"
required: true
schema:
type: string
example: 2019
roundParam:
name: round
in: path
description: "Round in question"
required: true
schema:
type: string
example: 1