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

Update documentation and make editorial changes for the v4.1 release #336

Closed j-d-b closed 1 year ago

j-d-b commented 1 year ago

This PR proposes changes needed to finalize the v4.1 version of the WZDx specification for official release.

The fixes/release-v4.1 branch will be updated as necessary fixes are found in reviewing #335. Once review of #335 is complete this PR can be completed and then #335 can be merged, marking the official v4.1 release.

j-d-b commented 1 year ago

The example files FeedInfo version needs to be changed from 4.0 to 4.1

sknick-iastate commented 1 year ago

The example files FeedInfo version needs to be changed from 4.0 to 4.1

I have this updated in all of the examples pull request

j-d-b commented 1 year ago

@sknick-iastate understood, thank you, but if our plan is to release v4.1 before merging the examples PR, we need to update it here as well or else the examples will be incorrect (not valid 4.0) until the examples PR is merged.

j-d-b commented 1 year ago

I'm leaning toward preferring removing all the TDx references because they're not correct if the object/enum is duplicated in the TDx spec. The references note that the type is "used by" the TDx specification, but since the TDx spec has a copy of the type, the one in this repo/in WZDx isn't used by TDx, they just happen to be the same.

I think the references should only stay if the types are not duplicated in TDx and if TDx just includes links to WZDx rather than containing copies.

j-d-b commented 1 year ago

The schema $ids and $refs need to be updated to use the main branch in advance of merging into main

j-d-b commented 1 year ago

The example files FeedInfo version needs to be changed from 4.0 to 4.1

Completed

The schema $ids and $refs need to be updated to use the main branch in advance of merging into main

Completed

j-d-b commented 1 year ago

I reviewed every file with at least a skim except the examples as they will be reviewed and updated in #339.

sknick-iastate commented 1 year ago

Can the "Important Note" at the bottom RoadEventCoreDetails Object be removed? It is already noted directly in the data_source_id linking to the business rule.

sknick-iastate commented 1 year ago

I went through almost all of the work zone, detour and device spec-content and looks good to me.

mark-mockett commented 1 year ago

I'm leaning toward preferring removing all the TDx references because they're not correct if the object/enum is duplicated in the TDx spec. The references note that the type is "used by" the TDx specification, but since the TDx spec has a copy of the type, the one in this repo/in WZDx isn't used by TDx, they just happen to be the same.

I think the references should only stay if the types are not duplicated in TDx and if TDx just includes links to WZDx rather than containing copies.

Removed all references to TDx from 'used by' sections

edit: messed up the merge. this is addressed in #340