Decommission springfox from spring generator#23280
Open
Conversation
Contributor
There was a problem hiding this comment.
2 issues found across 1100 files
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/configuration/SpringDocConfiguration.java">
<violation number="1" location="samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/configuration/SpringDocConfiguration.java:33">
P1: Define OAuth flows for the OAuth2 security scheme; `type: oauth2` without `flows` creates an invalid/incomplete OpenAPI security definition.</violation>
</file>
<file name="samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java">
<violation number="1" location="samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java:72">
P2: Use OpenAPI `@RequestBody` instead of `@Parameter` on body-bound method arguments.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| .components( | ||
| new Components() | ||
| .addSecuritySchemes("petstore_auth", new SecurityScheme() | ||
| .type(SecurityScheme.Type.OAUTH2) |
Contributor
There was a problem hiding this comment.
P1: Define OAuth flows for the OAuth2 security scheme; type: oauth2 without flows creates an invalid/incomplete OpenAPI security definition.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/configuration/SpringDocConfiguration.java, line 33:
<comment>Define OAuth flows for the OAuth2 security scheme; `type: oauth2` without `flows` creates an invalid/incomplete OpenAPI security definition.</comment>
<file context>
@@ -0,0 +1,52 @@
+ .components(
+ new Components()
+ .addSecuritySchemes("petstore_auth", new SecurityScheme()
+ .type(SecurityScheme.Type.OAUTH2)
+ )
+ .addSecuritySchemes("api_key", new SecurityScheme()
</file context>
| ) | ||
| ResponseEntity<Pet> addPet( | ||
| @ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet | ||
| @Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet |
Contributor
There was a problem hiding this comment.
P2: Use OpenAPI @RequestBody instead of @Parameter on body-bound method arguments.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java, line 72:
<comment>Use OpenAPI `@RequestBody` instead of `@Parameter` on body-bound method arguments.</comment>
<file context>
@@ -35,31 +46,30 @@ public interface PetApi {
)
ResponseEntity<Pet> addPet(
- @ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
+ @Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
);
</file context>
Suggested change
| @Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet | |
| @io.swagger.v3.oas.annotations.parameters.RequestBody(description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
springfox(documentationProvider option) from spring generator.cc @cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Removed
springfoxfrom the Spring generator and migrated samples/tests tospringdoc-openapiwith OpenAPI v3 annotations across Spring Boot and Spring Cloud. This is a breaking change for users relying ondocumentationProvider: springfox.Refactors
SPRINGFOXfromSpringCodegensupported providers; only bootstrap Swagger UI when usingSOURCE.documentationProvider: springdoc(or commented where unused) across Spring Boot, Spring Cloud, and HTTP interface configs.@Schema,@Parameter,@ParameterObject); adjusted tests accordingly.io.springfox:*toorg.springdoc:springdoc-openapi-ui; updated imports and bumped Spring Boot parents to 2.7.x where needed.SpringFoxConfiguration, static Swagger UI,/v2/api-docs); addedSpringDocConfiguration.ModelFilefrom samples.Migration
documentationProvider: springdocin generator configs.io.springfox:*withorg.springdoc:springdoc-openapi-ui, move toio.swagger.v3.oas.annotations, and use/v3/api-docs.Written for commit 973e23a. Summary will update on new commits.