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

Process additionalProperties: true as arbitrary type instead of object #11802

Merged

Conversation

impl
Copy link
Contributor

@impl impl commented Mar 4, 2022

When a schema specifies additionalProperties: true, we need not restrict those properties to a particular type. This change sets the schemas for them to AnyType instead of object.

From a generation perspective, this only changes the output for generators that differentiate between AnyType and object in their type mappings; most do not. This fixes at least one bug in the Go and TypeScript generators.

New tests for the Go generator and DefaultCodegen demonstrate the intent of this change.

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.

For Go, @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d
For TypeScript, @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero

Thanks in advance for the review!

@impl impl force-pushed the fix-additional-properties-any-type branch from b6bf78f to e10231b Compare March 4, 2022 22:35
When a schema specifies additionalProperties: true, we need not restrict
those properties to a particular type. This change sets the schemas for
them to AnyType instead of object.

From a generation perspective, this only changes the output for
generators that differentiate between AnyType and object in their type
mappings; most do not. This fixes at least one bug in the Go and
TypeScript generators.
@wing328
Copy link
Member

wing328 commented Apr 9, 2022

Tested locally and the result is good. Thanks for the PR

FYI @OpenAPITools/generator-core-team

@wing328 wing328 merged commit f6231d2 into OpenAPITools:master Apr 9, 2022
@wing328 wing328 added this to the 6.0.0 milestone Apr 9, 2022
cachescrubber pushed a commit to cachescrubber/openapi-generator that referenced this pull request Apr 9, 2022
When a schema specifies additionalProperties: true, we need not restrict
those properties to a particular type. This change sets the schemas for
them to AnyType instead of object.

From a generation perspective, this only changes the output for
generators that differentiate between AnyType and object in their type
mappings; most do not. This fixes at least one bug in the Go and
TypeScript generators.
@impl impl deleted the fix-additional-properties-any-type branch April 13, 2022 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants