Migrate from @ApiOperation to @Operation
org.openrewrite.openapi.swagger.MigrateApiOperationToOperation
Converts the @ApiOperation annotation to @Operation and converts the directly mappable attributes and removes the others.
Tags
openapi
swagger
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-openapi
version: 0.1.0
This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-openapi:0.1.0
in your build file or by running a shell command (in which case no build changes are needed):
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
Definition
oldFullyQualifiedTypeName:
io.swagger.annotations.ApiOperation
newFullyQualifiedTypeName:
io.swagger.v3.oas.annotations.Operation
Change annotation attribute name
annotationType:
io.swagger.v3.oas.annotations.Operation
oldAttributeName:
notes
newAttributeName:
description
Change annotation attribute name
annotationType:
io.swagger.v3.oas.annotations.Operation
oldAttributeName:
value
newAttributeName:
summary
annotationType:
io.swagger.v3.oas.annotations.Operation
attributeName:
response
annotationType:
io.swagger.v3.oas.annotations.Operation
attributeName:
consumes
annotationType:
io.swagger.v3.oas.annotations.Operation
attributeName:
produces
See how this recipe works across multiple open-source repositories
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Last updated