Migrate from @ApiParam to @Parameter
Recipe ID
org.openrewrite.openapi.swagger.MigrateApiParamToParameterArtifact
org.openrewrite.recipe:rewrite-openapiConverts the @ApiParam annotation to @Parameter and converts the directly mappable attributes.
Usage
This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.openapi.swagger.MigrateApiParamToParameterIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-openapi:0.33.0Definition
This recipe runs the following recipes in order.
- Change type
org.openrewrite.java.ChangeType - Change annotation attribute name
org.openrewrite.java.ChangeAnnotationAttributeName - Remove annotation attribute
org.openrewrite.java.RemoveAnnotationAttribute - Migrate
@ApiParam(defaultValue)to@Parameter(schema)org.openrewrite.openapi.swagger.MigrateApiParamDefaultValue - Migrate
@ApiParam(allowableValues)to@Parameter(schema)org.openrewrite.openapi.swagger.MigrateApiParamAllowableValues
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats