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 CDS reference #326

Merged
merged 47 commits into from
Dec 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
331209f
Set up for v4.1 release (#265)
j-d-b Mar 21, 2022
061468a
Fix merge conflicts between main and v4.1 release branch (#272)
j-d-b Mar 21, 2022
6ff3589
Merge branch 'release/v4.1'
j-d-b Mar 21, 2022
6430428
Merge branch 'main' into release/v4.1
j-d-b Mar 21, 2022
2755005
Merge branch 'release/v4.1' of https://github.com/usdot-jpo-ode/wzdx …
j-d-b Mar 21, 2022
30135bb
Adding curbs impact
jlarsonOmahaNE Jul 8, 2022
0be1110
Adding CDS Reference Object
jlarsonOmahaNE Jul 8, 2022
2896750
Updating link and description
jlarsonOmahaNE Jul 8, 2022
d447aee
Fixing typo
jlarsonOmahaNE Jul 8, 2022
b2242b0
Adding curbs to schema
jlarsonOmahaNE Jul 8, 2022
4814cae
Fixing extra whitespace
jlarsonOmahaNE Jul 11, 2022
1e30448
Removing extra /
jlarsonOmahaNE Jul 11, 2022
ed4fd5b
Adding info for OMF
jlarsonOmahaNE Jul 11, 2022
fdefea2
Cleanup json
jlarsonOmahaNE Jul 11, 2022
44d9241
Adding new object to README
jlarsonOmahaNE Jul 11, 2022
d8ddecc
Update and rename object
jlarsonOmahaNE Jul 11, 2022
f2d6dea
Schema cleanup and renaming of object
jlarsonOmahaNE Jul 11, 2022
f2f54ab
Adding url suffix to conform with current spec
jlarsonOmahaNE Jul 14, 2022
f7a8219
Updating url name
jlarsonOmahaNE Jul 14, 2022
5b1a6d2
Updating zone id naming
jlarsonOmahaNE Jul 14, 2022
3c74fb6
Matching zone id naming to Object
jlarsonOmahaNE Jul 14, 2022
932663d
Updates to CDS references (#342)
schnuerle Sep 23, 2022
2d2a7a1
Update property name for CDS curb zones
j-d-b Sep 23, 2022
e845823
Update wording in CdsCurbZoneReference object
j-d-b Sep 23, 2022
a0f7b73
Remove last object description sentence
jlarsonOmahaNE Sep 27, 2022
afa5688
Merge branch 'release/v4.2' into feature/cds
mark-mockett Oct 19, 2022
e843916
Updating CDS Reference Object
jlarsonOmahaNE Oct 21, 2022
5cf4c0d
Adding reference to 4.2 schema
jlarsonOmahaNE Oct 21, 2022
b4e1bae
Removing CDS reference from 4.1
jlarsonOmahaNE Oct 21, 2022
ac08180
Update impacted_cds_curb_zones
jlarsonOmahaNE Oct 21, 2022
c3aa235
Delete: Was renamed to WorkZoneFeed
jlarsonOmahaNE Oct 21, 2022
735cc07
Delete: Was renamed to DeviceFeed
jlarsonOmahaNE Oct 21, 2022
b67b5a3
Delete: Moved to TDx repo
jlarsonOmahaNE Oct 21, 2022
4091076
Adding impacted_cds_curnb_zones to 4.2 schema
jlarsonOmahaNE Oct 21, 2022
29eb29d
Remove impacted_cds_curb_zones from 4.1 schema
jlarsonOmahaNE Oct 21, 2022
8b95e50
Updating text
jlarsonOmahaNE Nov 18, 2022
e226351
Updating text
jlarsonOmahaNE Nov 18, 2022
8a409ad
Updating cds text
jlarsonOmahaNE Nov 18, 2022
065f071
Updating schema with cds change text
jlarsonOmahaNE Nov 18, 2022
f4a1b83
Fixing CDS object grammar
jlarsonOmahaNE Nov 18, 2022
87715bd
Updated impacted curb zone text
jlarsonOmahaNE Nov 18, 2022
c956f82
Fix URL reference to CdsCurbZonesReference
sknick-iastate Nov 21, 2022
035763e
Remove comma and 2nd sentence
jlarsonOmahaNE Dec 13, 2022
da428fa
Updating url reference for cds api
jlarsonOmahaNE Dec 13, 2022
fdacf52
Updating api url data type
jlarsonOmahaNE Dec 13, 2022
e947e03
Adding link
jlarsonOmahaNE Dec 13, 2022
652aa4a
Fixing wrong link
jlarsonOmahaNE Dec 13, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions schemas/4.2/RoadEventFeature.json
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,13 @@
"$ref": "#/definitions/Lane"
}
},
"impacted_cds_curb_zones": {
"description": "A list of references to external CDS Curb Zones impacted by the work zone",
"type": "array",
"items": {
"$ref": "#/definitions/CdsCurbZonesReference"
}
},
"event_status": {
"description": "**DEPRECATED**",
"$ref": "#/definitions/EventStatus"
Expand Down Expand Up @@ -516,6 +523,26 @@
"value": ["unit"]
}
},
"CdsCurbZonesReference": {
"title": "CdsCurbZonesReference",
"description": "A reference to one or more CDS curb zones that are impacted by road work",
"type": "object",
"properties": {
"cds_curb_zone_ids": {
"description": "A list of CDS Curb Zone ids",
"type": "array",
"items": {
"type": "string"
}
},
"cds_curbs_api_url": {
"description": "An identifier for the source of the requested CDS Curbs API",
"type": "string",
"format": "uri"
}
},
"required": ["cds_curb_zone_ids", "cds_curbs_api_url"]
},
"WorkerPresence": {
"title": "Worker Presence",
"description": "Information about the presence of workers in the work zone event area",
Expand Down
1 change: 1 addition & 0 deletions spec-content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ The following objects are used to describe events ocurring on roadways (road eve

Object | Description
--- | ---
[CdsCurbZonesReference](/spec-content/objects/CdsCurbZonesReference.md) | A reference to one or more CDS curb zones that are impacted by road work.
[DetourRoadEvent](/spec-content/objects/DetourRoadEvent.md) | A detour on a roadway.
[Lane](/spec-content/objects/Lane.md) | An individual lane within a road event.
[RelatedRoadEvent](/spec-content/objects/RelatedRoadEvent.md) | Identification a road event that is related to the road event that the RelatedRoadEvent object occurs on.
Expand Down
15 changes: 15 additions & 0 deletions spec-content/objects/CdsCurbZonesReference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CdsCurbZonesReference Object
The `CdsCurbZonesReference` object describes specific [Curb Zones](https://github.com/openmobilityfoundation/curb-data-specification/tree/main/curbs#curb-zone) that are impacted by a work zone via an external reference to the Curb Data Specification's [Curb API](https://github.com/openmobilityfoundation/curb-data-specification/tree/main/curbs#curb-data-specification-curbs-api).

Read more about the Open Mobility Foundation's [Curb Data Specification](https://www.openmobilityfoundation.org/about-cds).

## Properties
Property Name | Data Type | Description | Conformance | Notes
--- | --- | --- | --- | ---
`cds_curb_zone_ids` | Array; [String] | A list of [CDS Curb Zone](https://github.com/openmobilityfoundation/curb-data-specification/tree/main/curbs#curb-zone) `id`s. | Required |
`cds_curbs_api_url` | String; [uri](https://datatracker.ietf.org/doc/html/draft-handrews-json-schema-validation-01#section-7-3-5) | An identifier for the source of the requested CDS Curbs API. This MUST be a full HTTPS URL pointing to the main curbs API that contains detailed information about each curb zone identified in `cds_curb_zone_ids`.| Required |

## Used By
Property | Object
--- | ---
`impacted_cds_curb_zones` | [WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md)
1 change: 1 addition & 0 deletions spec-content/objects/WorkZoneRoadEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Name | Type | Description | Conformance | Notes
`is_end_position_verified` | Boolean | Indicates if the end position (last geometric coordinate pair) is based on actual reported data from a GPS-equipped device that measured the location of the end of the work zone. | Conditional; required if `ending_accuracy` is not provided. |
`location_method` | [LocationMethod](/spec-content/enumerated-types/LocationMethod.md) | The typical method used to locate the beginning and end of a work zone impact area. | Required |
`vehicle_impact` | [VehicleImpact](/spec-content/enumerated-types/VehicleImpact.md) | The impact to vehicular lanes along a single road in a single direction. | Required |
`impacted_cds_curb_zones`| Array; \[[CdsCurbZonesReference](/spec-content/objects/CdsCurbZonesReference.md)\] | A list of references to external [CDS Curb Zones](https://github.com/openmobilityfoundation/curb-data-specification/tree/main/curbs#curb-zone) impacted by the work zone. | Optional |
`lanes` | Array; \[[Lane](/spec-content/objects/Lane.md)\] | A list of individual lanes within a road event (roadway segment). | Optional | Please see [Business Rules](/Creating_a_WZDx_Feed.md#business-rules) #1 and #2.
`beginning_cross_street` | String | Name or number of the nearest cross street along the roadway where the event begins. | Optional |
`ending_cross_street` | String | Name or number of the nearest cross street along the roadway where the event ends. | Optional |
Expand Down