swagger-play icon indicating copy to clipboard operation
swagger-play copied to clipboard

@ApiImplicitParam is not converted to expected json spec

Open JFCote opened this issue 8 years ago • 0 comments

Hi!

I'm trying to declare an implicit param that is an array of String in the "csv" format. The yaml look like this for the parameter:

parameters:
        - name: tags
          in: query
          description: tags to filter by
          required: false
          type: array
          items:
            type: string
          collectionFormat: csv

My annotation looks like this:

@ApiImplicitParams({
        @ApiImplicitParam(name = "tags", value = "tags to filter by", allowMultiple = true, dataType = "string", paramType = "query")
    })

But the generated json is like this:

"parameters" : [ {
          "name" : "tags",
          "in" : "query",
          "description" : "tags to filter by",
          "required" : false,
          "type" : "string",
          "items" : {
            "type" : "string"
          }
        }]

First, it looks to me that the @ApiImplicitParam is missing very useful param like "container" or something like that. I'm not even sure "allowMultiple" purpose is to tell that it's an array, but if it's the case, then the generation doesn't work.

I'm using version 1.5.3 with Play Framework 2.5

Thanks!

JFCote avatar Feb 06 '17 20:02 JFCote