Query parameter with comma-separated strings in Swagger returns structural error

Question

I am trying to define a query parameter in Swagger with comma-separated strings from a predefined set of items like ?fruits=Apples,Oranges,Bananas but I get the following error from the swagger editor

should NOT have additional properties additionalProperty: style, explode

What I am trying in the Swagger Editor is:

    - in: query
      name: fruits
      style: form
      explode: true
      required: false
      description: Filter by fruits
      type: array
      items:
        type: string
        enum:
          - Apples
          - Oranges
          - Bananas

Possible duplicate of Swagger: take one or more values from enum — Helen
– Helen, Commented May 17, 2019 at 11:17

Helen · Accepted Answer · 2019-05-17 11:17:03Z

8

style and explode are OpenAPI 3.0 keywords. But you seem to be using OpenAPI 2.0, which uses collectionFormat instead. In this case you need collectionFormat: csv (it's the default option and can be omitted).

answered May 17, 2019 at 11:17

Helen

99.8k18 gold badges280 silver badges352 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

josemmo Over a year ago

For those using OpenAPI 3.0, the equivalent combination is style: form (default) and explode: false

Collectives™ on Stack Overflow

Query parameter with comma-separated strings in Swagger returns structural error

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related