search

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

Add event_time query parameter to events endpoint #140

Open jiffyclub opened 1 month ago

jiffyclub commented 1 month ago

Explain pull request

The events/events endpoint currently has no documented way to indicate the time range for which data is being requested. Without a clear, documented way of requesting historical data implementers of CDS are likely to come up with myriad solutions of their own.

This adds an event_time query parameter to the API endpoint that takes the form of an ISO 8601 UTC hour YYYY-MM-DDTHH so that the user can request all events that occurred within that specific hour. This is the same format used for MDS events 1. Unlike in MDS this query parameter is optional and if not specified the API should return all events that occurred in the last 60 minutes. I'm also open to making the parameter required.

Is this a breaking change

Impacted Spec

Additional context

Closes #107.

CLAassistant commented 1 month ago

CLA assistant check
All committers have signed the CLA.