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

1

8

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
Keelykeen answered 17/5, 2019 at 11:8 Comment(1)
Possible duplicate of Swagger: take one or more values from enumSpite
S
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).

Spite answered 17/5, 2019 at 11:17 Comment(1)
For those using OpenAPI 3.0, the equivalent combination is style: form (default) and explode: falsePickett

© 2022 - 2024 — McMap. All rights reserved.