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 19 forks source link

Add Additional Field to Events API for Computer-Vision based systems #146

Open rneubauer opened 1 month ago

rneubauer commented 1 month ago

Is your feature request related to a problem?

Yes, when providing events from our Computer vision based inferencing there is no way to provide the camera device or to add meta-data included in the events like color, license plate, logo, and confidence score, etc.

NOTE: We will also be adding an Issue to the Curbs API to add devices like Cameras or Sensors defined so they can be used for these events and other events like double-parking events that we will also be submitting another issue for.

Describe the solution you'd like

We would like to add some additional fields to the Events API to solve this.

Is this a breaking change

A breaking change would require consumers or implementors of an API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

Impacted Spec

For which spec is this feature being requested?

Events

Describe alternatives you've considered

There are no other possible options in the CDS to solve this issue.

Additional context

Add any other context or screenshots about the feature request here.

rneubauer commented 1 month ago

Here is what we have planned thus far to propose. It probably needs additional fields, but we believe this is a good start to solving our needs. I have attached a PDF of the additions to the Events API that we would like to add.

NEX-CDS Curb _ CV Events Additions-240924-043833.pdf