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 21 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
15 changes: 9 additions & 6 deletions Creating_a_WZDx_Feed.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,19 @@ The following business rules help assure a standardized and interpretable use of
### JSON Schemas
The WZDx Specification defines a JSON schema for each feed (WZDx v2.0 and later) within the [schemas](/schemas) directory. The repository contains schemas for the following feeds:

#### Current Version (4.0)
#### Current Version (4.1)
- [WZDx v4.1 WZDxFeed](/schemas/4.1/WZDxFeed.json)
- [WZDx v4.1 SwzDeviceFeed](/schemas/4.1/SwzDeviceFeed.json)
- [WZDx v4.1 RoadRestrictionFeed](/schemas/4.1/RoadRestrictionFeed.json)

#### Previous Versions
- [WZDx v4.0 WZDxFeed](/schemas/4.0/WZDxFeed.json)
- [WZDx v4.0 SwzDeviceFeed](/schemas/4.0/SwzDeviceFeed.json)
- [WZDx v4.0 RoadRestrictionFeed](/schemas/4.0/RoadRestrictionFeed.json)

#### Previous Versions
- [WZDx v2.0 WZDxFeed](/schemas/2.0/WZDxFeed.json)
- [WZDx v3.0 WZDxFeed](/schemas/3.0/WZDxFeed.json)
- [WZDx v3.1 WZDxFeed](/schemas/3.1/WZDxFeed.json)

- [WZDx v3.0 WZDxFeed](/schemas/3.0/WZDxFeed.json)
- [WZDx v2.0 WZDxFeed](/schemas/2.0/WZDxFeed.json)

### Self-Validation Checklist
For a list of steps to take to make sure your data feed conforms to the specification and is ready to publish, follow the [Self-Validation Checklist](/documents/WZDx_Data_Feed_Self-Validation_Checklist.docx).

