Update swagger-2.yml - Change attribute description to title

[amanda-matteucci]

Change attribute "description" to "title"

What's changed?

Change attribute "description" to "title" when migrating from ApiModel to io.swagger.v3.oas.annotations.media.Schema

What's your motivation?

I ran this recipe and it changed "value" to "description" but didn't change what was currently "description" to anything. After some digging, I found that its counterpart would be "title"

Checklist

• I've added unit tests to cover both positive and negative cases
• I've read and applied the recipe conventions and best practices
• I've used the IntelliJ IDEA auto-formatter on affected files

[timtebeek]

Thanks a lot for the quick fix here @amanda-matteucci ; Would you mind sharing that link you found that identifies title as the counterpart to description? That might help contextualize the change for others to come. :)

[timtebeek]

Your change just missed the release we did two hours ago: https://github.com/openrewrite/rewrite-openapi/releases/tag/v0.7.0
Until the next release in two weeks it'll be available from our snapshot repository as 0.8.0-SNAPSHOT. Hope that helps!

[amanda-matteucci]

Thanks a lot for the quick fix here @amanda-matteucci ; Would you mind sharing that link you found that identifies title as the counterpart to description? That might help contextualize the change for others to come. :)

https://docs.swagger.io/swagger-core/v2.0.0-RC3/apidocs/io/swagger/v3/oas/annotations/media/Schema.html#title-- Here you go! It doesn't say it is explicitly the counterpart but I noticed how "description" was used in our team's code before and the documentation for describing "title" seemed to fit.

[timtebeek]

This change has been reverted as it was reported as problematic in #19 . If you'd like anything similar to be added lets add a unit test first to verify the behavior.

[b-abel]

That makes a lot of sense to me. It is worth to keep in mind that the recipe is (transitively) included in the recipes for the Spring Boot 3.x migrations which are very popular which means that many uses are affected by it.