openmobilityfoundation / openmobilityfoundation/mobility-data-specification

Simplify /vehicles/status

Open
#903 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Agency Provider
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.

Right now /vehicles/status is quite complex to implement for operators in comparison with the GBFS 1.0 (https://github.com/openmobilityfoundation/governance/blob/main/technical/GBFS_and_MDS.md#real-time-status-differences) where it is a succesor of. The complexity is that this endpoint is not only about the current realtime situation anymore but also about events that happened in the past in addition to the need to add identifiers to those events.

For pragmatic reasons (for example making it also viable for small operators to deliver data to dashboard) we now allow operators to implement a subset of /vehicles/status (https://docs.dashboarddeelmobiliteit.nl/data_feeds/for_monitoring/#mds-vehicles). Ideally this subset will be globally the same.

Describe the solution you'd like

From a municipality point the most important data is the current location + vehicle_state, more or less the same data that was already in GBFS 1.0. I would like to propose a simplified version of /vehicles/status to simplify the exchange of data between operators and municipalities.

Is this a breaking change

It depends on if we introduce a new simplified endpoint besides the existing /vehicles/status or that we would like to change the existing one.

Impacted Spec
  • provider

I really would like to hear your experiences and opinions about this endpoint.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the current provider specification for /vehicles/status and comparing it with the referenced GBFS 1.0 real-time status differences. Review the documented monitoring subset to identify the required current location and vehicle_state data. Done requires an agreed simplified endpoint or a clearly decided change to the existing endpoint, including its breaking-change impact.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.