Skip to content

Support "summary" field for ApiOperations #6

@metacubed

Description

@metacubed

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:

First Sentence
The first sentence of each documentation comment should be a summary sentence that contains a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The javadoc command copies this first sentence to the member summary at the top of the HTML page.

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions