Make the Swagger UI display the deprecate tag

[eyala]

Swagger-core respects and passes on the Java @deprecated annotation. It would be nice if Swagger-UI, by default, displayed this information on operations

[martypitt]

👍 Would love to see this.

[robmoore]

+1

[jonocodes]

+1

[lmprice]

This is something that would be very useful for us.

[hanszolo]

+1

[iamcrunch]

thisIssue++;

[cadupont]

+1

[iamcrunch]

I have all the code for this. I'm adding deprecated to the model in swagger-js (swagger-api/swagger-js#129), then will move on to creating a pull request for swagger-ui.

[iamcrunch]

This change requires a change in the model generation in swagger-js. That has already been merged, but I'm waiting for a release that we can use as a dependency here. If you're interested, this branch works with swagger-js snapshot: https://github.com/callenx/swagger-ui/tree/addDeprecated.

[cadupont]

Thank you Chris.

On Fri, Oct 3, 2014 at 7:59 PM, Chris Allen notifications@github.com
wrote:

This change requires a change in the model generation in swagger-js. That
has already been merged, but I'm waiting for a release that we can use as a
dependency here. If you're interested, this branch works with swagger-js
snapshot: https://github.com/callenx/swagger-ui/tree/addDeprecated.

—
Reply to this email directly or view it on GitHub
#289 (comment).

[fehguy]

this is now supported in develop_2.0

[CraigFoote]

Sorry it's not clear to me how I can deprecate a controller method :(

[webron]

@CraigFoote - a controller method?

[CraigFoote]

Sorry, bad terminology I guess. My rest endpoints are documented with @API* annotations at the controller method level. I've marked the method @deprecated and added the Javadoc @deprecated but swagger UI renders as before, no indication of deprecation. Reading this issue leads me to think maybe I can edit one of those @API annotations to produce a change in the way swagger UI renders the endpoint, presumably with a strikethrough font. Am I on close? Thanks for the quick reply BTW.

[webron]

@CraigFoote - this is an issue with the library generating the Swagger definition rather than with swagger-ui as it probably doesn't parse the @Deprecated annotation. I'd suggest opening an issue on that library.

[jkoepcke]

The current "Warning: deprecated" headline is only visible after you show the details of an operation. And since it has the same style as the remaining info, it is hardly visible. I created a pull request here:

#1740

This change shows the deprecated operations strikethrough.