OpenAPI query string parameter with list of objects

json swagger jsonschema openapi

This is not possible as of OpenAPI 3.1

OpenAPI 3.0/3.1 Specifications currently defines the deepObject behavior only for simple objects (with primitive properties) such as

{
  "id": 5,
  "name": "Bob"
}

but not for arrays and not for nested objects.

Since the behavior for arrays and nested objects is not defined, there's really no way to describe your query string. Technically, the only way would be to define filtered[0][id], filtered[0][value], etc. as individual query parameters.


If you are designing a new API (rather than describing an existing one), consider passing the array of objects in the request body instead.

As name implies, :), deepObject style only "provides a simple way of rendering nested objects", not arrays. At the least according to Version 3.0.1 it applies only to objects.

Note that even nested objects might be not yet supported by tools because the specification "does not provide such examples".

So your format is not compatible with Open API, yet may be you can define you query as parameters which follow a regex. I such cases usually I do my best yet provide some explanation

https://swagger.io/specification/

Update. Apparently, after somebody demanded a 'descriptive error' message for nested objects, a patch (PR) to support nested objects was suggested at https://github.com/swagger-api/swagger-js/pull/1450 . Regretfully it was decided not to incorporate this feature, and PR 1450 was rejected.

Related

Prove if $n^2$ is even, then $n^2$ is divisible by 4
Milnor Squares and Milnor Patching: Examples?
What is the correct formula of the kernel of the A$^*$A
How to find vector from point along line lying on a direction vector?
How can I calculate this integral using the fundamental theorem of calculus? [closed]
Trying to evaluate $\int \frac{1}{\sin(x)\cos^3(x)} \,dx$ and got stuck
Can every coloring of a graph be obtained by recoloring Kempe chains?
What is correct representation of homogenous coordinates?
Show that there is a countable disjoint collection $\{ I_k \}_{k = 1}^{\infty}$ of intervals
For any set of numbers $1$ through $n$, what is the average probability that two randomly selected derangements are derangements of each other?
Find all positive integers $x,y$ such that $(x+y)(xy+1)$ is a power of $2$ [duplicate]
Show without a calculator : $e^{-\gamma}<\omega$