Open source

Migrate from `@ApiModelProperty` to `@Schema`

Recipe IDorg.openrewrite.openapi.swagger.MigrateApiModelPropertyToSchemaArtifactorg.openrewrite.recipe:rewrite-openapi

Converts the @ApiModelProperty annotation to @Schema and converts the "value" attribute to "description".

Composite recipeopenapiswaggerApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.openapi.swagger.MigrateApiModelPropertyToSchema")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-openapi:0.34.1")
}

Then run

./gradlew rewriteRun

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.MigrateApiModelPropertyToSchema

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-openapi:RELEASE

Definition

This recipe runs the following recipes in order.

Change type ApiModelProperty to Schemaorg.openrewrite.java.ChangeType
Change annotation attribute name @Schema(value) to @Schema(description)org.openrewrite.java.ChangeAnnotationAttributeName
Remove annotation attribute @Schema(position)org.openrewrite.java.RemoveAnnotationAttribute
Remove annotation attribute @Schema(notes)org.openrewrite.java.RemoveAnnotationAttribute
Change annotation attribute name @Schema(dataType) to @Schema(type)org.openrewrite.java.ChangeAnnotationAttributeName
Change annotation attribute name @Schema(allowEmptyValue) to @Schema(nullable)org.openrewrite.java.ChangeAnnotationAttributeName

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