Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[java][client] fix: Add static modifier to inner class in Java when useSingleRequestParameter=true #20590

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cchacin
Copy link

@cchacin cchacin commented Feb 4, 2025

When generating Java clients with the option useSingleRequestParameter set to true, there is a inner class generated that is not set as static.

@martin-mfg @Zomzog @lwlee2608

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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cchacin cchacin changed the title fix: Add static modifier to inner class in Java when useSingleRequestParameter=true [java][client] fix: Add static modifier to inner class in Java when useSingleRequestParameter=true Feb 4, 2025
@wing328
Copy link
Member

wing328 commented Feb 5, 2025

cc @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)

@@ -585,7 +585,7 @@ public ResponseSpec updatePetWithResponseSpec(Pet pet) throws WebClientResponseE
return updatePetRequestCreation(pet);
}

public class UpdatePetWithFormRequest {
public static class UpdatePetWithFormRequest {
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the PR.

It looks like this is a breaking change, right?

If I've the following:

PetApi.UpdatePetWithFormRequest a = new PetApi().new UpdatePetWithFormRequest(12L, "ab", "bc");

I'll get an error after UpdatPetWithFormRequest becomes static.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, that's correct, it has to be updated to:

PetApi.UpdatePetWithFormRequest a = new PetApi.UpdatePetWithFormRequest(12L, "ab", "bc");

Copy link
Member

Choose a reason for hiding this comment

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

then i think we need an add an option for fallback as the upcoming v7.12.0 release only allows breaking changes with fallback only.

Copy link
Author

Choose a reason for hiding this comment

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

Sure, any pointers/docs/example for the fallback strategy?

Copy link
Member

Choose a reason for hiding this comment

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

Please have a look at #18072 (for c client generator) as it adds an option to decide whether the output should be JSON-formatted

Commit 424e3cc in the PR adds the option

Copy link
Member

Choose a reason for hiding this comment

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

actually please put it on hold....

Copy link
Member

Choose a reason for hiding this comment

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

i think another way is to update the existing option useSingleRequestParameter to allow static instead of just true or false so that we don't need to add another option

Copy link
Member

Choose a reason for hiding this comment

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

can you please take a look at updating useSingleRequestParameter to allow static?

(when static is provide by the user, we will add "staticRequest" to true in additionalProperties so that {{#staticRequest}} ... {{/staticRequest}} can be used in the template to add static in the output

Copy link
Author

Choose a reason for hiding this comment

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

I'll dig into that, thanks for the pointers

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.

2 participants