Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !12758

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

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/spacether/feat_fixes_issue_12736 into master Jul 02, 2022
  • Overview 1
  • Commits 28
  • Pipelines 0
  • Changes 250

Created by: spacether

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.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/spacether/feat_fixes_issue_12736