search

usdot-jpo-ode / wzdx

The Work Zone Data Exchange (WZDx) Specification aims to make harmonized work zone data provided by infrastructure owners and operators (IOOs) available for third party use, making travel on public roads safer and more efficient through ubiquitous access to data on work zone activity.
Creative Commons Zero v1.0 Universal
89 stars 62 forks source link

Rename the WZDxFeed road_event_feed_info property to feed_info for consistency #222

Closed j-d-b closed 2 years ago

j-d-b commented 2 years ago

Background

All WZDx feeds contain the FeedInfo object which contains information about the feed, such as version, contact information, and data sources. The FeedInfo occurs on the specific feed object (WZDxFeed, RoadRestrictionFeed, or SwzDeviceFeed.

Issue

On the RoadRestrictionFeed and the SwzDeviceFeed, the FeedInfo occurs on a feed_info property. On the WZDxFeed, this is inconsistently named (due to historical reasons) road_event_feed_info.

Proposed Change

For backwards compatibility, I propose deprecating the road_event_feed_info property on the WZDxFeed and adding the feed_info property. Both would contain the FeedInfo object.

j-d-b commented 2 years ago

Based on feedback at the 2022-02-23 spec update subgroup meeting, this change is on track to be implemented in v4.1.

j-d-b commented 2 years ago

Resolved in #291.