Schema type generator about play-swagger HOT 9 CLOSED

can you be more specific about the following paragraph?

it's only apear when add field
test: Either[Unit, Option[Test2Input]]

seems to me the same field you have on the class above.

from play-swagger.

Yes they looks similar

  value: Either[Unit, String],
  property: Either[Unit, Option[String]],
  dateTime: Either[Unit, Option[DateTime]]

but behave different, probably because types used for field above are mapped into default JS types from standard packages
com/iheart/playSwagger/SwaggerParameterMapper.scala#L21

from play-swagger.

I think this is a bug when type with binary type parameters (in your case Either) is involved. In particular
https://github.com/iheartradio/play-swagger/blob/master/src/main/scala/com/iheart/playSwagger/SwaggerParameterMapper.scala#L11-L12
doesn't handle such high order types properly.
It might take us some time to get to this bug, but any contribution would be highly appreciated.

from play-swagger.

Yes it's extract wrong type name eg. class test.Test2Input]

from play-swagger.

How do you encode a high kinded type with binary type parameter in Json? We can parse a value to an Either for sure, but I am not sure how to express it as a swagger schema (like property left and property right?). @joprice any ideas?

from play-swagger.

I have the same problem with a Map[String, Set[B]]:

  final case class PlotPoint(left: BigDecimal, right: BigDecimal)
  final case class ScatterPlot(data: Map[String, Set[PlotPoint]])

With exception

[info] - Swagger - swagger spec exposed *** FAILED ***
[info] scala.ScalaReflectionException: class io.timeli.sdk.MeasurementsSDK.PlotPoint] in JavaMirror with sun.misc.Launcher$AppClassLoader@573fd745 of type class sun.misc.Launcher$AppClassLoader with classpath [...] not found.
[info] at scala.reflect.internal.Mirrors$RootsBase.staticClass(Mirrors.scala:123)
[info] at scala.reflect.internal.Mirrors$RootsBase.staticClass(Mirrors.scala:22)
[info] at com.iheart.playSwagger.DefinitionGenerator.definition(DefinitionGenerator.scala:44)
[info] at com.iheart.playSwagger.DefinitionGenerator.com$iheart$playSwagger$DefinitionGenerator$$allReferredDefs$1(DefinitionGenerator.scala:57)
[info] at com.iheart.playSwagger.DefinitionGenerator$$anonfun$com$iheart$playSwagger$DefinitionGenerator$$allReferredDefs$1$1.apply(DefinitionGenerator.scala:65)
[info] at com.iheart.playSwagger.DefinitionGenerator$$anonfun$com$iheart$playSwagger$DefinitionGenerator$$allReferredDefs$1$1.apply(DefinitionGenerator.scala:64)
[info] at scala.collection.LinearSeqOptimized$class.foldLeft(LinearSeqOptimized.scala:124)
[info] at scala.collection.immutable.List.foldLeft(List.scala:84)
[info] at com.iheart.playSwagger.DefinitionGenerator.com$iheart$playSwagger$DefinitionGenerator$$allReferredDefs$1(DefinitionGenerator.scala:64)
[info] at com.iheart.playSwagger.DefinitionGenerator$$anonfun$allDefinitions$1.apply(DefinitionGenerator.scala:71)
[info] ...

from play-swagger.

as of now, play-swagger does not understand type with multiple type parameters. One option is to use custom type mapping https://github.com/iheartradio/play-swagger#how-to-override-type-mappings

from play-swagger.

Can anyone involved in this discussion has figured out a way to define a working custom mapping override for this example:
final case class ScatterPlot(data: Map[String, PlotPoint])
?

from play-swagger.

For swagger v3, you can express Either in a straightforward manner using the oneOf descriminator

from play-swagger.