Free-form query parameters does not seem to work according to spec

[rbjorklin]

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.0.0
Which Swagger-UI version?	3.4.2
How did you install Swagger-UI?	https://hub.docker.com/r/swaggerapi/swagger-ui/
Which browser & version?	Firefox 56.0
Which operating system?	Fedora 26

Demonstration API definition

openapi: 3.0.0                                                                                                                                                                                                       
paths:                                                                                                                                                                                                               
  /search:                                                                                                                                                                                                           
    get:                                                                                                                                                                                                             
      description: search                                                                                                                                                                                            
      operationId: search                                                                                                                                                                                            
      parameters:                                                                                                                                                                                                    
      - description: Free form query parameters as json object                                                                                                                                                       
        in: query                                                                                                                                                                                                    
        name: freeForm                                                                                                                                                                                               
        explode: True                                                                                                                                                                                                
        allowEmptyValue: True                                                                                                                                                                                        
        schema:                                                                                                                                                                                                      
          type: object                                                                                                                                                                                               
          additionalProperties:                                                                                                                                                                                      
            type: string                                                                                                                                                                                             
        style: form                                                                                                                                                                                                  
servers:                                                                                                                                                                                                             
- {url: 'https://encrypted.google.com'}

Configuration (browser query string, constructor, config.yaml)

{ "hl": "en", "q": "google" }

Expected Behavior

Based on my understanding of the style examples in the spec a free-form query parameter as described in the parameter object examples should produce a query string from a json object.

Meaning { "R": 100, "G": 200, "B": 150 } should be turned into R=100&G=200&B=150. (From examples)

Using the provided spec one can try with: { "hl": "en", "q": "google" } which should have produced a URL such as: https://encrypted.google.com/search?hl=en&q=google

Current Behavior

Using the provided spec a URL like this is produced: https://encrypted.google.com/search?freeForm={%20%22hl%22:%20%22en%22,%20%22q%22:%20%22google%22%20}

Possible Solution

Context

[shockey]

+1, I just bumped into this today. Trying to do the exact same thing - map an object's keys to query parameter names.

I think the value is being incorrectly interpreted as a string. Per the example table you cited, a parameter that is style: form explode: true with a string value would produce color=blue.

If you pretend that { "hl": "en", "q": "google" } is actually being treated as a string, you'd get this:

freeForm=${escapeWithPercentEncoding('{ "hl": "en", "q": "google" }')}

which, would you look at that, is the same thing as freeForm={%20%22hl%22:%20%22en%22,%20%22q%22:%20%22google%22%20}.

[rbjorklin]

Has there been any progress on this issue? Problem is still present on 3.14.0.

[kand617]

+1 also waiting on this issue

[raubel]

+1 does not seem to work for me as well (or the documentation is not clear)

[shockey]

Hi everyone, this was fixed in #4563:

We'll ship a new version of Swagger-UI tomorrow, which will include this new feature.

Thanks!

[lock]

Locking due to inactivity.

This is done to avoid resurrecting old issues and bumping long threads with new, possibly unrelated content.

If you think you're experiencing something similar to what you've found here: please open a new issue, follow the template, and reference this issue in your report.

Thanks!