Historic Traffic DateTime parameter to Route Endpoints #623
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new dateTime parameter to multiple route calculation endpoints to support historical traffic data. The parameter allows users to specify a specific date and time for route calculations instead of using current traffic conditions.
- Adds
dateTimeparameter documentation to four route-related API endpoints - Updates spell checker configuration to include the new datetime format string
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/api.mdx | Adds dateTime parameter documentation to route calculation endpoints |
| cspell.json | Adds "DDTHH" to spell checker dictionary for datetime format validation |
| @@ -985,6 +985,7 @@ Calculates the travel distance and duration between an origin and a destination. | |||
| - **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial` if not provided. In the response, `distance.value` will be in meters for `metric` and in feet for `imperial`. | |||
| - **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways`, `ferries` and `borderCrossings`. No features are avoided if not provided. | |||
| - **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to none if not provided. | |||
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |||
There was a problem hiding this comment.
The markdown formatting is incorrect. There should be no space between the asterisks and the parameter name. It should be **dateTime** instead of ** dateTime**.
Suggested change
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |
| - **`dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. |
Copilot uses AI. Check for mistakes.
| @@ -1054,6 +1055,7 @@ Calculates the travel distances and durations between multiple origins and desti | |||
| - **`mode`** (string, required): The travel mode. A string, one of `car`, `truck`, `foot`, or `bike`. | |||
| - **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial` if not provided. | |||
| - **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways` and `ferries`. No features are avoided if not provided. | |||
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |||
There was a problem hiding this comment.
The markdown formatting is incorrect. There should be no space between the asterisks and the parameter name. It should be **dateTime** instead of ** dateTime**.
Suggested change
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |
| - **`dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. |
Copilot uses AI. Check for mistakes.
| @@ -1304,6 +1306,7 @@ Calculates the most efficient route between two or more locations to visit in or | |||
| - **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial`. | |||
| - **`avoid`** (string, optional): The features that calculated routes should avoid. A string, comma-separated, including one or more of `tolls`, `highways`, `ferries` and `borderCrossings`. No features are avoided if not provided. | |||
| - **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to `polyline6` if not provided. | |||
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |||
There was a problem hiding this comment.
The markdown formatting is incorrect. There should be no space between the asterisks and the parameter name. It should be **dateTime** instead of ** dateTime**.
Suggested change
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |
| - **`dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. |
Copilot uses AI. Check for mistakes.
| @@ -2301,6 +2304,7 @@ Calculates the optimal ordering and route to visit a list of locations. | |||
| - **`mode`** (string, optional): The travel mode. A string, one of `car`, `truck`, `foot`, or `bike`. Defaults to `car`. | |||
| - **`units`** (string, optional): The distance units. A string, `metric` or `imperial`. Defaults to `imperial`. | |||
| - **`geometry`** (string, optional): The format of the `geometry` in the response. Valid values are `linestring`, `polyline5` and `polyline6`. `linestring` returns a GeoJSON `LineString`, `polyline5` returns a polyline with 5 decimal places of precision (compatible with other mapping providers) and `polyline6` returns a polyline with 6 decimal places of precision. Defaults to none if not provided. | |||
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |||
There was a problem hiding this comment.
The markdown formatting is incorrect. There should be no space between the asterisks and the parameter name. It should be **dateTime** instead of ** dateTime**.
Suggested change
| - ** `dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. | |
| - **`dateTime`** (string, optional): The date and time of the trip provided as a string in `YYYY-MM-DDTHH:MM` format which will be used for historical traffic times. If not provided, the current date and time will be used. |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Why?
How?
Screenshots (optional)
Anything Else? (optional)