When adding @ApiOperation all operations need to be annotated

[MartinAhrer]

When adding @ApiOperation all operations need to be annotated. If only a single @ApiOperation annotation is added, all remaining (non-annotated) API operations will not be included in the documentation.

[wkennedy]

Hi Martin, I'm not quite sure what you are stating here. This sounds like it is working designed. If the method is not annoated with the ApiOperation then it should not be included int he documentation. Can you clarify a bit?

Thanks!

[MartinAhrer]

But really the current behaviour is as following given we have a controller with n>1 methods

• Do not add @ApiOperation to any of the methods -> All methods are shown in the documentation
• Add @ApiOperation to a subset of the methods then only these are shown in the documentation

To be really consistent then no method may be listed when no method was annotated with @ApiOperation.

So what is the intention: In many case the request path is self describing, so I wouldn't add a @ApiOperation just for documentation purpose. I would only add it where it was really necessary to explain the intent. I mean a controller implementation can really get bloated by adding all those swagger annotations. Especially when you have to start repeating metadata like request path, etc.