Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What vehicles are included in the MDS 2.0 /vehicles endpoint? #879

Closed
jiffyclub opened this issue Sep 11, 2023 · 4 comments · Fixed by #882
Closed

What vehicles are included in the MDS 2.0 /vehicles endpoint? #879

jiffyclub opened this issue Sep 11, 2023 · 4 comments · Fixed by #882
Labels
discussion Feedback is requested on an ongoing basis documentation documentation change can be for code and/or markdown pages Modes New modes that MDS can support (carshare, passenger services, delivery robots, etc)
Milestone

Comments

@jiffyclub
Copy link
Contributor

jiffyclub commented Sep 11, 2023

In MDS 2.0 the /vehicles endpoint contains static vehicle information that could be required for vehicles deployed years in the past. However, the documentation reads:

The /vehicles is a near-realtime endpoint and returns the current status of vehicles in an agency's Jurisdiction and/or area of agency responsibility. All vehicles that are currently in any vehicle_state should be returned in this payload. Since all states are returned, care should be taken to filter out states not in the PROW if doing vehicle counts. For the states elsewhere and removed which include vehicles not in the PROW but provide some operational clarity for agencies, these must only persist in the feed for 90 minutes before being removed.

This is carryover language from MDS 1.x and I'm curious what the expectations are for the MDS 2.0 /vehicles endpoint (distinct from the /vehicles/status endpoint). Should it contain every vehicle ever deployed in a jurisdiction? If it is only expected to contain currently deployed vehicles (like the MDS 1.x /vehicles endpoint), what's the procedure for getting vehicle information for historically deployed vehicles? Request it one vehicle at a time via /vehicles/{device-id}?

And then thinking about the relationship between MDS 2.0 /vehicles and /vehicles/status, my instinct is that we should require that at a minimum the /vehicles endpoint should always return the same vehicles as would be returned by /vehicles/status and document that requirement. But that still leaves the question of how to get vehicle information for historically deployed vehicles.

@schnuerle schnuerle added Modes New modes that MDS can support (carshare, passenger services, delivery robots, etc) documentation documentation change can be for code and/or markdown pages discussion Feedback is requested on an ongoing basis labels Sep 25, 2023
@schnuerle schnuerle added this to the 2.0.1 milestone Sep 27, 2023
@schnuerle
Copy link
Member

If you can make a PR for this change, that would be helpful, and you'd be listed as a GitHub contributor. We are looking at creating a 2.0.1 release soon for all open issues and PRs tagged with the 2.0.1 Milestone. If not I will create the PR.

@jiffyclub
Copy link
Contributor Author

I can make a PR but I think there's an unresolved question here of what the /vehicles endpoint should return.

@jiffyclub
Copy link
Contributor Author

See #882 for PR. I'm proposing this language for the /vehicles endpoint expectations:

When /vehicles is called without specifying a device ID it should return every vehicle that has
ever been deployed in an agency's Jurisdiction and/or area of agency responsibility.

@schnuerle schnuerle linked a pull request Oct 19, 2023 that will close this issue
@schnuerle
Copy link
Member

Resolved with #882

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Feedback is requested on an ongoing basis documentation documentation change can be for code and/or markdown pages Modes New modes that MDS can support (carshare, passenger services, delivery robots, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants