openmobilityfoundation / curb-data-specification

A data specification to help cities manage their curb zone programs and surrounding areas, and measure the utilization and impact.
https://www.openmobilityfoundation.org/about-cds/
Other
47 stars 18 forks source link

CDS Feed Validator using OpenAPI #130

Open schnuerle opened 8 months ago

schnuerle commented 8 months ago

If you are interested in the creation of a tool that can validate your public or private CDS endpoints, please leave you thoughts in this discussion. This would leverage our existing CDS OpenAPI schema.

You can mention why you need this, how you would use it, if you are willing to help build it, how you think it should work, how it could be built, what platform it should be on, etc.

bhamlinSDOT commented 4 months ago

I see value in a tool like this, especially for cities that are working on SMART grants where having a valid, publicly accessible CDS feed is a key deliverable. Being able to show that your feed is valid and aligns with CDS requirements will give city vendors, researchers, app developers, etc. confidence to use the data end point. (there could be inaccuracies in the data but that's more of a city problem vs a CDS quality problem)

The specification itself creates a common denominator for communicating curb information but the validator ensures everyone is on the same page. Does MDS have a similar tool available or is it more of a non-issue?

mplsmitch commented 4 months ago

The GBFS validator is a good example of what this might look like. It's built on JSON Schema but Open API would be similar. This link will run it against the feeds from Metro Bike in LA GBFS Validator - Metro Bike LA

andrewdgh commented 4 months ago

Leveraging the OpenAPI schema is a good idea to create a validator that can add credibility - or confidence - to a CDS feed.

alexdemisch commented 4 months ago

Completely agree with all of the above. A CDS validator would be a great resource for development, troubleshooting, and ensuring that requirements in contracts/permits/agreements are met. Like Brian said, it can't solve for inaccurate data, but making sure that data conforms to the spec is the first step.

San Francisco uses MobilityData's validator to ensure that our scooter permittees are publishing valid GTFS feeds (per our permit requirements), and it works great.

We need one for MDS as well - not sure if there are any opportunities to build validators for both specs at the same time? We're in the process of upgrading to MDS 2.0 and a validator would've saved us a lot of time. It would also be great if a validator could read an agency's Policy Requirements to guide the review of CDS/MDS feeds.