Skip to content

[Java][WebClient] Propagate OpenAPI Deprecations to Generated ApiClient-methods#23039

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
Chrimle:22675-deprecate-endpoints
Feb 23, 2026
Merged

[Java][WebClient] Propagate OpenAPI Deprecations to Generated ApiClient-methods#23039
wing328 merged 1 commit intoOpenAPITools:masterfrom
Chrimle:22675-deprecate-endpoints

Conversation

@Chrimle
Copy link
Copy Markdown
Contributor

@Chrimle Chrimle commented Feb 23, 2026

Closes #22675. Reported by, and solution suggested by @parkito. Propagates deprecated-property set on endpoints in OpenAPI Specs, to apply to the corresponding generated methods in ApiClient. This will annotate the method(s) with @Deprecated, as well as add the JavaDoc-tag @deprecated (with an empty description).

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.

Summary by cubic

Propagates the OpenAPI deprecated flag to generated Java WebClient ApiClient WithHttpInfo methods. This adds @deprecated and a Javadoc @deprecated note so IDEs warn on deprecated endpoints.

  • New Features
    • Emit @deprecated and Javadoc @deprecated for operationIdWithHttpInfo when the OpenAPI operation is deprecated.
    • Regenerated petstore WebClient samples to reflect the new annotations.

Written for commit 78ce2be. Summary will update on new commits.

…ent`-methods

Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
@Chrimle Chrimle marked this pull request as ready for review February 23, 2026 22:33
@Chrimle
Copy link
Copy Markdown
Contributor Author

Chrimle commented Feb 23, 2026

Probably want to apply this functionality/behavior to the other flavors of java-generators. However, probably cleaner to do them separately, no?

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.

No issues found across 5 files

@Chrimle
Copy link
Copy Markdown
Contributor Author

Chrimle commented Feb 23, 2026

Ready for review @wing328 🙌

@wing328
Copy link
Copy Markdown
Member

wing328 commented Feb 23, 2026

lgtm. thanks for the PR

@wing328 wing328 merged commit 8c70c33 into OpenAPITools:master Feb 23, 2026
108 checks passed
@wing328 wing328 added this to the 7.21.0 milestone Feb 23, 2026
@Chrimle Chrimle deleted the 22675-deprecate-endpoints branch March 7, 2026 22:45
davidricodias pushed a commit to davidricodias/openapi-generator that referenced this pull request Mar 11, 2026
…ent`-methods (OpenAPITools#23039)

Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
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.

[BUG][JAVA] Deprecated endpoints are not marked with Deprecated in public webclient methods

2 participants