Swagger UI not sending array correctly

Question

I am trying to send multiple values (an array) (refer to on line 93 in spec ->... name: recipients[] ...)

The problem I am facing is the Swagger-ui call the endpoints as below:

Actual

recipients[]=value1%2Cvalue2

Expected

recipients[]=value1&recipients[]=value2

The %2C means , (comma).

Below are the required details swagger-ui version 2.1.1 Below is the link for content of the swagger spec file reproducing the issue: http://pastebin.com/V3ZuCjVz

mzulch · Accepted Answer · 2016-03-31 17:21:31Z

5

It looks like the way to specify this is to add collectionFormat: multi

- name: recipients[]
  in: formData
  description: Email addresses for recipients (multiple values allowed).
  required: true
  type: array
  collectionFormat: multi
  items:
      type: string

Possible values from http://swagger.io/specification/ are:

csv - comma separated values foo,bar.
ssv - space separated values foo bar.
tsv - tab separated values foo\tbar.
pipes - pipe separated values foo|bar.
multi - corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz. This is valid only for parameters in "query" or "formData".

answered Mar 31, 2016 at 17:21

mzulch

1,54812 silver badges14 bronze badges

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

2 Comments

Tabu Over a year ago

I tried this, but still not working :(. here is the swagger spec after the changes: pastebin.com/t47xjFQw (refer to recipients)

Tabu Over a year ago

I have reported this issue with swagger-ui (also swagger-js) project. The team is responsive and they are working on it. These are the urls: github.com/swagger-api/swagger-ui/issues/2067 github.com/swagger-api/swagger-js/issues/749

Collectives™ on Stack Overflow

Swagger UI not sending array correctly

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related