Skip to content

[python-experimental] Allow schema instances to be passed in and pass additional schema validations#12758

Merged
spacether merged 28 commits intoOpenAPITools:masterfrom
spacether:feat_fixes_issue_12736
Jul 9, 2022
Merged

[python-experimental] Allow schema instances to be passed in and pass additional schema validations#12758
spacether merged 28 commits intoOpenAPITools:masterfrom
spacether:feat_fixes_issue_12736

Conversation

@spacether
Copy link
Copy Markdown
Contributor

@spacether spacether commented Jul 2, 2022

Allow schema instances to be passed in and pass additional schema validations

In polymorphic use cases, an instance may be passed in which is of type Dog but in the schema that we are deserializing, the field is of type Animal. As long as the dog payload can validate as an Animal also, that should be permitted.

This PR updates cast_to_allowed_values so that when a schema instance is ingested, the instance is converted back to a primitive payload (Decimal/str/NoneClass/BoolClass, NOT a Schema instance). With that primitive payload, all validations can be run, and the new DynamicSchema class can be manufactured containing all passed validations and the payload can be instantiated as that new class. So in the output, the Dog instance will now be of type Dog AND Animal.

When Schema instances are ingested, the code should not have to re-run validation on already validated Schema classes for a given payload. So that information is persisted in ValidationMetadata and validating a schema class is skipped if it was validated earlier.

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 (6.0.1) (patch release), 6.1.x (breaking changes with fallbacks), 7.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.

@spacether spacether marked this pull request as draft July 2, 2022 21:31
@spacether spacether added this to the 6.1.0 milestone Jul 9, 2022
@spacether spacether force-pushed the feat_fixes_issue_12736 branch from 605458c to a4afdd3 Compare July 9, 2022 20:51
@spacether spacether marked this pull request as ready for review July 9, 2022 20:55
spacether added 26 commits July 9, 2022 17:33
…_types, fixes test test_deserialize_oneof_reference
…tpye checking and unique items checking simpler
@spacether spacether force-pushed the feat_fixes_issue_12736 branch from a4afdd3 to 9ffefb9 Compare July 9, 2022 21:33
@spacether spacether merged commit d6b360d into OpenAPITools:master Jul 9, 2022
@spacether spacether deleted the feat_fixes_issue_12736 branch July 9, 2022 22:06
@warrenseine
Copy link
Copy Markdown

Waiting for this change to be released. I confirm that I had an error with optional booleans in 6.0.1, and it appears to be fixed when building master locally (including this PR which was recently merged).

The error was:

[...].ApiTypeError: Invalid type. Required value type is one of [Decimal, FileIO, NoneType, bool, bytes, frozendict, str, tuple] and passed type was DynamicBoolSchema at [...]

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] [Python-experimental] Certain types in nested component schemas are interpreted as DynamicSchema

2 participants