Skip to content

Commit 90ad321

Browse files
committed
Update /vehicles endpoint description
- Specify that /vehicles called without a device ID should return all vehicles deployed in a region in the last thirty days - Specify that vehicle information about all device IDs present in MDS data for a region must be accessible via /vehicles/device_id regardless of when the vehicle was deployed
1 parent 5f5e98e commit 90ad321

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

provider/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,17 +170,20 @@ For Timestamps, Vehicle Types, Propulsion Types, UUIDs, Costs, and Currencies, r
170170

171171
There are two vehicles related endpoints:
172172

173-
- `/vehicles` returns unchanging information about vehicles such as vehicle and propulsion type
173+
- `/vehicles` returns rarely changed information about vehicles such as vehicle and propulsion type
174174
- `/vehicles/status` returns the current status of vehicles for real-time monitoring
175175

176176
As with other MDS APIs, the vehicles endpoints are intended for use by regulators, not by the general public. They can be deployed by providers as standalone MDS endpoints for agencies without requiring the use of other endpoints, due to the [modularity](/README.md#modularity) of MDS. See our [MDS Vehicles Guide](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/MDS-Vehicles) for how this compares to GBFS `/free_bike_status`. Note that using authenticated vehicles endpoints does not replace the role of a public [GBFS][gbfs] feed in enabling consumer-facing applications. If a provider is using both the vehicles endpoints and GBFS endpoints, the vehicles endpoints should be considered source of truth regarding an agency's compliance checks.
177177

178178
### Vehicle Information
179179

180-
The `/vehicles` endpoint returns the specified vehicle (if a device_id is provided) or a list of known vehicles.
180+
The `/vehicles` endpoint returns the specified vehicle (if a `device_id` is provided) or a list of vehicles.
181181
It contains vehicle properties that do not change often.
182182
When `/vehicles` is called without specifying a device ID it should return every vehicle that has
183-
ever been deployed in an agency's [Jurisdiction](/general-information.md#definitions) and/or area of agency responsibility.
183+
been deployed in an agency's [Jurisdiction](/general-information.md#definitions) and/or area of agency responsibility
184+
in the last 30 days.
185+
Vehicle information about all device IDs present in other MDS endpoints must be acessible via the
186+
`/vehicles/{device_id}` style call regardless of when they were deployed.
184187

185188
**Endpoint:** `/vehicles/{device_id}`
186189
**Method:** `GET`

0 commit comments

Comments
 (0)