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

Provider Vehicles - Beta 0.4.1 - Feedback #637

Closed
schnuerle opened this issue Apr 12, 2021 · 20 comments · Fixed by #665
Closed

Provider Vehicles - Beta 0.4.1 - Feedback #637

schnuerle opened this issue Apr 12, 2021 · 20 comments · Fixed by #665
Assignees
Labels
beta Discussions around items that are marked as a 'beta' feature discussion Feedback is requested on an ongoing basis Provider Specific to the Provider API
Milestone

Comments

@schnuerle
Copy link
Member

schnuerle commented Apr 12, 2021

Gather real world feedback to see how we can move the beta feature Vehicles out of beta.

Describe the solution you'd like

From the MDS Survey, about half of agencies are using Vehicles, most providers are, and almost all companies support it. Seems to have good real world usage. We need feedback here from those that are using it to know what may need to change before it becomes a stable part of MDS.

Is this a breaking change

  • I'm not sure yet

Impacted Spec

For which spec is this feature being requested?

Describe alternatives you've considered

Leave as a beta feature for longer until we have feedback.

Additional context

Reviewed as part of the MDS 1.2.0 release review Midway Checkpoint by the Working Group Steering Committees.

@schnuerle schnuerle added discussion Feedback is requested on an ongoing basis Provider Specific to the Provider API labels Apr 12, 2021
@dirkdk
Copy link
Contributor

dirkdk commented Apr 15, 2021

I think soon Vehicles will be a core part of deployment cap enforcement so I think it is a good idea.

@dirkdk
Copy link
Contributor

dirkdk commented Apr 15, 2021

Related, I am wondering if the requirement to also have a GBFS API should be dropped. https://github.com/openmobilityfoundation/mobility-data-specification#gbfs-requirement

If the main reason is compliance checks, I would say the Vehicles endpoint replaces this need and we can drop it. We would like this very much as a provider. This would enable us to use different Quality of Service levels for MDS vs GBFS. For instance, as GBFS is public, we rate limit it but run into problems with data aggregators (@jiffyclub can attest to this) sometimes. If GBFS is not used for compliance anymore we can safely adjust our levels without running the risk of making compliance checks more fragile.

@schnuerle
Copy link
Member Author

Thank you for the feedback on Vehicles Dirk.

@dirkdk per your question about GBFS, could you please put that into a new issue for a deeper discussion there?

@schnuerle
Copy link
Member Author

See new issue #641 for discussion around GBFS and MDS, and this issue plus the new issue will be the topics at tomorrow's working group meeting.

@jiffyclub
Copy link
Contributor

We at Populus are now consuming /vehicles and have found it useful in its current spec, so I think it's ready to move out of beta.

@schnuerle schnuerle added this to the 1.2.0 milestone Apr 29, 2021
@luisjavierbautista
Copy link

Great idea! In bogota we are starting now with 1.1 version, but put out of beta vehicles endpoint would be great!

@margodawes
Copy link

In Seattle, we are requiring vendors to use the vehicles endpoint and finding it a helpful alternative to constructing fleet totals from the status_changes API.

One issue we've encountered recently is a lack of clarity around whether vendors should return data about vehicle_states not in the public right-of-way. The intro text to the endpoint says vendors should only return data about vehicles in the PROW, but the list of vehicle_states that could/should be included in the payload include states not in the PROW. Clarifying this when moving the endpoint out of beta would be helpful.

@schnuerle
Copy link
Member Author

Hi @margodawes thank you for the feedback. You raise a good point. The vehicles endpoint is clear it's just PROW, but there are states and events than can be outside of the PROW or unknown.

Other endpoints use the same state machine and states/events, like status_changes, events, and Agency endpoints too. So I believe the intention here is that the description is correct, and it's just PROW. If so maybe we can add some text like "Note this a subset of all possible vehicle states and events, and this endpoint is only focused on the PROW states."

However, I could see scenarios where an agency may want to also know unknown states (which should then be clarified here) in addition, or those out of the PROW (though this may include charger locations which could be private).

Does anyone have some feedback on how they think this should be worded and if it should include unknown or outside PROW states?

@marie-x
Copy link
Collaborator

marie-x commented May 11, 2021

It should be all states. Knowing when and where a vehicle either was picked up, or left the PROW, is important for multiple use-cases including cap-counts.

@jiffyclub
Copy link
Contributor

jiffyclub commented May 11, 2021

@karcass I think that would then require some guidance on how long vehicles should remain in the vehicles feed after being removed from the PROW. We would find it useful to get an update in the vehicles feed about vehicles that have left the PROW, but of course it's not practical to keep all vehicles in there forever. Maybe something like an hour?

