diff --git a/schemas/4.2/RoadEventFeature.json b/schemas/4.2/RoadEventFeature.json index 7e881224..74baf155 100644 --- a/schemas/4.2/RoadEventFeature.json +++ b/schemas/4.2/RoadEventFeature.json @@ -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" @@ -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", diff --git a/spec-content/README.md b/spec-content/README.md index 7d25fe2f..3838c0f8 100644 --- a/spec-content/README.md +++ b/spec-content/README.md @@ -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. diff --git a/spec-content/objects/CdsCurbZonesReference.md b/spec-content/objects/CdsCurbZonesReference.md new file mode 100644 index 00000000..862d7450 --- /dev/null +++ b/spec-content/objects/CdsCurbZonesReference.md @@ -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) diff --git a/spec-content/objects/WorkZoneRoadEvent.md b/spec-content/objects/WorkZoneRoadEvent.md index 42ee9ad4..8a3faa82 100644 --- a/spec-content/objects/WorkZoneRoadEvent.md +++ b/spec-content/objects/WorkZoneRoadEvent.md @@ -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 |