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: indicate municipality-wide service pause in Status Changes API #509

Closed
chloerevery opened this issue Jun 3, 2020 · 9 comments · Fixed by #506
Closed

Provider: indicate municipality-wide service pause in Status Changes API #509

chloerevery opened this issue Jun 3, 2020 · 9 comments · Fixed by #506
Labels
Agency Specific to the Agency API Provider Specific to the Provider API State Machine Changes in the vehicle state events and state machine diagram

Comments

@chloerevery
Copy link

chloerevery commented Jun 3, 2020

Is your feature request related to a problem? Please describe.

Occasionally providers must temporarily cease service, either at the direct request of the city or due to inclement weather. The Provider Status Changes API specification does not specify how the provider status change API should represent this state.

When a vehicle status change occurs in the course of a temporary cessation in service, what event_type_and_reason should be associated with the status change?

Describe the solution you'd like

It seems like this use case fits well with the existing removed event_type, but it's unclear what the associated reason should be. Two possible solutions might be:

  1. Reuse removed / service_end event_type_and_reason for this use case (current description for service_end, "Device removed from street because service has ended for the day (if program does not operate 24/7)", would need to be updated).
  2. Reuse removed event_type but introduce a new reason (service_closure?).

Is this a breaking change

  • No, not breaking

Impacted Spec

For which spec is this feature being requested?

  • provider

Describe alternatives you've considered

N/A

Additional context

N/A

@quicklywilliam
Copy link
Contributor

Thanks for filing this. I would advocated for the second solution here, a new reason. I could see it being useful to express Service Closures in the Policy API, and having an explicit reason would help assess and report on compliance.

@jfh01 jfh01 added Agency Specific to the Agency API Provider Specific to the Provider API State Machine Changes in the vehicle state events and state machine diagram labels Jun 4, 2020
@jfh01 jfh01 added this to the 1.0.0 milestone Jun 4, 2020
@jfh01
Copy link
Contributor

jfh01 commented Jun 4, 2020

Thanks for submitting this.

Discussed on the 6/4 Provider Services WG call. Will try to get into the 1.0.0 release as part of the provider/agency reconciliation work being done in #506.

@schnuerle schnuerle linked a pull request Jun 4, 2020 that will close this issue
@schnuerle
Copy link
Member

We've now merged PR #506 to the dev branch, so we'll look at if this is resolved now, if it can be resolved easily, or if it needs to go to the next release. Tagging @Karcass @thekaveman.

@schnuerle
Copy link
Member

Not sure if this is resolved yet or not. Will look into it as I prepare the 1.0.0 release candidate.

@schnuerle schnuerle modified the milestones: 1.0.0, 1.1.0 Jul 1, 2020
@schnuerle
Copy link
Member

schnuerle commented Jul 1, 2020

We are going to have to move this good suggestion to 1.1.0 since adding a new event type “service_closure” under "removed" would have ripple impacts on the repo at this point (docs, state machine diagram, schema).

@thekaveman
Copy link
Collaborator

In #506 we added the system_suspend and system_resume to handle cases like weather closure or other temporary suspensions of service. Do these event types capture the use-cases outlined in this issue?

@schnuerle
Copy link
Member

@schnuerle
Copy link
Member

Hi @chloerevery we talked about this today. The consensus was that with #506 we've added system_suspend and system_resume and that it should address your use cases. Please let us know here if they do not, thanks.

@schnuerle schnuerle removed this from the 1.1.0 milestone Nov 18, 2020
@schnuerle
Copy link
Member

Closing but let us know if you have any concerns or unresolved issues with this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agency Specific to the Agency API Provider Specific to the Provider API State Machine Changes in the vehicle state events and state machine diagram
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants