swagger-api / swagger-core

Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
http://swagger.io
Apache License 2.0
7.37k stars 2.17k forks source link

`AnnotatedType` is missing javadoc #4639

Open lfgcampos opened 6 months ago

lfgcampos commented 6 months ago

While investigating an issue related to types and inheritance, seems like working on a ModelConverter is the answer. But when trying to work on that, I've found extremely hard because AnnotatedType has no javadoc at all.

Some solutions found here, for instance, suggest marking resolveAsRef as false. Others do check validations on type depending on the parent value. Even though most of that is quite "guessable" after playing with swagger for a while, having javadoc is crucial in my opinion.