Skip to content

Decommission springfox from kotlin-spring generator#23283

Merged
wing328 merged 3 commits intomasterfrom
kotlin-springfox
Mar 19, 2026
Merged

Decommission springfox from kotlin-spring generator#23283
wing328 merged 3 commits intomasterfrom
kotlin-springfox

Conversation

@wing328
Copy link
Copy Markdown
Member

@wing328 wing328 commented Mar 19, 2026

Decommission springfox (documentationProvider option) from kotlin-spring generator

cc @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10) @dennisameling (2026/02)

PR checklist

  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Read the contribution guidelines.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Removed springfox support from the kotlin-spring generator and deleted related samples and config. Use springdoc or source for API docs going forward.

  • Refactors

    • Dropped SPRINGFOX from supported documentation providers and the enum.
    • Swagger UI bootstrap now only applies to source.
    • Removed kotlin-springboot-springfox sample, its config, and the CI sample entry.
    • Updated tests to stop referencing documentationProvider=springfox and use documentationProvider=none where needed (e.g., with annotationLibrary=swagger1).
    • Updated docs to remove springfox from documentationProvider options.
  • Migration

    • Replace documentationProvider: springfox with springdoc (recommended) or source.
    • If using springdoc, set annotationLibrary: swagger2.
    • Remove any local usage of the deleted kotlin-springboot-springfox sample and config.

Written for commit 4e8f05a. Summary will update on new commits.

@wing328 wing328 marked this pull request as ready for review March 19, 2026 06:25
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 43 files

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="modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java">

<violation number="1" location="modules/openapi-generator/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java:764">
P2: Use `DocumentationProvider.NONE` for `DOCUMENTATION_PROVIDER` instead of `AnnotationLibrary.NONE`; the current line relies on an accidental string match (`"none"`) between different enums.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

@wing328 wing328 merged commit f631d54 into master Mar 19, 2026
62 checks passed
@wing328 wing328 deleted the kotlin-springfox branch March 19, 2026 07:26
@wing328 wing328 mentioned this pull request Mar 19, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant