Skip to content

[ruby] Allow boolean for discriminator value in oneOf handling#11750

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
ykitamura-mdsol:ruby_boolean_discriminator_value
Mar 1, 2022
Merged

[ruby] Allow boolean for discriminator value in oneOf handling#11750
wing328 merged 1 commit intoOpenAPITools:masterfrom
ykitamura-mdsol:ruby_boolean_discriminator_value

Conversation

@ykitamura-mdsol
Copy link
Copy Markdown
Contributor

This must be a very rare case but we are using a boolean property as discriminator:

    CarOrCustomCar:
      oneOf:
        - $ref: '#/components/schemas/Car'
        - $ref: '#/components/schemas/CustomCar'
      discriminator:
        propertyName: custom_flag
        mapping:
          true: '#/components/schemas/CustomCar'
          false: '#/components/schemas/Car'

    CustomCar:
      properties:
         :
        custom_flag:
          type: boolean

    Car:
      properties:
         :
        custom_flag:
          type: boolean

The OpenAPI specification says:

Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison.

So I think we can modify to handle boolean values property for discriminator.

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.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 1, 2022

This must be a very rare case but we are using a boolean property as discriminator:

Yup, very rare...

So I think we can modify to handle boolean values property for discriminator.

Your proposed fix works for both string and boolean so I think it's ok.

cc @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

@wing328 wing328 added this to the 6.0.0 milestone Mar 1, 2022
@wing328 wing328 merged commit f03b1e7 into OpenAPITools:master Mar 1, 2022
@ykitamura-mdsol ykitamura-mdsol deleted the ruby_boolean_discriminator_value branch March 1, 2022 17:06
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.

2 participants