Deeply-nested arrays/objects aren’t supported in query params

[lubomirblazekcz]

Description

Currently deeply-nested arrays/objects aren’t supported. I understand that it's because of the openapi spec.

Proposal

Recently there was some development in that area - OAI/OpenAPI-Specification#1706 (comment)

Is that something that can be addressed in the current implementation? For example stringify deeply nested arrays/objects as JSON? (unjs/ufo does that)

Or qs style support with [] or [0] delimiters? Something that languages like PHP support natively?

Extra

• I’m willing to open a PR (see CONTRIBUTING.md)

[drwpow]

I’m not sure I understand, is this just for query params? Could you give an example?

[lubomirblazekcz]

Oh sorry yes, I meant query params.

For example this type of array is not supported currently, we had to use custom querySerializer for our project:

{
  "children": [
    {
        "age": 9,
        "bed": true
    },
    {
        "age": 1,
        "bed": false
    }
  ]
}

[drwpow]

Ah I see. You’re right, this isn’t supported today. Making your own serializer is expected in this case! It’s a tradeoff because the more serializers we support out-of-the-box, the bigger the footprint is of the runtime library. And the bigger the chance that more people ask to maintain their custom serializer that others may want different behavior from.

I think where I’d probably stand on this is:

• If someone wanted to open a PR adding bare-minimum support for this, in a way that’s compatible with the current behavior I’d be open!
  • Note: to your example, e.g. is it [] or [0] delimiters, would be “dealer’s choice” i.e. the person that adds the support will “flip a coin” and that’s the way it will be
• Beyond bare-minimum support, though, I’d probably say querySerializer() is the way to go for everyone.