-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support "summary" field for ApiOperations #6
Labels
enhancement
New feature or request
Comments
Hi, I'm one of the original authors of springfox-javadoc. I just had to delete my company account because I no longer work for the company. This is my private account. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The Swagger 2.0 spec supports two fields on
@ApiOperation
: "summary" and "notes". In the current implementation, we set only the "notes" using the entire value of the comment.However, the Javadoc spec also supports a summary and a description. From the Javadoc tech notes:
Using this spec, we can provide both "summary" and "notes" for
@ApiOperation
. It can also be used on class docs to specify@Api
"tags".@dilipkrish, do you think this is a good approach? I can help with implementing this if you don't foresee any issues.
The text was updated successfully, but these errors were encountered: