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

Sets model.additionalProperties for composed schemas #9033

Conversation

spacether
Copy link
Contributor

@spacether spacether commented Mar 21, 2021

Sets model.additionalProperties for composed schemas
This allows v2 spec additionalProperties values to default to {} (AnyType schema) when omitted
No generator uses this data yet.

Tests updated for v2 and v3 additionalProperties checking
v2 specs, legacy behavior (disallowAdditionalPropertiesIfNotPresent = True, supportsAdditionalPropertiesWithComposedSchema = False)

  • additionalProperties unset/false/true -> model.additionalProperties = null
  • additionalProperties schema -> model.additionalProperties = schema

v2 specs, new behavior (disallowAdditionalPropertiesIfNotPresent = False, supportsAdditionalPropertiesWithComposedSchema=True)

  • additionalProperties unset/false/true -> model.additionalProperties = {} AnyType schema
  • additionalProperties schema -> model.additionalProperties = schema

This update will be used in the python generator in #8802

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.1.x, 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.

… supportsAdditionalPropertiesWithComposedSchema is true, tests updated for v2 and v3 specs
@spacether spacether added this to the 5.1.1 milestone Mar 21, 2021
@spacether spacether marked this pull request as draft March 22, 2021 00:43
@spacether spacether marked this pull request as ready for review March 22, 2021 01:55
@spacether spacether merged commit 113d38e into OpenAPITools:master Mar 22, 2021
@spacether spacether deleted the set_model_additionalProperties_for_composed_schema branch March 22, 2021 02:22
This pull request was closed.
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.

1 participant