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

Add WZDx reference #96

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Add WZDx reference #96

wants to merge 3 commits into from

Conversation

schnuerle
Copy link
Member

Explain pull request

Adding a reference to WZDx data feeds in CDS's Curbs API per issue #74

Is this a breaking change

  • No, not breaking

Impacted Spec

Which API(s) will this pull request impact?

  • Curbs

@schnuerle schnuerle added enhancement New feature or request Curbs API future release Looks like this could go in the next CDS release labels Jun 14, 2022
@schnuerle schnuerle added this to the Next Release milestone Jun 14, 2022
@schnuerle schnuerle requested a review from a team as a code owner June 14, 2022 12:22
curbs/README.md Outdated Show resolved Hide resolved
curbs/README.md Outdated Show resolved Hide resolved
curbs/README.md Outdated Show resolved Hide resolved
| Name | Type | Required/Optional | Description |
| ------ | ------ | ------------------- | ------------- |
| `wzdx_feed_url` | URL | Required | An identifier for the source of the publicly accessible WZDx feed. This MUST be a full HTTPS URL pointing to the data feed which contains more information about the underlying work zone impacting the CDS place. |
| `wzdx_road_event_feature_id` | String | Required | The `id` of a WZDx [RoadEventFeature](https://github.com/usdot-jpo-ode/wzdx/blob/main/spec-content/objects/RoadEventFeature.md#roadeventfeature-object-geojson-feature) that impacts the use of a curb zone. In case multiple road event `wzdx_id`s are needed, it would be provided in another object with another `wzdx_feed_url`. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One update to multiple ids:
"In case multiple ids are needed, it should be provided in another object with another wzdx_feed_url"
I don't think we would need describe what the id is again, and this wording provides guidance by using should.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this should be updated to wzdx_road_event_feature_ids and made into an array of Strings. I'll make the edit.

@natedeshmukhtowery
Copy link

I think this is in good shape and continues to make sense in aligning CDS and WZDx for relevant work zones that impact curb areas.

@jlarsonOmahaNE I suggest you move forward with a PR to add a corollary optional data element in WZDx to reference CDS ids.

@schnuerle
Copy link
Member Author

There is now a PR in WZDx to add references to CDS here usdot-jpo-ode/wzdx#326

@schnuerle schnuerle linked an issue Jul 8, 2022 that may be closed by this pull request
@schnuerle
Copy link
Member Author

Approved as part of WZDx v4.2

https://github.com/usdot-jpo-ode/wzdx/blob/release/v4.2/spec-content/objects/CdsCurbZonesReference.md

PR: usdot-jpo-ode/wzdx#326

@schnuerle schnuerle modified the milestones: Next Release, 1.1 Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Curbs API enhancement New feature or request future release Looks like this could go in the next CDS release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Alignment with USDOT Connected Work Zones
4 participants