Upgrade to springdoc-openapi 2
org.openrewrite.java.spring.boot3.UpgradeSpringDoc_2
Migrate applications to the latest spring-doc 2 release. This recipe will modify an application's build files and make changes code changes for removed/updated APIs. See the upgrade guide
Tags
spring
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-spring
version: 5.15.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.
Data Tables
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring:5.15.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
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-data-rest
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-groovy
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-hateoas
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-javadoc
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-kotlin
Remove a Gradle or Maven dependency
groupId:
org.springdoc
artifactId:
springdoc-openapi-security
Change Gradle or Maven dependency
oldGroupId:
org.springdoc
oldArtifactId:
springdoc-openapi-common
newArtifactId:
springdoc-openapi-starter-common
newVersion:
2.x
Change Gradle or Maven dependency
oldGroupId:
org.springdoc
oldArtifactId:
springdoc-openapi-webmvc-core
newArtifactId:
springdoc-openapi-starter-webmvc-api
newVersion:
2.x
Change Gradle or Maven dependency
oldGroupId:
org.springdoc
oldArtifactId:
springdoc-openapi-webflux-core
newArtifactId:
springdoc-openapi-starter-webflux-api
newVersion:
2.x
Change Gradle or Maven dependency
oldGroupId:
org.springdoc
oldArtifactId:
springdoc-openapi-ui
newArtifactId:
springdoc-openapi-starter-webmvc-ui
newVersion:
2.x
Change Gradle or Maven dependency
oldGroupId:
org.springdoc
oldArtifactId:
springdoc-openapi-webflux-ui
newArtifactId:
springdoc-openapi-starter-webflux-ui
newVersion:
2.x
oldFullyQualifiedTypeName:
org.springdoc.core.SpringDocUtils
newFullyQualifiedTypeName:
org.springdoc.core.utils.SpringDocUtils
oldFullyQualifiedTypeName:
org.springdoc.api.annotations.ParameterObject
newFullyQualifiedTypeName:
org.springdoc.core.annotations.ParameterObject
oldFullyQualifiedTypeName:
org.springdoc.core.GroupedOpenApi
newFullyQualifiedTypeName:
org.springdoc.core.models.GroupedOpenApi
oldFullyQualifiedTypeName:
org.springdoc.core.customizers.OpenApiCustomiser
newFullyQualifiedTypeName:
org.springdoc.core.customizers.OpenApiCustomizer
oldFullyQualifiedTypeName:
org.springdoc.core.Constants
newFullyQualifiedTypeName:
org.springdoc.core.utils.Constants
oldFullyQualifiedTypeName:
org.springdoc.core.SwaggerUiConfigParameters
newFullyQualifiedTypeName:
org.springdoc.core.properties.SwaggerUiConfigParameters
methodPattern:
org.springdoc.core.models.GroupedOpenApi.Builder addOpenApiCustomiser(..)
newMethodName:
addOpenApiCustomizer
matchOverrides:
true
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