[openstack-dev] [all][API WG] How does one best express a time interval as an API filtering query?

Everett Toews everett.toews at RACKSPACE.COM
Thu Oct 6 16:31:28 UTC 2016


> On Oct 6, 2016, at 10:43 AM, Jeremy Stanley <fungi at yuggoth.org> wrote:
> 
> On 2016-10-06 10:30:30 -0500 (-0500), Kevin L. Mitchell wrote:
> [...]
>> Problem with that is that ':' is a valid character within an ISO date,
>> though I do like the 'between' prefix.  Now, '/' can be used if it's URL
>> encoded, but I agree that that is non-ideal.  How about a syntax
>> something like:
>> 
>>        ?finished_at=between:ISO_DATE_A at ISO_DATE_B&finished_at=between:ISO_DATE_C at ISO_DATE_D
> 
> I'll admit I'm not up on the intricacies of URL expectations for
> APIs, but why not just use a comma? That's not an unusual meaning
> for it as punctuation (at least in English), and has the property
> that it's not overloading a typical field separator within either
> 8601 or HTTP encodings. (Now I've fulfilled my bikeshed quota for
> the month.)

We chatted about this at the API WG meeting today. This seems reasonable to us too.

?finished_at=between:ISO_DATE_A,ISO_DATE_B

@milanisko I encourage you to propose this change to the filtering guideline! [1]

Contributing is easy, same as any other OpenStack project. See #2 under How to Contribute. [2]

[1] https://github.com/openstack/api-wg/blob/master/guidelines/pagination_filter_sort.rst#filtering
[2] https://wiki.openstack.org/wiki/API_Working_Group#How_to_Contribute






More information about the OpenStack-dev mailing list