I use Swagger-php. When I define a parameter that's on the query string it can be an array. But from what I can see, it doesn't support this kind of querystring:
* description="A list of IDs (separated by pipes) to filter the Returns",
"description": "A list of IDs (separated by pipes) to filter the Returns",
Unfortunately, it is not possible to get exactly the URL you provide (
https://api.domain.tld/v1/objects?q=1&q=5&q=12) for an array query parameter.
Assuming that you want to define a 1 dimension array query parameter (the github issue you're refering to concerns multi-dimensional arrays), here's what the current OpenAPI (fka. Swagger) Specification can propose:
If you use an array with a collection format like
pipes (you can also use
tsv to get different separators) the URL will look like this:
But this is not the syntax you're looking for: all array items are defined in a single
q query parameter.
Fortunately, there is another collection format
multi allowing to define each array's item in its own
q parameter, with this one you can almost get what you want minus the
You can read more about this in this OpenAPI (fka. Swagger) tutorial (disclosure: I wrote it) and in the specification itself (ParameterObject description)