@marie-x
Copy link
Collaborator

marie-x commented May 11, 2021

@jiffyclub good point. I would propose a uniform timeout for the latest-event-per-vehicle, perhaps longer than 1h.

@schnuerle
Copy link
Member Author

Hi all, we had a productive Working Group meeting about this yesterday. Here are the full meeting notes.

The ending suggestion is to:

  1. Add a definition for 'Jurisdiction' in the general information definitions area of the spec
  2. Update vehicles to say "Jurisdiction and/or area of agency responsibility" instead of just PROW.

@dirkdk I know you had to drop off and thought it could just stay as PROW. But we discussed lots of examples where PROW is not adequate (private parking garages, national park areas in a city, just outside of jurisdictions or PROW, within interior sub-cities, etc from notes). What do you think?

@margodawes To clarify your initial concern, do you think that 1) it should be just the PROW as stated, or 2) be larger like the agency jurisdiction and area of responsibility, or 3) do you not care one way or the other and just want it to be more clear?

@margodawes
Copy link

@schnuerle My initial concern was just about lack of clarity (#3). We think having data on non-PROW vehicle states could be helpful reference, but don't plan to use those data in our fleet size counts, so can do without it.

@dirkdk
Copy link
Contributor

dirkdk commented May 19, 2021

Hi all, we had a productive Working Group meeting about this yesterday. Here are the full meeting notes.

The ending suggestion is to:

  1. Add a definition for 'Jurisdiction' in the general information definitions area of the spec
  2. Update vehicles to say "Jurisdiction and/or area of agency responsibility" instead of just PROW.

@dirkdk I know you had to drop off and thought it could just stay as PROW. But we discussed lots of examples where PROW is not adequate (private parking garages, national park areas in a city, just outside of jurisdictions or PROW, within interior sub-cities, etc from notes). What do you think?

@margodawes To clarify your initial concern, do you think that 1) it should be just the PROW as stated, or 2) be larger like the agency jurisdiction and area of responsibility, or 3) do you not care one way or the other and just want it to be more clear?

as long as we keep the list of applicable statuses the same and not list all vehicles in al statuses, this is fine with me.

This looks more like a semantic discussion then. This definition is easier for providers as I would say, if a user parks the vehicle in a garage that is privately owned that is really hard to track for a mobility provider so we don't. At that point a vehicle is still available for us, in a larger service area.

@schnuerle
Copy link
Member Author

I will make a pull request for this with clarifying language and link it here for review.

@schnuerle schnuerle self-assigned this Jun 25, 2021
@schnuerle schnuerle linked a pull request Jul 23, 2021 that will close this issue
@schnuerle
Copy link
Member Author

I've made PR #665 which removed the beta flag, adds a definition for Jurisdiction, and specifies that vehicles covers Jurisdiction and/or area of responsibility instead of just PROW.

I did not add any more states to the list. Please discuss here if you'd like all state or any more states added and your reasons for it. See this comment as a start:

It should be all states. Knowing when and where a vehicle either was picked up, or left the PROW, is important for multiple use-cases including cap-counts.

I did not add guidance on how long vehicles should remain in the vehicles feed after being removed from the PROW, since this may only apply if we add more states. Discuss here if you'd like to see this added. See this comment:

I think that would then require some guidance on how long vehicles should remain in the vehicles feed after being removed from the PROW. We would find it useful to get an update in the vehicles feed about vehicles that have left the PROW, but of course it's not practical to keep all vehicles in there forever. Maybe something like an hour?

and this comment:

I would propose a uniform timeout for the latest-event-per-vehicle, perhaps longer than 1h.

@jiffyclub
Copy link
Contributor

+1 for all states, it's useful to know a vehicle was intentionally removed vs. comms were lost or something like that.

@schnuerle schnuerle added the beta Discussions around items that are marked as a 'beta' feature label Jul 30, 2021
@schnuerle schnuerle changed the title Provider Vehicles - Feedback to move out of beta Provider Vehicles - Beta 0.4.1 - Feedback Jul 30, 2021
@schnuerle
Copy link
Member Author

Per our meeting action items today, I've updated the PR and you can see the changes here.

Please leave any feedback as I'd like to get this merged to dev within the next 2 weeks. @dirkdk @bhandzo could weigh in from the provider perspective to ensure providing all states is ok.

@schnuerle
Copy link
Member Author

Planning to resolve and merge this PR within a week or so, so please weigh in soon if you have thoughts.

@schnuerle
Copy link
Member Author

Closed with #665

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta Discussions around items that are marked as a 'beta' feature discussion Feedback is requested on an ongoing basis Provider Specific to the Provider API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants