How can I extend all models with x-nullable extensions if the type is Option?

[jenol]

I am using this tool on a large Akka HTTP project and I am very pleased with it. Keep up the good work!

I need a bit of help with one issue though. I would like to enrich all model types with an x-nullable vendor extension for property types of Option. This seems to be the most common workaround to support nullable types in Swagger 2.

I cannot decorate the models directly with annotations (because they are generated by protoc) and I am looking for a way to enrich the model types with nullable hints.

I see that there is a io.swagger.jaxrs.config.ReaderListener I can use to change the swagger document but I am not sure where I could register it and how to add the extension values on Option type. If you give me some direction, I could create a PR for this if code changes are needed.

Thank you for your help in advance.

[jenol]

I figured it out. I need to add the listener to the apiTypes.

[pjfanning]

@jenol if you could do a small sample demonstrating your solution on your github or bitbucket account, I can link to it from the README page.
If the solution needs a change in swagger-akka-http, could you provide a Pull Request?

[jenol]

@pjfanning this is how far I got. I still need a way to recognize the original property type. I can add the x-nullable based on that.

io.swagger.models.properties.Property doesn't seem to have a reference to the original type or original type name which would make things easier. I need to check if I can use required or format or a combination of properties to figure out if the type meant to be nullable. For this I will need to look deeper into the reader implementation.

https://gist.github.com/jenol/975ea072e60a893efedb9d51643ac812

[pjfanning]

Options should have property.isRequired() == false

[jenol]

It looks like getRequired is true for Option property types. I will keep digging

[pjfanning]

https://github.com/swagger-akka-http/swagger-akka-http/blob/master/src/main/scala/com/github/swagger/akka/SwaggerScalaModelConverter.scala has the support scala.Option - maybe you could add an option test case that demonstrates an option that isn't appearing as required=false (see the src/test dir for existing unit tests like this)

[jenol]

Good suggestion. I will do that. Thank you

[jenol]

I did some testing and getRequired seems to work correctly but the type is not correct. I updated the gist.

class Jeno(val test: Option[Int],
		val test2: Option[Boolean],
		val test3: Option[BigDecimal],
		val test4: Option[BigInt],
		val test5: Option[String])

Should generate

"Jeno" : {
  "type" : "object",
  "properties" : {
	"test" : {
	  "type" : "integer",
	  "format" : "int32",
	  "x-nullable" : true
	},
	"test2" : {
	  "type" : "boolean",
	  "x-nullable" : true
	},
	
	....
	
	"test5" : {
	  "type" : "string",
	  "x-nullable" : true
	}
  }
}

but generates

"Jeno" : {
	"type" : "object",
		"properties" : {
		"test" : {
		  "type" : "object",
		  "x-nullable" : true
		},
		"test2" : {
		  "type" : "object",
		  "x-nullable" : true
		},
		"test3" : {
		  "$ref" : "#/definitions/BigDecimal",
		  "x-nullable" : true
		},
		"test4" : {
		  "$ref" : "#/definitions/BigInt",
		  "x-nullable" : true
		},
		"test5" : {
		  "type" : "string",
		  "x-nullable" : true
		}
	}
}
"BigDecimal" : {...},
"BigInt" : {...}

[jenol]

@pjfanning do you think this change would fix this issue?

https://github.com/jenol/swagger-akka-http/commit/14805d6fb0dcd00251e01cde6146378c8a1542ec

[pjfanning]

@jenol your code does not compile and it looks like a lot of unit tests will be affected by the change
Could you try to add new unit tests for your change and test with sbt clean test? If you get a working change, could you create a Pull Request?

[jenol]

Sorry about that. I am having issues with setting up the project on Windows and IntelliJ. I should have sent a gist. I just wanted to show the part of the code which may not handle all option types correctly. I will keep at it when I have a bit of time. :)

[pjfanning]

The code for inferring swagger models from Java/Scala classes is based on Java reflection and jackson-databind. It appears that for Option[T] where T is a primitive type like Int/Long/Double that this type info is erased.
One workaround would for you to subclass some of the classes that are causing you problems and to use swagger annotations on the subclasses to correct any issues in the models.

[ddfic]

hi @pjfanning not sure if I understand...
if Option[Int] is causing problems for us you suggest subclassing Option? sound pretty bad ;)

[pjfanning]

@ddfic I meant subclassing the classes generated by protoc

[ElfoLiNk]

Hello, i saw this issue after we upgraded to 0.13.0 Option[Int] stopped working correctly it is generated as object in the swagger json. The latest version were Option[Int] was converted correctly is 0.12.0. I created #72