Skip to content
GitLab

Fixes isFreeFormObject detection

Merged Administrator requested to merge github/fork/spacether/issue_7372_fix into master

Created by: spacether

We have a bug in master branch where this schema:

    A:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/B'

Is incorrectly interpreted as FreeFormObject when it should be a MapSchema Per our java documentation a schema is FreeForm if:

A free form object is an object (i.e. 'type: object' in a OAS document) that:
1) Does not define properties, and
2) Is not a composed schema (no anyOf, oneOf, allOf), and
3) additionalproperties is not defined, or additionalproperties: true, or additionalproperties: {}.

Schema A does not satisfy requirement 3. Requirement 3 only allows additionalproperties values of null, true, and empty object {}. We have {$ref: '#/components/schemas/B'} which is different.

This PR fixes that bug by making sure that when we are in isFreeFormObject we check to see that a ref does not exist in additionalProperties.

  • A test has been added demonstrating that the above model is generated with our updated code

  • If merged, this PR will fix https://github.com/OpenAPITools/openapi-generator/issues/7372#issuecomment-689776396

  • 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.

  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.

  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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

  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.