Model schema doesn't display some fields of unknown type about play-swagger HOT 2 CLOSED

it looks like the Any value does show up in the definitions in the swagger.json file. e.g.,

{ 
  "properties": {
    "a": { "type": "string", "required": true },
    "b": { "type": "any", "format": "any", "required": true }
  }
}

In which case it's an issue with swagger itself not recognizing the any type and excluding it from the schema. It looks like it has to match one of swagger's valid data types, but I'm not sure that swagger was intended to document arbitrary JSON inputs, so none of the types really match.

I tried adding a mapping in SwaggerParameterMapper.scala, e.g.,

typeName match {
  /// ...
  case "Any" => prop("string", Some("any JSON value"))
  /// ...
}

hoping that swagger would display the text "any JSON value" in the schema, but it just displays as:

{
  "a": "string",
  "b": "string"
}

the same happens if I choose some other format like binary or byte.

anyway, not really sure that this can be solved in a way that makes sense.

from play-swagger.

Found a possible solution: you can provide swagger with an example value to use in the generated model schema (by default it uses 0 for ints, "string" for strings, etc), and it will use that value even if the type doesn't match one of the standard types.

I've opted to use a string "any JSON value" in this case -- see PR #8

from play-swagger.