OpenAPI query string parameter with list of objects

by

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.

More Related Contents:

  1. Post a json body with swagger
  2. OpenAPI path/query parameters nested structure serialization
  3. Tool to generate JSON schema from JSON data [closed]
  4. OpenAPI: what schema to accept any (complex) JSON value
  5. How to use definitions in JSON schema (draft-04)
  6. Only allow properties that are declared in JSON schema
  7. Schema object without a type attribute in Swagger 2.0
  8. json.Marshal(struct) returns “{}”
  9. Load images based on dynamic path in ReactJs
  10. Json.NET require all properties on deserialization
  11. How to specify if a field is optional or required in OpenAPI/Swagger?
  12. JSON integers: limit on size
  13. Get ffmpeg information in friendly way
  14. Python 3, read/write compressed json objects from/to gzip file
  15. How can I deserialize JSON with a top-level array using Serde?
  16. How to marshal a byte/uint8 array as json array in Go?
  17. Swagger 2.0: Multiple Path objects with different paths but same request and response
  18. How to create index on JSON field in Postgres?
  19. Deserialize JSON / NSDictionary to Swift objects
  20. Accessing Nested Map of Type map[string]interface{} in Golang
  21. pass JSON to HTTP POST Request
  22. How to parse JSON in golang without unmarshaling twice
  23. Could not write JSON: Infinite recursion (StackOverflowError); nested exception spring boot
  24. Swift 4 Codable – Bool or String values
  25. oneOf in Swagger schema does not work
  26. Filter Array Using Checkboxes with AngularJS
  27. How can I do JSON serializer ignore navigation properties?
  28. Very large HTTP request vs many small requests
  29. Error handling using JSONDecoder in Swift
  30. Why `additionalProperties` is the way to represent Dictionary/Map in Swagger/OpenAPI 2.0

Leave a Comment