Model documentation

[gpoirier]

How do we add documentation on the model like field descriptions? The only thing I could see was from a .md file in github where we can add doc using withSerializer on DefaultSwaggerFormats, but it doesn't seem very convenient. I tried adding the swagger-api annotations on the case class to document the fields, but those were ignored.

Is there a better way that I'm missing?

Also, it would also be nice that the model documentation was put together using a type class rather than reflection like it currently seems to be doing.

[gpoirier]

hmm, I realized after posting that I should have looked at other issues first. Looks like someone asked a similar question just before me: #220