[2.0 Spec] Schema "properties" does not implement attribute "readOnly"

[giuseppegreco]

Schema "properties" does not implement attribute "readOnly". For example, the following code snippet does not compile...

import com.wordnik.swagger.annotations._

@ApiModel(value = "Account", description = "Represents an user account")
trait Account {

  @ApiModelProperty(value = "The identifier of the account", dataType = "string", readOnly = true, position = 1)
  def id: Option[String]
  ...
}

... and always produce the following error message:

  [error] /home/j3d/Projects/xxxxxx/modules/common/app/models/api/Account.scala:19: unknown annotation argument name: readOnly
  [error]   @ApiModelProperty(value = "The identifier of the account", dataType = "string", readOnly = true, position = 1)

Thanks,
j3d

[vandeti]

Jackson currently has limited support for ignoring fields on deserialise only (see link below). Through a combination of JsonIgnore on field and setter and JsonProperty on getter you can get this kind of behaviour but it's more a trick then a feature. Even though this will get you the serialisation behaviour it will obviously not get you the correct swagger Model.

The swagger model converter uses the com.fasterxml.jackson.databind.AnnotationIntrospector to abstract the actual annotations being used (jaxb, Jackson or ModelAPI ). Unless the readOnly concept is added on that API (and then also in the jackson deserialiser), I see no clean way to add it to swagger given the current design.

see: FasterXML/jackson-databind#95

Kr,

Tim