Add support for the `explode` query parameters

[sjoerdmulder]

I don't see that the explode definitions have any connection in the code currently.

Is it possible to add this support specified here: https://swagger.io/docs/specification/serialization/#query

What would be nice that the service API would expose an explode parameters as id: Array<number> instead of the id: number it is currently generated, so that you can easily pass multiple values.

[ferdikoomen]

@sjoerdmulder Yes, great idea, we have a similar problem with the FormData. See the ticket here: #658
I haven't prioritised this, since most projects I'm working on use JSON bodies for FormData and 'default' encoding for query params.

[sjoerdmulder]

Great I already have some POC code ready, will prepare a PR later this week Op di 27 apr. 2021 13:41 schreef Ferdi Koomen ***@***.***>:

…

@sjoerdmulder <https://github.com/sjoerdmulder> Yes, great idea, we have a similar problem with the FormData. See the ticket here: #658 <#658> I haven't prioritised this, since most projects I'm working on use JSON bodies for FormData and 'default' encoding for query params. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#654 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABZRYIQU2HHT5L43HE53TDTK2PHRANCNFSM42YXNLFA> .

[ferdikoomen]

@sjoerdmulder Cool, you probably already found these, but still good to mention:

Swagger (version 2)

• parameterObject allows you to set the collectionFormat to control the formatting: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#parameterObject

OpenAPI (version 3)

• requestBody allows you to control formatting with properties like style, explode, allowReserved: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#encodingObject
• parameter has similar properties style, explode, allowReserved: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#parameterObject

I would probably create the options for OpenAPI (version 3) and then see how to map then to the collectionFormat prop in the older Swagger format (version2).

[microHoffman]

Hey @ferdikoomen @sjoerdmulder , I have problem that is most likely related to this. Codegen incorrectly transforms the following:

        - in: query
          name: status__in
          schema:
            type: array
            items:
              type: number
          description: Multiple values may be separated by commas.
          explode: false
          style: form

into e.g.: ...?status__in=2&status__in=3... While the correct one should be status__in=2,3.

The problem is described here as well (tfranzel/drf-spectacular#599) with the explanation. Right now I need to hardcode the status__in parameter as comma-separated stringified values to have the query params value in correct format. Do you plan to implement this feature please? Thank you for any info, appreciate your work.

[Floppy012]

Right now I need to hardcode the status__in parameter as comma-separated stringified values to have the query params value in correct format.

I'm in the same situation right now. Would love to see support for the explode option.

[PaulVrugt]

same issue here, we need support for explode: false

[BierDav]

Is there a workaround for this?

[Floppy012]

Is there a workaround for this?

You could use the code from #1426