openmobilityfoundation / openmobilityfoundation/mobility-data-specification
Add the possibility to update vehicle_type in /vehicles update
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 746
- Forks
- 252
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 2
Description
Is your feature request related to a problem? Please describe.
Vehicle_types are more fluid than it seems and it happens frequently that during a mobility program launch, vehicles initially registered with a given vehicle_type have to be updated.
Describe the solution you'd like
Give possibility to change the vehicle_type in the /vehicles endpoint
Endpoint: /vehicles/{device_id} Method: PUT
Body Params:
| Field | Type | Required/Optional | Field Description |
|---|---|---|---|
| vehicle_id | String | Required | Vehicle Identification Number (vehicle_id) visible on vehicle |
| vehicle_type | Enum | Required | Vehicle Types |
Is this a breaking change
- Yes, breaking
Impacted Spec
For which spec is this feature being requested?
agency
Describe alternatives you've considered
No real alternative at this point.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the agency specification's definition of the /vehicles/{device_id} PUT endpoint and compare its current update fields with the vehicle types linked in the issue. Done means the endpoint permits changing vehicle_type and the agency specification records the resulting breaking change.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100