Multidimensional param query

[Tom-Millard]

Q&A (please complete the following information)

• OS: macOS
• Browser: chrome
• Version: 72
• Method of installation: dist assets
• Swagger-Editor version: latest
• Swagger/OpenAPI version: OpenAPI 3.0

How can we help?

I am trying to create a multidimensional array as a parameter option, i would need to create something like this:

my.api.com/end-point?filter['option'][0]['value']='something'

I can reproduce this with type:object but i would get the following - my.api.com/end-point?filters['option'][0]={'value' : 'something'}

Im sure i am doing something wrong but i can not seem to find an example for this kind of pattern.

Any help would be appreciated.

[hkosova]

This scenario looks similar to the deepObject serialization style, however, the OpenAPI Specification defines the deepObject behavior only for simple objects (with primitive properties) but not for nested objects or objects containing arrays. Please see these discussions in the OpenAPI Specification repository:

Support deep objects for query parameters with deepObject style
Are indexes in the query parameter array representable?
OAI/OpenAPI-Specification#1006 (comment)

So this scenario needs to be added to the OpenAPI Specification first. Once the Specification is updated, tool developers can implement the new behavior.

[Tom-Millard]

@hkosova cheers for the reply will look into what you linked

[shockey]

Closing due to inactivity.

This is simply to keep our issue tracker clean - feel free to comment if there are any further thoughts or concerns, and we'll be happy to reopen this issue.