repo_name
stringlengths
1
62
dataset
stringclasses
1 value
lang
stringclasses
11 values
pr_id
int64
1
20.1k
owner
stringlengths
2
34
reviewer
stringlengths
2
39
diff_hunk
stringlengths
15
262k
code_review_comment
stringlengths
1
99.6k
jolpica-f1
github_2023
python
122
jolpica
jolpica
@@ -35,3 +40,22 @@ def run_data_correction(): entry.is_eligible_for_points = False updated.append(entry) SessionEntry.objects.bulk_update(updated, fields=["position", "is_eligible_for_points"]) + + +def session_correction(): + corrections = { + SessionType.RACE: "16:00:00", + Ses...
I believe this should be called a session not an entry.
jolpica-f1
github_2023
python
122
jolpica
jolpica
@@ -35,3 +40,22 @@ def run_data_correction(): entry.is_eligible_for_points = False updated.append(entry) SessionEntry.objects.bulk_update(updated, fields=["position", "is_eligible_for_points"]) + + +def session_correction(): + corrections = {
Can you please add a 1 line comment to explain why this correct needs to be made (maybe reference its from issue #113 )
jolpica-f1
github_2023
others
85
jolpica
jolpica
@@ -42,6 +42,14 @@ Current requirements are: ``` This will fill the database with the latest data from ergast, and create the initial test database so all future tests will run quicker. +## Running the Server + +To run the server + +```python manage.py runserver 0.0.0.0:8000```
```suggestion ```make run``` ```
jolpica-f1
github_2023
others
85
jolpica
jolpica
@@ -42,6 +42,14 @@ Current requirements are: ``` This will fill the database with the latest data from ergast, and create the initial test database so all future tests will run quicker. +## Running the Server + +To run the server + +```python manage.py runserver 0.0.0.0:8000``` + +This will start Jolpica on port ...
```suggestion This will start jolpica-f1 on port 8000. Once it is running you can access the API via browser, curl or any other tools with `http://localhost:8000/ergast/f1/`. Any changes made to the source code will be automatically updated, while it is running. ```
jolpica-f1
github_2023
others
88
jolpica
jolpica
@@ -1,17 +1,17 @@ # jolpica-f1 Documentation -API for querying formula one data, with backwards compatible endpoints for the soon to be deprecated ergast api. +Jolipica is an open-source API for querying Formula 1 data. It is the successor to the Ergast F1 API, containing backwards compatible endpoints for the soon ...
```suggestion jolpica-f1 is an open-source API for querying Formula 1 data. It is the successor to the Ergast F1 API, containing backwards compatible endpoints for the soon to be deprecated API. ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,178 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors + +**URL** : `/ergast/f1/constructors` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors that participated in a specified seaso...
Not just this endpoint, but the Round parameter is also available for all endpoints. e.g. `/ergast/f1/2024/5/constructors/`, `/ergast/f1/2024/5/driverstandings/`, etc
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,178 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors + +**URL** : `/ergast/f1/constructors`
Small nitpick, all urls need to end with a `/` or `.json` as the framework automatically redirects urls without a `/` or `.` to one with one. So `/ergast/f1/constructors/` or `/ergast/f1/constructors.json`
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,205 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings + +**URL** : `/ergast/f1/{YEAR}/constructorstandings/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*\* + +**Filters f...
```suggestion **Filters for the constructors standings after a specified round in a specific season. Round numbers 1 -> n races are valid as well as `next` and `last`** ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,205 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings + +**URL** : `/ergast/f1/{YEAR}/constructorstandings/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*\* + +**Filters f...
I'm open to suggestions on what it should be, but we should name things consistently, e.g. `round` vs `roundNumber`, `season` vs `YEAR`. For inspiration, this is what the value are called internally. We don't necessarily have to use them https://github.com/jolpica/jolpica-f1/blob/8424ed415102dfa24de5b8a85faf605e9a5...
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,209 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](./README.md#query-parameters)
```suggestion [Available Query Parameters](docs/README.md#query-parameters) ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,209 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a race...
```suggestion [Common Response Fields](docs/README.md#common-response-fields) ``` Link also doesn't work
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,209 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a race...
```suggestion |Field|Always Included| ``` Little nitpick, required just feels more like an ask of the user of the API
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,209 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a race...
```suggestion |circuitId| 🟑 | |url|🟑| |circuitName|βœ…| |Location|🟑| ``` New option of yellow, may be best. We 99% of time provide this, but from a database perspective there could be some times where the fields are missing.
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,209 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a race...
```suggestion ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors that p...
```suggestion `/constructors/{constructorId}/` -> ex: `/ergast/f1/constructors/williams/` ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,205 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*...
```suggestion |position| ❌ | |positonText|βœ…| |points|βœ…| |wins|βœ…| |Constructor|βœ…| Possible values for positionText include: `E` Excluded (2007 McLaren), `D` Disqualified, `-` for ineligible or the position as a string otherwise. ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors that p...
```suggestion |constructorId| 🟑 | |url|🟑| |name|βœ…| |nationality|🟑| ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,215 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](./README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*\* +...
```suggestion |position| ❌ | |positonText|βœ…| |points|βœ…| |wins|βœ…| |Driver|βœ…| |Constructors|βœ…| Possible values for positionText include: `E` Excluded, `D` Disqualified (1997 Schumacher), `-` for ineligible or the position as a string otherwise. ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -13,35 +13,45 @@ Gets list of drivers ### Season -**Filters only drivers that participated in a specified season. Year numbers are valid as is 'current' to get the current season list of drivers** +**Filters only drivers that participated in a specified season. Year numbers are valid as is `current` to get the ...
```suggestion `/drivers/{driverId}/` -> ex: `/ergast/f1/drivers/hamilton/` ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](./RE...
```suggestion |driverId| βœ… | |lap|🟑| |stop|🟑| |time|🟑| |duration|🟑| ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place.
```suggestion Returns a season's constructor standings from first to last place. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion ### Season (required) ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion Filters for the constructors standing of a specified season. Year numbers are valid, as is `current` to get the current season's constructor standings. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId
```suggestion Returns a list of circuits in alphabetical order by `circuitId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters:
```suggestion ## Route Parameters ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters only circuits which hosted a race in a given season. Year numbers are valid as is `current` to get the current season's list of circuits. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion **Note**: To utilize the `season` parameter, it needs to be the first argument after `/ergast/f1/` ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters only for the circuit that hosted the race in the specified round of the specific season. Round numbers 1 -> `n` races are valid as well as `last` and `next`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion **Note**: To utilize the `round` parameter it needs to be used with the `season` filter and be the first argument after `/ergast/f1/{season}`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only the circuit that matches the specified `circuitId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only circuits that the specified constructor has participated in a race at. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only circuits that the specified driver has participated in a race at. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
Nor sure I understand this filter as it is written.
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only circuits that have had a race with a specific grid position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only circuits that have had a race where a specific finishing position was valid. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,207 @@ +[← Documentation Home](/docs/README.md) +# Circuits + +Gets list of circuits in alphabetical order by circuitId + +**URL** : `/ergast/f1/circuits/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only circuits which hosted a ...
```suggestion Filters for only circuits that have had a race where a driver finished with a specific `statusId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion Filters for the constructors standings after a specified round in a specific season. Round numbers 1 -> `n` races are valid as well as `last`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion **Note**: To utilize the `round` parameter it must be combined with a season filter and needs to be the first argument after `/ergast/f1/{season}/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion Filters for only for a specific constructors' standing information for a given year. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,206 @@ +[← Documentation Home](/docs/README.md) +# Constructor Standings + +Gets a season's constructors standings from first to last place. + +**URL** : `/ergast/f1/{season}/constructorstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season ...
```suggestion Filters for only the constructor in a given position in a given year. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId
```suggestion Returns a list of constructors alphabetically by `constructorId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters only constructors that participated in a specified season. Year numbers are valid as is `current` to get the current season list of constructors. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion **Note**: To utilize the `season` parameter it needs to be the first argument after `/ergast/f1/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters only constructors that participated in a specified round of a specific season. Round numbers 1 -> `n` races are valid as well as `last`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion **Note**: To utilize the `round` parameter it needs to be used with the `season` filter and be the first argument after `/ergast/f1/{season}/` ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors who have participated in a race at a given circuit. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only a specified constructor. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors that had a driver race for them. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors that finished a race with a lap that was the ranked in the specified position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors which had a driver racing for them start a race in a specific grid position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors which had a driver racing for them finish a race in a specific position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion Filters for only constructors who had a driver finish a race with a specific `statusId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,188 @@ +[← Documentation Home](/docs/README.md) +# Constructors + +Gets list of constructors alphabetically by constructorId + +**URL** : `/ergast/f1/constructors/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season + +**Filters only constructors th...
```suggestion `MRData.ConstructorTable.Constructors[i]` : A given constructor object. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place.
```suggestion Returns a season's drivers standings from first to last place. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*...
```suggestion Filters for the drivers standing of a specified season. Year numbers are valid as is `current` to get the current seasons drivers standings. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*...
```suggestion Filters for the drivers standings after a specified round in a specific season. Round numbers 1 -> `n` races are valid as well as `last`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*...
```suggestion **Note**: To utilize the `round` parameter it must be combined with a season filter and needs to be the first argument after `/ergast/f1/{season}/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*...
```suggestion Filters for only a specific driver's drivers standing information for a given year. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,216 @@ +[← Documentation Home](/docs/README.md) +# Driver Standings + +Gets a season's drivers standings from first to last place. + +**URL** : `/ergast/f1/{season}/driverstandings/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters: + +### Season \*\*REQUIRED\*...
```suggestion Filters for only the driver in a given position for a given year. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId -**URL** : `/ergast/f1/drivers` +**URL** : `/ergast/f1/drivers/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/READ...
```suggestion Filters only drivers that participated in a specified season. Year numbers are valid as is `current` to get the current season list of drivers. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId
```suggestion Returns a list of drivers in alphabetical order by `driverId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId -**URL** : `/ergast/f1/drivers` +**URL** : `/ergast/f1/drivers/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/READ...
```suggestion Filters only drivers that participated in a specified round of a specific season. Round numbers 1 -> `n` races are valid as well as `last`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId -**URL** : `/ergast/f1/drivers` +**URL** : `/ergast/f1/drivers/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/READ...
```suggestion **Note**: To utilize the `round` parameter it needs to be used with the `season` filter and be the first argument after `/ergast/f1/{season}`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId -**URL** : `/ergast/f1/drivers` +**URL** : `/ergast/f1/drivers/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/READ...
```suggestion Filters for only drivers who have participated in a race at a given circuit. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Drivers -Gets list of drivers +Gets list of drivers in alphabetical order by driverId -**URL** : `/ergast/f1/drivers` +**URL** : `/ergast/f1/drivers/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/READ...
```suggestion Filters for only drivers that match the specific `driverId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -50,7 +60,7 @@ Gets list of drivers **Filters for only drivers that finished a race with a lap that was the ranked in the specified position**
```suggestion Filters for only drivers that finished a race with a lap that was the ranked in the specified position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -59,23 +69,23 @@ Gets list of drivers **Filters for only drivers who has started a race in a specific grid position**
```suggestion Filters for only drivers who have started a race in a specific grid position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -59,23 +69,23 @@ Gets list of drivers **Filters for only drivers who has started a race in a specific grid position** -`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/1/drivers` +`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/1/drivers/` --- ### results **Filters for only drivers who has finished a ra...
```suggestion Filters for only drivers who have finished a race in a specific position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -59,23 +69,23 @@ Gets list of drivers **Filters for only drivers who has started a race in a specific grid position** -`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/1/drivers` +`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/1/drivers/` --- ### results **Filters for only drivers who has finished a ra...
```suggestion Filters for only drivers who have finished a race with a specific `statusId`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred.
```suggestion Returns a given races list of pitstops, from earliest to latest `time` in which the pitstop occurred. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion ### Season (required) ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion Filters for the season that the list of pitstops will be from. Year numbers are valid as is `current` to get the pitstops of a given round in the current season. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion **Note**: To utilize the `season` parameter it needs to be the first argument after `/ergast/f1/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion Filters for the round in a specific season that the list of pitstops will be from. Round numbers 1 -> `n` races are valid as well as `last`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion **Note**: To utilize the `round` parameter it must be combined with a season filter and needs to be the first argument after `/ergast/f1/{season}/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion Filters for only for a specific drivers's list of pitstops in a season's round. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -0,0 +1,242 @@ +[← Documentation Home](/docs/README.md) +# Pitstops Standings + +Gets a given races list of pitstops in from earliest to latest `time` in which the pitstop occurred. + +**Note**: Data starts for the 2011 season. + +**URL** : `/ergast/f1/{season}/{ROUND}/pitstops/` + +[Available Query Parameters](/doc...
```suggestion Filters for only pitstops that took place in a given lap of a race. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest.
```suggestion Returns a list of races from earliest to latest. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion Filters for races only from a specified season. Year numbers are valid as is `current` to get the current season. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion **Note**: To utilize the `season` parameter it needs to be the first argument after `/ergast/f1/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion Filters for the race for a specified round in a specific season. Round numbers 1 -> `n` races are valid as well as `last` and `next`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion **Note**: To utilize the `round` parameter it must be combined with a season filter and needs to be the first argument after `/ergast/f1/{season}/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion Filters for only races featuring a specified circuit. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion Filters for only races featuring a specified constructor. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,47 +1,57 @@ [← Documentation Home](/docs/README.md) # Races -Gets list of races +Gets list of races from earliest to latest. -**URL** : `/ergast/f1/races` +**URL** : `/ergast/f1/races/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#query-paramet...
```suggestion Filters for only races featuring a specified driver. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -50,15 +60,15 @@ Gets list of races **Filters for only races featuring a specified grid position** -`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/27/races` +`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/27/races/` --- ### status **Filters for only races featuring a specified finishing status of a d...
```suggestion Filters for only races featuring a specified finishing status of a driver. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -80,29 +90,29 @@ Gets list of races ## Race Object Fields: -|Field|Required| +|Field|Always Included| |---|:---:| |season| βœ… | |round|βœ…| |url|βœ…| |raceName|βœ…| |Circuit|βœ…| |date|βœ…| -|time|❌| -|FirstPractice|❌| -|SecondPractice|❌| -|ThirdPractice|❌| -|Qualifying|❌| -|Sprint|❌| -|SprintQualifying|❌| +|time|οΏ½...
```suggestion `https://api.jolpi.ca/ergast/f1/races/` ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,21 +1,21 @@ [← Documentation Home](/docs/README.md) # Seasons -Gets list of seasons +Gets list of seasons from earliest to latest. -**URL** : `/ergast/f1/seasons` +**URL** : `/ergast/f1/seasons/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#que...
```suggestion Filters for a specified season. Year numbers are valid as is `current` to get the current season. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -1,21 +1,21 @@ [← Documentation Home](/docs/README.md) # Seasons -Gets list of seasons +Gets list of seasons from earliest to latest. -**URL** : `/ergast/f1/seasons` +**URL** : `/ergast/f1/seasons/` -[Available Query Parameters](./README.md#query-parameters) +[Available Query Parameters](/docs/README.md#que...
```suggestion **Note**: To utilize the `season` parameter it needs to be the first route after `/ergast/f1/`. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -25,23 +25,23 @@ Gets list of seasons **Filters for only seasons featuring a specified circuit**
```suggestion Filters for only seasons featuring a specified circuit. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -25,23 +25,23 @@ Gets list of seasons **Filters for only seasons featuring a specified circuit** -`/circuits/{circuitId}/` -> ex: `/ergast/f1/circuits/monza/seasons` +`/circuits/{circuitId}/` -> ex: `/ergast/f1/circuits/monza/seasons/` --- ### constructors **Filters for only seasons featuring a specifi...
```suggestion Filters for only seasons featuring a specified constructor. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -25,23 +25,23 @@ Gets list of seasons **Filters for only seasons featuring a specified circuit** -`/circuits/{circuitId}/` -> ex: `/ergast/f1/circuits/monza/seasons` +`/circuits/{circuitId}/` -> ex: `/ergast/f1/circuits/monza/seasons/` --- ### constructors **Filters for only seasons featuring a specifi...
```suggestion Filters for only seasons featuring a specified driver. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -50,15 +50,15 @@ Gets list of seasons **Filters for only seasons featuring a specified grid position**
```suggestion Filters for only seasons featuring a specified grid position. ```
jolpica-f1
github_2023
others
83
jolpica
chrisfree
@@ -50,15 +50,15 @@ Gets list of seasons **Filters for only seasons featuring a specified grid position** -`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/27/seasons` +`/grid/{gridPosition}/` -> ex: `/ergast/f1/grid/27/seasons/` --- ### status **Filters for only seasons featuring a specified finishing sta...
```suggestion Filters for only seasons featuring a specified finishing status of a driver in at least one race that season. ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -0,0 +1,301 @@ +[← Documentation Home](/docs/README.md) +# Qualifying + +Returns a list of qualification results from each race. + +**URL** : `/ergast/f1/qualifying/` + +[Available Query Parameters](/docs/README.md#query-parameters) + +--- + +## Route Parameters + +### Season + +Filters for qualifying results only f...
```suggestion |position| 🟑 |Qualifying Result Position|String ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -91,30 +101,30 @@ Gets list of drivers `MRData.DriverTable.Drivers` : The list of all drivers returned. -`MRData.DriverTable.Drivers[i]` : A given driver object +`MRData.DriverTable.Drivers[i]` : A given driver object. --- ## Driver Object Fields: -|Field|Required| -|---|:---:| -|driverId| βœ… | -|permane...
```suggestion |url| 🟑 |Wikipedia URL to the Drivers profile|String |givenName|βœ…|First name|String |familyName|βœ…|Last name|String |dateOfBirth| 🟑 |Date of Birth (YYYY-MM-DD format)|String |nationality| 🟑 |Nationality of Driver|String ```
jolpica-f1
github_2023
others
83
jolpica
jolpica
@@ -74,27 +84,27 @@ Gets list of races `MRData.RaceTable.Races` : The list of all races returned. -`MRData.RaceTable.Races[i]` : A given race object +`MRData.RaceTable.Races[i]` : A given race object. --- ## Race Object Fields: -|Field|Required| -|---|:---:| -|season| βœ… | -|round|βœ…| -|url|βœ…| -|raceName|βœ…| ...
```suggestion |SprintQualifying / SprintShootout|🟑| Shootouts took place in 2023, otherwise they are Qualifying (date, time)|Object ```
jolpica-f1
github_2023
others
81
jolpica
jolpica
@@ -0,0 +1,204 @@ +# Races + +Gets list of races + +**URL** : `/ergast/f1/races` + +--- + +## Route Parameters: + +### Season + +**Filters for races only from a specified season. Year numbers are valid as is 'current' to get the current season** + +`/{season}/` -> ex: `/ergast/f1/2024/races` + +**Note**: To utilize th...
Could we move these into a common markdown file that we can link to from each endpoint? Would help reduce duplication, and make it easier to update.
jolpica-f1
github_2023
others
81
jolpica
jolpica
@@ -0,0 +1,204 @@ +# Races + +Gets list of races + +**URL** : `/ergast/f1/races` + +--- + +## Route Parameters: + +### Season + +**Filters for races only from a specified season. Year numbers are valid as is 'current' to get the current season** + +`/{season}/` -> ex: `/ergast/f1/2024/races` + +**Note**: To utilize th...
Could something similar be done here also? series, total, limit, offset, url, etc all mean the same thing so moving it to a common file which we can link to would be great.
jolpica-f1
github_2023
others
81
jolpica
jolpica
@@ -0,0 +1,204 @@ +# Races + +Gets list of races + +**URL** : `/ergast/f1/races` + +--- + +## Route Parameters: + +### Season + +**Filters for races only from a specified season. Year numbers are valid as is 'current' to get the current season** + +`/{season}/` -> ex: `/ergast/f1/2024/races` + +**Note**: To utilize th...
Maximum value is 100