Skip to content

[java-cxf-cdi] @Api description is deprecated in swagger-annotations#22083

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
selliera:master
Oct 6, 2025
Merged

[java-cxf-cdi] @Api description is deprecated in swagger-annotations#22083
wing328 merged 1 commit intoOpenAPITools:masterfrom
selliera:master

Conversation

@selliera
Copy link
Copy Markdown
Contributor

@selliera selliera commented Oct 6, 2025

@Api(description=...) is deprecated in swagger-annotations-1.5.0 and the following.
Remove its usage: it is not used by swagger-ui, and generates warnings at build.

PR checklist

  • Read the contribution guidelines.
  • 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.
  • 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.
    @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@Api(description=...) is deprecated.
Remove its usage: it is not used by swagger-ui, and generated warnings
at build
@selliera selliera changed the title [java-cxf-cdi] @Api description is deprecated [java-cxf-cdi] @Api description is deprecated in swagger-annotations Oct 6, 2025
@wing328 wing328 merged commit 37cac71 into OpenAPITools:master Oct 6, 2025
32 checks passed
@wing328 wing328 added this to the 7.17.0 milestone Oct 6, 2025
rajvesh pushed a commit to rajvesh/openapi-generator that referenced this pull request Dec 25, 2025
@Api(description=...) is deprecated.
Remove its usage: it is not used by swagger-ui, and generated warnings
at build
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants