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][okhttp-gson] validateJsonElement does not validate enum values #16865

Merged
merged 3 commits into from
Nov 8, 2023

Conversation

ctreatma
Copy link
Contributor

@ctreatma ctreatma commented Oct 18, 2023

This PR adds enum templates for Java with okhttp-gson to add validateJsonElement functions to both inline enums and external enums, and to call the validateJsonElement function for enum properties.

Fixes #16917

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (upcoming 7.1.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.

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)

@ctreatma ctreatma force-pushed the okhttp-gson-enum-validation branch from 0f40188 to f08bf33 Compare October 19, 2023 14:48
@ctreatma ctreatma changed the title [Java] validateJsonElement does not validate enum values [Java][okhttp-gson] validateJsonElement does not validate enum values Oct 19, 2023
@ctreatma ctreatma force-pushed the okhttp-gson-enum-validation branch from f08bf33 to 6c1d6bb Compare October 23, 2023 16:11
@wing328 wing328 added this to the 7.1.0 milestone Oct 31, 2023
@wing328
Copy link
Member

wing328 commented Nov 4, 2023

Please merge the latest master as I've just merged #16985 to restore some tests.

Please add a test in JSONTest.java to ensure this issue is covered moving forward.

Let me know if you need any help.

@ctreatma ctreatma force-pushed the okhttp-gson-enum-validation branch 3 times, most recently from 0892f27 to ab3a2e1 Compare November 6, 2023 20:48
@ctreatma
Copy link
Contributor Author

ctreatma commented Nov 6, 2023

@wing328 I added a test and it passed in CI but a different workflow failed because the digest of the JSONTest.java file changed: https://github.com/OpenAPITools/openapi-generator/actions/runs/6776363363/job/18417685804?pr=16865

Did I update the test file in the wrong way? Or should I manually update the SHA in bin/utils/test_file_list.yaml?

@wing328
Copy link
Member

wing328 commented Nov 7, 2023

Or should I manually update the SHA in bin/utils/test_file_list.yaml?

yes please update that as the hash is no longer the same

@ctreatma ctreatma force-pushed the okhttp-gson-enum-validation branch from ab3a2e1 to e875cf6 Compare November 7, 2023 17:17
@wing328 wing328 merged commit 166ebc5 into OpenAPITools:master Nov 8, 2023
69 checks passed
@@ -0,0 +1,123 @@
{{#jackson}}
Copy link
Member

@wing328 wing328 Nov 8, 2023

Choose a reason for hiding this comment

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

when you've time, can you please file another PR to clean up {{#jackson}} ... {{/jackson}} in this file as okhttp-gson library doesn't use the jackson mustache tag?

(and we don't need the gson tag either as it must be true when using okhttp-gson)

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] [okhttp-gson] enum values are not validated in some cases
2 participants