Skip to content

[Java] Fixes schema class type booleans for composed schemas#10334

Merged
spacether merged 98 commits intoOpenAPITools:masterfrom
spacether:fixes_composed_schema_codegenmodel_booleans
Sep 27, 2021
Merged

[Java] Fixes schema class type booleans for composed schemas#10334
spacether merged 98 commits intoOpenAPITools:masterfrom
spacether:fixes_composed_schema_codegenmodel_booleans

Conversation

@spacether
Copy link
Copy Markdown
Contributor

@spacether spacether commented Sep 6, 2021

Fixes java schema class type booleans for composed schemas
When a composed schema is defined with a type constraint, our tooling is not detecting that constraint and setting the boolean type properties in the class instance correctly.

This PR adds code which fixes that issue.
instance.setTypeProperties(schema) now sets those properties for object, array, number, integer, anyType, null, and string
which are the non-format types

Updates:

  • CodegenModel/CodegenResponse/CodegenParameter/CodegenProperty now all set isMap isArray etc booleans with clearer if/else logic. Before some of that property setting depended on order specific blocks like isMapSchema. That logic has now been included in blocks for type object schema handling and any type schema handling.
  • isAnyTypeSchema method is now marked as a deprecated method. It can be removed in a later major 6.0.0 release ModelUtils.isAnyType should be used in its place
  • setParameterBooleanFlagWithCodegenProperty method is now marked as a deprecated method. It can be removed in a later major 6.0.0 release. Devs should depend upon the type setting adjacent to the invocations of instance.setTypeProperties(schema). If they need specific handling, then they can override methods like we do in master branch with updateModelForObject and updatePropertyForAnyType etc.
  • If a composed schema does not have type set, it now has the property isAnyType set to true in the java layer.
  • updates how array parameters are created in the Java layer. Originally our code was passing in fromFormProperty(name, arrayItemsSchema). This PR updates our code to pass in fromFormProperty(name, arraySchema)

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/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 (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Comment thread samples/server/petstore/rust-server/output/openapi-v3/src/models.rs Outdated
Comment thread samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts Outdated
@spacether spacether changed the title Fixes java schema class type booleans for composed schemas Fixes java schema class type booleans for composed schemas [WIP] Sep 10, 2021
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why are getters one line, but setters 3 lines?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Just copying and pasting. Do you have a preference on how it should be done?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you have a preference on how it should be done?

Consistent :)

@spacether spacether closed this Sep 27, 2021
@spacether
Copy link
Copy Markdown
Contributor Author

Closing and re-opening to kick off bitrise again

@spacether spacether reopened this Sep 27, 2021
@spacether spacether changed the title Fixes java schema class type booleans for composed schemas [WIP] Fixes java schema class type booleans for composed schemas Sep 27, 2021
@spacether spacether force-pushed the fixes_composed_schema_codegenmodel_booleans branch 2 times, most recently from 0fb2e93 to 6fd950f Compare September 27, 2021 21:56
@spacether spacether changed the title Fixes java schema class type booleans for composed schemas [Java] Fixes schema class type booleans for composed schemas Sep 27, 2021
@spacether spacether added this to the 5.3.0 milestone Sep 27, 2021
@spacether spacether merged commit d4b8ff6 into OpenAPITools:master Sep 27, 2021
@spacether spacether deleted the fixes_composed_schema_codegenmodel_booleans branch September 27, 2021 23:12
@spacether
Copy link
Copy Markdown
Contributor Author

csharp-netcore error is unrelated

has_teeth=True,
class_name="whale",
) # Mammal | Input mammal
mammal = Mammal(None) # Mammal | Input mammal
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like a regression here, no?

Copy link
Copy Markdown
Contributor Author

@spacether spacether Oct 4, 2021

Choose a reason for hiding this comment

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

not exactly. Because mammal is type any type (no type defined in the mammal schema), None is a valid selection based upon the schema being anyType. That payload would fail whale or zebra validation so this is highlighting how our python tooling needs to be smarter in how it handles composed anyType schema examples.

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] composed schemas with type described do not set the correct isArray isMap etc booleans

3 participants