Skip to content

An OpenAPI Schema for the Ergast Formula 1 API

License

Notifications You must be signed in to change notification settings

adampax/ergast-f1-openapi-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

ergast-f1-openapi-doc

An OpenAPI Schema for the Ergast Formula 1 API

About

This is a partial definition of the Ergast F1 API 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.

You should be able to use the as a starting point for generating your client libraries for use with Ergast, or setting up your own API to use with a copy of the Ergast DB.

Notes:

  • This only defines the JSON data schema, not the XML version of the API return data
  • Outside of the year, most of the inline parameters used by the Ergast API are not defined here.
  • The placeholder values for year are not implemented.

License:

About

An OpenAPI Schema for the Ergast Formula 1 API

Topics

Resources

License

Stars

Watchers

Forks