Support for arbitrary query strings

Hello! I’m trying to use the OpenAPI 3.0 spec to document an API that supports a subset of the Resource Query Language (RQL). However, because this query string format doesn’t adhere to the typical name=value parameter structure, I’m struggling to express it in OpenAPI.

For example, a valid query string might be: http://localhost:5000/books?select(title,author)&gt(published,2000-06-30T12:20:08Z)&sort(published).

I wouldn’t expect OpenAPI to understand RQL, but if there were a way to specify that an endpoint may have a query string, and that the query string contents are beyond the scope of OpenAPI, that would suffice. (I’m really thinking from the Swagger UI perspective – so a user wanting to try the API can type in the entire RQL query string themselves.)

If anyone has any thoughts on other ways this can be accomplished with the existing 3.0 specification, that would be great too!

Thanks, Paul

[hkosova]

@keyz182 your scenario can be described by using a deepObject-style parameter:

      - in: query
        name: filter
        required: false
        schema:
          type: object
          additionalProperties: true
          example:
            foo: bar
            inputs.datetime.gte: 242839744
        style: deepObject

        # The example translates to:
        # ?filter[foo]=bar&filter[inputs.datetime.gte]=242839744

[handrews]

@pofallon yeah that is why I was thinking we’d need a new “in” value. in: query assumes application/x-www-form-urlencoded. The content just applies to the value of the URL-encoded value, not the query string as a whole.

So in: queryContent or in: wholeQueryString or something like that.

(troll mode: or, just fully support RFC 6570 😃