Repository navigation
[Java][WebClient] Add @Deprecated to main and WithResponseSpec methods of deprecated operations - #25128
Merged
wing328 merged 2 commits intoOct 5, 2026
Conversation
…s of deprecated operations OpenAPITools#23039 only annotated the WithHttpInfo method. Apply the same @deprecated annotation and @deprecated javadoc tag to the main operation method and the WithResponseSpec method, and add a regression test. Fixes OpenAPITools#25127
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 6 files
Reply to a comment to ask cubic a question or push back. It learns from your replies.
Re-trigger cubic
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.
Fixes #25127.
For a deprecated operation, the Java
webclientlibrary generates three public methods, but onlyoperationWithHttpInfo(...)was annotated with@Deprecated(added in #23039). This PR adds the same@Deprecatedannotation and@deprecatedJavadoc tag to the other two public methods,operation(...)andoperationWithResponseSpec(...), so that all entry points of a deprecated endpoint trigger deprecation warnings (e.g. withjavac -Xlint:deprecation -Werror). This also covers the method originally reported in #22675.Changes:
Java/libraries/webclient/api.mustache: add{{#isDeprecated}}blocks to{{operationId}}and{{operationId}}WithResponseSpec.JavaClientCodegenTest#testWebClientDeprecatedOperation: asserts all three methods of the deprecatedfindPetsByTagsare annotated, and none of the non-deprecatedfindPetsByStatusare. The test fails without the template change.bin/configs/java-webclient*.yamlsamples (no other configs use thewebclientlibrary). Only the four petstorePetApi.javasamples containing the deprecatedfindPetsByTagsoperation change.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.
cc Java technical committee: @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg @KannaKim
Summary by cubic
Fixes #25127. Applies the
@Deprecatedannotation and@deprecatedJavadoc tag to theoperation(...)andoperationWithResponseSpec(...)methods of deprecated operations in the Javawebclientlibrary, matching the existing annotation onoperationWithHttpInfo(...)so all entry points trigger deprecation warnings.@deprecatedJavadoc tag, while deprecated methods of non-deprecated operations remain untouched.java-webclient*samplePetApi.javafiles affected by the template change.Written for commit 6f3379f. Summary will update on new commits.