Expand Down
45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Specifically, WZDx defines the structure and content of several [GeoJSON](https:
- [Project Description](#project-description)
- [Contact Information](#contact-information)
- [Release Notes](#release-notes)
- [Release v4.0 (Dec 2021)](#wzdx-v40-december-2021)
- [Release v4.1 (Aug 2022)](#wzdx-v41-august-2022)
- [Getting Started](#getting-started)
- [JSON Schemas](#json-schemas)
- [Contributions](#contributions)
Expand Down Expand Up @@ -83,32 +83,9 @@ Contact Information: [[email protected]](mailto:[email protected]?subject=Submission%20of%

## Release Notes

### WZDx v4.0 (December 2021)
WZDx version 4.0 implements clean up and small additions in functionality to the WZDx feed and adds definitions for two new feeds, the [SwzDeviceFeed](/spec-content/objects/SwzDeviceFeed.md) and [RoadRestrictionFeed](/spec-content/objects/RoadRestrictionFeed.md). Until version 4.0, the WZDx specification defined only one feed, the [WZDxFeed](/spec-content/objects/WZDxFeed.md).

*For detailed release information, see [RELEASES.md](/RELEASES.md)*

#### Features
- Add values to the [VehicleImpact](/spec-content/enumerated-types/VehicleImpact.md) enumerated type.
- Allow restrictions with a value and unit to be provided at the road event level.
- Add values to the [LaneType](/spec-content/enumerated-types/LaneType.md) enumerated type.
- Define a new data feed, the [RoadRestrictionFeed](/spec-content/objects/RoadRestrictionFeed.md), to enable providing a feed of restrictions on roadways, such as bridge clearances.
- Define a new data feed, the [SwzDeviceFeed](/spec-content/objects/SwzDeviceFeed.md), to enable equipment vendors and manufacturers to provide high-level information about deployed field devices in work zones.
- Rename the `workers_present` property on the [WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md) object to `worker_presence`; change the type from "boolean" to a new [WorkerPresence](/spec-content/objects/WorkerPresence.md) object which enables providing more nuanced information about worker presence in work zones.

#### Refactoring
- Separate the v3.1 RoadEvent object into [RoadEventCoreDetails](/spec-content/objects/RoadEventCoreDetails.md) (details that are shared by all specific types of road events) and specific types of road events ([WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md), [DetourRoadEvent](/spec-content/objects/DetourRoadEvent.md), and [RestrictionRoadEvent](/spec-content/objects/RestrictionRoadEvent.md)) which each contain the `RoadEventCoreDetails` via a `core_details` property; update the [RoadEventFeature](/spec-content/objects/RoadEventFeature.md) `properties` property to be one of the specific road events types.
- Move the `location_method` property from the [FeedDataSource](/spec-content/objects/FeedDataSource.md) object to the [WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md) object.
- Change the `reduced_speed_limit` property on the [WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md) to `reduced_speed_limit_kph`; change its type from "integer" to "number" and clarify that the value should be in kilometers per hour.
- Deprecate the `lane_number` property on the [Lane](/spec-content/objects/Lane.md) object.
- Deprecate the `lrs_type` and `lrs_url` properties on the [FeedDataSource](/spec-content/objects/FeedDataSource.md) object.
- Remove the deprecated value `alternating-one-way` from the [LaneStatus](/spec-content/enumerated-types/LaneStatus.md) enumerated type.
- Remove all deprecated properties from the road event (RoadEvent in previous versions; [WorkZoneRoadEvent](/spec-content/objects/WorkZoneRoadEvent.md) and [RoadEventCoreDetails](/spec-content/objects/RoadEventCoreDetails.md) in 4.0).
- Require the `road_names` property on the [RoadEventCoreDetails](/spec-content/objects/RoadEventCoreDetails.md).
- Require the `id` property on the [RoadEventFeature](/spec-content/objects/RoadEventFeature.md).
- Refine the [LaneType](/spec-content/enumerated-types/LaneType.md) enumerated type.
- Deprecate the `location_verify_method` property on the [FeedDataSource](/spec-content/objects/FeedDataSource.md).
- Update the [SpatialVerification](/spec-content/enumerated-types/SpatialVerification.md) enumerated type value descriptions to clarify that verified work zone locations should use a GPS enabled device.
### WZDx v4.1 (August 2022)

<TODO>

## Getting Started

Expand All @@ -124,16 +101,18 @@ The WZDWG welcomes feedback and comments on the WZDx v4.0 Specification. Comment
## JSON Schemas
The WZDx Specification defines a JSON schema for each feed within the [schemas](/schemas) directory. Schemas can be used to validate a WZDx feed document for compliance to the specification. The repository contains schemas for the following feeds:

### Current Version (4.0)
### Current Version (4.1)
- [WZDx v4.1 WZDxFeed](/schemas/4.1/WZDxFeed.json)
- [WZDx v4.1 SwzDeviceFeed](/schemas/4.1/SwzDeviceFeed.json)
- [WZDx v4.1 RoadRestrictionFeed](/schemas/4.1/RoadRestrictionFeed.json)

### Previous Versions
- [WZDx v4.0 WZDxFeed](/schemas/4.0/WZDxFeed.json)
- [WZDx v4.0 SwzDeviceFeed](/schemas/4.0/SwzDeviceFeed.json)
- [WZDx v4.0 RoadRestrictionFeed](/schemas/4.0/RoadRestrictionFeed.json)

### Previous Version
- [WZDx v2.0 WZDxFeed](/schemas/2.0/WZDxFeed.json)
- [WZDx v3.0 WZDxFeed](/schemas/3.0/WZDxFeed.json)
- [WZDx v3.1 WZDxFeed](/schemas/3.1/WZDxFeed.json)

- [WZDx v3.0 WZDxFeed](/schemas/3.0/WZDxFeed.json)
- [WZDx v2.0 WZDxFeed](/schemas/2.0/WZDxFeed.json)
## Contributions

**How do I contribute to the WZDx Specification?**
Expand Down
4 changes: 4 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# WZDx Specification v4.1

<TODO>

# WZDx Specification v4.0
Released December 2021

Expand Down
11 changes: 11 additions & 0 deletions schemas/4.1/BoundingBox.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$id": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/release/v4.1/schemas/4.1/BoundingBox.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "GeoJSON Bounding Box",
"description": "Information on the coordinate range for a Geometry, Feature, or FeatureCollection",
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
}
110 changes: 110 additions & 0 deletions schemas/4.1/FeedInfo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
{
"$id": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/release/v4.1/schemas/4.1/FeedInfo.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "WZDx Feed Information",
"description": "Describes WZDx feed header information such as metadata, contact information, and data sources",
"type": "object",
"properties": {
"publisher": {
"description": "The organization responsible for publishing the feed",
"type": "string"
},
"contact_name": {
"description": "The name of the individual or group responsible for the data feed",
"type": "string"
},
"contact_email": {
"description": "The email address of the individual or group responsible for the data feed",
"type": "string",
"format": "email"
},
"update_frequency": {
"description": "The frequency in seconds at which the data feed is updated",
"type": "integer",
"minimum": 1
},
"update_date": {
"description": "The UTC date and time when the GeoJSON file (representing the instance of the feed) was generated",
"type": "string",
"format": "date-time"
},
"version": {
"description": "The WZDx specification version used to create the data feed, in 'major.minor' format",
"type": "string",
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
},
"license": {
"description": "The URL of the license that applies to the data in the WZDx feed. This *must* be the string \"https://creativecommons.org/publicdomain/zero/1.0/\"",
"enum": [
"https://creativecommons.org/publicdomain/zero/1.0/"
]
},
"data_sources": {
"description": "A list of specific data sources for the road event data in the feed",
"type": "array",
"items": {
"$ref": "#/definitions/FeedDataSource"
},
"minItems": 1
}
},
"required": [
"update_date",
"version",
"publisher",
"data_sources"
],
"definitions": {
"FeedDataSource": {
"title": "WZDx Feed Data Source",
"description": "Describes information about a specific data source used to build the work zone data feed",
"type": "object",
"properties": {
"data_source_id": {
"description": "Unique identifier for the organization providing work zone data",
"type": "string"
},
"organization_name": {
"description": "The name of the organization for the authoritative source of the work zone data",
"type": "string"
},
"contact_name": {
"description": "The name of the individual or group responsible for the data source",
"type": "string"
},
"contact_email": {
"description": "The email address of the individual or group responsible for the data source",
"type": "string",
"format": "email"
},
"update_frequency": {
"description": "The frequency in seconds at which the data source is updated",
"type": "integer",
"minimum": 1
},
"update_date": {
"description": "The UTC date and time when the data source was last updated",
"type": "string",
"format": "date-time"
},
"lrs_type": {
"description": "**DEPRECATED** Describes the type of linear referencing system used for the milepost measurements",
"type": "string"
},
"lrs_url": {
"description": "**DEPRECATED** A URL where additional information on the LRS information and transformation information is stored",
"type": "string",
"format": "uri"
},
"location_verify_method": {
"description": "***DEPRECATED***The method used to verify the accuracy of the location information",
"type": "string"
}
},
"required": [
"data_source_id",
"organization_name"
]
}
}
}
Loading