swagger

swagger copied to clipboard

First, Great Job for this ! It's written in the technical notes that the type aliasing discovery is working. I'm doing something like : ``` type String string ``` to...

JeanCaron

Although the docs says annotations are case-insensitive, this one is case-sensitive: using @SubAPI instead of @SubApi prevents the sub-API from being discovered.

fgm

I created a [test repo](https://github.com/giantswarm/swagger-test) to show the problem. To reproduce, just check out the test repo and do `make`. Further have a look at [main.go](https://github.com/giantswarm/swagger-test/blob/d77a384a31cf5d33de0eb99e6f1ae4efc6fd5d81/main.go). Problem is that imports...

xh3b4sd

Add a -format="html" option (if anyone wants it).

2

This should be trivial. It's just a matter of implementing the 9 methods of the Markup interface. If anyone wants this, just say so in a comment, below.

polyglot-jones

The 3 markup reports are probably still missing a few data points.

1

For example, the report does not currently reflect the "{array}" vs. "{object}" specifications in the @Success/Failure lines.

polyglot-jones

To be used as a further description, particularly with respect to what parts of the API are subject to change. For example, `@APIStatus The /foo resources are all protoypes that...

polyglot-jones

(This is a reminder to myself.) Allow the words "required" and "optional" to be used in the 4th position of an @Params line (instead of "true"/"false") as soon as I...

polyglot-jones