Add support for Maps / additionalProperties

[newtechfellas]

How to specify the swagger documentation annotation for generating model schema for Map attribute in a Java bean?

//groovy code
class Foo {
  int id
  String description
  Map<String, Bar> targets
  //few other attributes
}

For targets attribute, swaggerui shows 1 line but does not give the model schema for Bar class.

targets (Map[string,Bar])

How do I get Bar class Model schema as well in UI? Am using latest swagger library ('com.wordnik:swagger-jersey-jaxrs_2.10:1.3.8')

[webron]

Swagger currently doesn't support maps, but the new version of it which is
really close is going to.
On Sep 3, 2014 10:49 PM, "newtechfellas" notifications@github.com wrote:

Reopened #558 #558.

—
Reply to this email directly or view it on GitHub
#558 (comment).

[newtechfellas]

hmm thank you for the clarification. Any tentative date of new version with Map support?

[webron]

About a week.

On 3 September 2014 23:57, newtechfellas notifications@github.com wrote:

hmm thank you for the clarification. Any tentative date of new version
with Map support?

—
Reply to this email directly or view it on GitHub
#558 (comment).

[newtechfellas]

Is this available now? If yes. any sample documentation on which swagger annotations to add for Map attribute?

[webron]

This is more of a swagger-core issue, but you can try using 1.5.0-SNAPSHOT.
Keep in mind it's fresh so there may be bugs with it.

On 23 September 2014 18:48, newtechfellas notifications@github.com wrote:

Is this available now? If yes. any sample documentation on which swagger
annotations to add for Map attribute?

—
Reply to this email directly or view it on GitHub
#558 (comment).

[fehguy]

Yes, you can use the following annotations in an operation:

@ApiOperation(
  value = "",
  notes = "",
  response = ResponseMessage.class,
  responseContainer = "Map")

For a model:

https://github.com/wordnik/swagger-core/blob/develop_2.0/modules/swagger-core/src/test/scala/models/Person.java#L9

will produce this:

{
  "Person": {
    "properties": {
      "id": {
        "type": "integer",
        "format": "int64"
      },
      "firstName": {
        "type": "string"
      },
      "address": {
        "$ref": "Address"
      },
      "properties": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      },
      "birthDate": {
        "type": "string",
        "format": "date-time"
      },
      "float": {
        "type": "number",
        "format": "float"
      },
      "double": {
        "type": "number",
        "format": "double"
      }
    }
  }
}

[newtechfellas]

It did not work. I tried with latest com.wordnik:swagger-jersey-jaxrs_2.10:1.3.10 version. Swagger doc still shows targets (Map[string,Bar]) for attribute of type Map and no expansion for Bar class properties. (Referring to Foo class in my question)
Also tried the responseContainer attribute for @ApiOperation annotation. No difference with this either.

@ApiOperation(value = "get foo details for person id and foo id", response = Foo, responseContainer = "Map")

[fehguy]

You need to be using 1.5.0-SNAPSHOT as the dependency.

[lluu]

the javadoc says 'Valid values are "List", "Array" and "Set"'.. support for Map is new?

[webron]

The javadocs are based on the 1.3.X release, not updated to 1.5.X yet.

[newtechfellas]

where would I find 1.5.0-SNAPSHOT version? I checked http://repo1.maven.org/maven2/com/wordnik/ but did not find it.