Consider listing Model Schema / Example Value

[gnidan]

It would be nice to have bootprint output the swagger-ui-style Model Schema, which provides something of an example value as documentation (original discussion at #29 (comment))

[gnidan]

Just to followup, I did a bit of digging around for this, and it appears the behavior does come from swagger-js and not swagger-ui. The method appears to be called createJSONSample, defined at https://github.com/swagger-api/swagger-js/blob/master/lib/types/model.js#L23

[gnidan]

Oh, but this project doesn't seem to use swagger-js at all? I guess that changes the extent to which I can look into this :)

[nknapp]

No currently, I don't. I started off with a simple Handlebars template and everything else grew around it.

I have no problem including new libraries, but I always try to keep bootprint-swagger small (although it may not seem to). Looking at the dependency tree, swagger-js (aka. swagger-client) adds a couple of dependencies that will increase this size by a few megabytes and it is already to large.

On the other hand, the code is under apache license (a good part of the code seems to be at https://github.com/swagger-api/swagger-js/blob/master/lib/schema-markup.js#L100 btw. It does seem to be pretty straight forward. Maybe it is not that hard to reimplement. This should be done in a separate module however, so that other people can use it too.

I don't know if I find time to do this. But I would certainly be in for a code-review.

[gnidan]

I also may or may not be able to find the time to do this. My team lead mentioned he would set up tooling so that I can concentrate on writing our spec; I will propose this to him and see if together we can find bandwidth to implement something.