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

Rename WZDxFeed to WorkZoneFeed (or similar) #288

Closed
j-d-b opened this issue Apr 1, 2022 · 3 comments
Closed

Rename WZDxFeed to WorkZoneFeed (or similar) #288

j-d-b opened this issue Apr 1, 2022 · 3 comments
Assignees
Labels
Cleanup This item relates to cleaning up the specification (e.g. removing deprecated items) Non-spec This issue is not related to the specification content
Milestone

Comments

@j-d-b
Copy link
Collaborator

j-d-b commented Apr 1, 2022

This issue proposes renaming the WZDxFeed object to WorkZoneFeed.

Background

WZDx v4.0 defines the following feeds:

  • WZDxFeed: describes high-level information about work zone events ocurring on roadways (called "road events") that impact the characteristics of the roadway and involve a change from the default state (such as a lane closure). This is the original work zone data exchange feed and the only feed that WZDx defined until version 4.0.
  • RoadRestrictionFeed: describes the location and details of restrictions on roadways.
  • SwzDeviceFeed: describes information (location, status, live data) about field devices deployed on the roadway in work zones. (note this may be renamed to DeviceFeed as proposed in Rename SwzDeviceFeed to DeviceFeed #242)

Issue

There are several issues with the naming of WZDxFeed, mostly related to the name being confusing and only there for historical reasons:

  • All feeds are WZDx feeds, so it is confusing to have one of the feeds named WZDxFeed
  • Each of the feeds are WZDx feeds, so when referring to a feed out of context, it would be preceded by "WZDx". Thus, the WZDxFeed is the WZDx WZDxFeed
  • The RoadRestrictionFeed and SwzDeviceFeed (to be DeviceFeed) provide indication of what the feed includes while the WZDxFeed is more general

Proposed Change

  • Rename the WZDxFeed to WorkZoneFeed

Then (assuming #242 is implemented) WZDx would define the following feeds:

  • WorkZoneFeed: describes high-level information about work zone events occurring on roadways (called "road events") that impact the characteristics of the roadway and involve a change from the default state (such as a lane closure). This is the original work zone data exchange feed and the only feed that WZDx defined until version 4.0. It was previously called the "WZDxFeed".
  • RoadRestrictionFeed: describes the location and details of restrictions on roadways.
  • DeviceFeed: describes information (location, status, live data) about field devices deployed on the roadway, typically in work zones.

Note that this is a rename of the feed object and feed as referenced throughout WZDx documentation and has no impact on the specification content or structure.

@j-d-b j-d-b added Non-spec This issue is not related to the specification content Cleanup This item relates to cleaning up the specification (e.g. removing deprecated items) labels Apr 1, 2022
@j-d-b j-d-b added this to the v4.1 milestone Apr 1, 2022
@j-d-b j-d-b self-assigned this Apr 1, 2022
@natedeshmukhtowery
Copy link
Collaborator

I highly support this change - it improves legibility and future proofing. Thanks!

@j-d-b
Copy link
Collaborator Author

j-d-b commented May 12, 2022

Based on the WZDx Specification Update Subgroup Meeting on May 5, 2022, the rename to WorkZoneFeed will be implemented for WZDx v4.1.

@j-d-b
Copy link
Collaborator Author

j-d-b commented Sep 19, 2022

Completed in #333

@j-d-b j-d-b closed this as completed Sep 19, 2022
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) Non-spec This issue is not related to the specification content
Projects
None yet
Development

No branches or pull requests

2 participants