Fix issue 18889,15274 - configOptions to not remove enum prefix and oneOf subtypes annotations example #18998

rodrigoma3 · 2024-06-23T03:10:37Z

configOptions to not remove enum prefix:
An option was implemented to not remove the common prefix between enums, but it was not available in the documentation and does not work by adding it to configOptions.
I just added it to cliOptions so that it appears in the documentation and works through configOptions in the pom.
merged: [feature] Add option to disable stripping of common prefix enum #5166
fix [BUG][JAVA] Enum not generated correctly for contents having common prefix #18889

<configOptions>
    <removeEnumValuePrefix>false</removeEnumValuePrefix>
</configOptions>

oneOf subtypes annotations example:
I created a test to show how using oneOf with mapping works without duplicating class mappings.
fix [BUG][Spring] oneOf keyword generates wrong subtype annotations. #15274

example

@JsonIgnoreProperties(
  value = "petType", // ignore manually set petType, it will be automatically generated by Jackson during serialization
  allowSetters = true // allows the petType to be set during deserialization
)
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "petType", visible = true)
@JsonSubTypes({
  @JsonSubTypes.Type(value = Cat.class, name = "PET_CAT"),
  @JsonSubTypes.Type(value = Dog.class, name = "PET_DOG"),
  @JsonSubTypes.Type(value = Lizard.class, name = "PET_LIZARD")
})

@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2024-06-22T15:24:51.304753300-03:00[America/Sao_Paulo]", comments = "Generator version: unset")
public interface Pet {
    public PetType getPetType();
}

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
```
(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.6.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.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @wing328

atualizar master

welshm-ideogram · 2024-06-23T12:41:54Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

+        removeEnumValuePrefixOpts.put("false",
+                "No changes to the enum's are made.");
+        removeEnumValuePrefixOpts.put("true",
+                "With this option disabled, each enum will have the common prefix between them removed. This is the default option.");


Not: disabled -> enabled? Since this is when it's true?

I did not understand your question. This option was implemented by someone else and that's how it ended up, I just wrote what happens with each option.

I think it's with the option enabled, each enum will have the common prefix between them removed.

Exactly. It was done like this. But it's been like this since Feb 8, 2020. PR link merged #5166

welshm-ideogram · 2024-06-23T12:45:31Z

...napi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java

@@ -40,6 +40,7 @@ public class BashClientOptionsProvider implements OptionsProvider {
                                = "false";
    public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true";
    public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false";
+    public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true";


Why are you adding this here if you're referencing the default codegen key?

My understanding is that these are for generator specific keys (which you aren't using)

It was breaking the tests saying that this new property needed to be added. I just followed the ENUM_UNKNOWN_DEFAULT_CASE_VALUE example to solve the test.

Did this need to be defined here to just added to the builder below using .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE)?

This definition (BashClientCodegen.REMOVE_ENUM_VALUE_PREFIX_VALUE) isn't being used or referenced anywhere

Which tests was failing?

Exactly. I followed how others are doing in each test.
This fails:

welshm-ideogram · 2024-06-23T12:48:32Z

...pi-generator/src/test/java/org/openapitools/codegen/options/ElixirClientOptionsProvider.java

@@ -47,6 +48,7 @@ public Map<String, String> createOptions() {
                .put(CodegenConstants.LEGACY_DISCRIMINATOR_BEHAVIOR, "true")
                .put(CodegenConstants.DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT, "true")
                .put(CodegenConstants.ENUM_UNKNOWN_DEFAULT_CASE, ENUM_UNKNOWN_DEFAULT_CASE_VALUE)
+                .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE)


Did none of the samples change for any of these generators when you added the option?

Do they properly support this option?

This new option was implemented in DefaultCodegen and has been in use for a long time.
My intention here is not to develop a new feature but to make its configuration available via configOptions so that devs can find this option more easily.
I just received test errors and resolved them.

welshm

Looks good to me - although ideally we don't need to replicate each option in each sub-generator and can just refer to the global option

welshm · 2024-06-23T15:54:51Z

...napi-generator/src/test/java/org/openapitools/codegen/options/BashClientOptionsProvider.java

@@ -40,6 +40,7 @@ public class BashClientOptionsProvider implements OptionsProvider {
                                = "false";
    public static final String PREPEND_FORM_OR_BODY_PARAMETERS_VALUE = "true";
    public static final String ENUM_UNKNOWN_DEFAULT_CASE_VALUE = "false";
+    public static final String REMOVE_ENUM_VALUE_PREFIX_VALUE = "true";


Did this need to be defined here to just added to the builder below using .put(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_VALUE)?

This definition (BashClientCodegen.REMOVE_ENUM_VALUE_PREFIX_VALUE) isn't being used or referenced anywhere

Which tests was failing?

rodrigoma3 · 2024-06-23T16:14:17Z

@welshm

Looks good to me - although ideally we don't need to replicate each option in each sub-generator and can just refer to the global option

I agree. However, the project is very big and I'm still getting to know it. For now, I will continue as is being done as I believe it is safer. In the future maybe I will be a little more daring.

rodrigoma3 · 2024-06-26T01:35:31Z

fix #18889 #15274

rodrigoma3 and others added 4 commits August 4, 2023 00:22

Merge pull request #1 from OpenAPITools/master

d777e86

atualizar master

Merge branch 'master' of https://github.com/rodrigoma3/openapi-generator

a939290

Merge branch 'OpenAPITools:master' into master

251e751

fix issue 18889 15274

e44b430

rodrigoma3 requested a review from jimschubert as a code owner June 23, 2024 03:10

welshm-ideogram reviewed Jun 23, 2024

View reviewed changes

rodrigoma3 requested a review from welshm-ideogram June 23, 2024 15:28

welshm approved these changes Jun 23, 2024

View reviewed changes

rodrigoma3 requested a review from welshm June 23, 2024 16:14

rodrigoma3 and others added 2 commits June 24, 2024 09:11

Merge branch 'OpenAPITools:master' into master

e2f8436

Merge branch 'master' into fix_issue_18889_15274

26bd442

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix issue 18889,15274 - configOptions to not remove enum prefix and oneOf subtypes annotations example #18998

Fix issue 18889,15274 - configOptions to not remove enum prefix and oneOf subtypes annotations example #18998

rodrigoma3 commented Jun 23, 2024 •

edited

Loading

welshm-ideogram Jun 23, 2024

rodrigoma3 Jun 23, 2024

welshm-ideogram Jun 23, 2024

rodrigoma3 Jun 23, 2024

welshm-ideogram Jun 23, 2024

rodrigoma3 Jun 23, 2024

welshm Jun 23, 2024

rodrigoma3 Jun 23, 2024

welshm-ideogram Jun 23, 2024

rodrigoma3 Jun 23, 2024

welshm left a comment

welshm Jun 23, 2024

rodrigoma3 commented Jun 23, 2024

rodrigoma3 commented Jun 26, 2024

Fix issue 18889,15274 - configOptions to not remove enum prefix and oneOf subtypes annotations example #18998

Are you sure you want to change the base?

Fix issue 18889,15274 - configOptions to not remove enum prefix and oneOf subtypes annotations example #18998

Conversation

rodrigoma3 commented Jun 23, 2024 • edited Loading

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

welshm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodrigoma3 commented Jun 23, 2024

rodrigoma3 commented Jun 26, 2024

rodrigoma3 commented Jun 23, 2024 •

edited

Loading