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

Refactor and clarify event status and start/end date verification #294

Merged
merged 10 commits into from
Aug 11, 2022

Conversation

j-d-b
Copy link
Collaborator

@j-d-b j-d-b commented Apr 22, 2022

This PR resolves #189. Specifically, it proposes the following changes:

  • Deprecate the event_status property on the WorkZoneRoadEvent and DetourRoadEvent.
  • Add deprecation note to EventStatus enumerated type.
  • Deprecate the start_date_accuracy and end_date_accuracy properties on the WorkZoneRoadEvent and DetourRoadEvent.
  • Add deprecation note to TimeVerification enumerated type.
  • Add new boolean properties is_start_date_verified and is_end_date_verified to the WorkZoneRoadEvent and DetourRoadEvent to indicate if the work zone or detour has been confirmed to have started/ended by a person or device in the field or report from a TMC, or similar.
  • Require either start_date_accuracy or is_start_date_verified.
  • Require eitherend_date_accuracy or is_end_date_verified.
  • Update example feeds to use is_start_date_verified and is_end_date_verified and not use event_status, start_date_accuracy, or end_date_accuracy.

See #281 for a similar approach of using booleans that this PR is consistent with.

@j-d-b j-d-b added Refactor This item related to refactoring the specification. Cleanup This item relates to cleaning up the specification (e.g. removing deprecated items) labels Apr 22, 2022
@j-d-b j-d-b changed the base branch from main to release/v4.1 April 22, 2022 03:11
@j-d-b j-d-b changed the title Refactor/event status Refactor and clarify event status and start/end date verification Apr 22, 2022
@j-d-b j-d-b marked this pull request as ready for review April 22, 2022 12:43
@j-d-b j-d-b added this to the v4.1 milestone Apr 22, 2022
@sknick-iastate
Copy link
Collaborator

@j-d-b I thought we discussed at one point but were we planning on still updating the object and enumeration lists in the spec-content README? Or will we just do this when everything is merged?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cleanup This item relates to cleaning up the specification (e.g. removing deprecated items) Refactor This item related to refactoring the specification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove unneeded values from EventStatus enumerated type to clarify the real-time intent of a WZDx feed
5 participants