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

Fix ClassCastException in OpenAPINormalizer on composed schemas #17912

Merged
merged 1 commit into from Feb 21, 2024

Conversation

bjansen
Copy link
Contributor

@bjansen bjansen commented Feb 20, 2024

A ClassCastException can happen on OpenAPI 3.1 schemas when they declare both properties and oneOf, for example:

components:
  schemas:
    Payment:
      type: object
      properties:
        label:
          type: string
        otherLabel:
          type: string
        amount:
          type: number
      oneOf:
        - required:
            - label
            - amount
        - required:
            - otherLabel
            - amount

This raises the following exception:

java.lang.ClassCastException: class io.swagger.v3.oas.models.media.JsonSchema cannot be cast to class io.swagger.v3.oas.models.media.ComposedSchema (io.swagger.v3.oas.models.media.JsonSchema and io.swagger.v3.oas.models.media.ComposedSchema are in unnamed module of loader 'app')

	at org.openapitools.codegen.OpenAPINormalizer.normalizeSchema(OpenAPINormalizer.java:461)
	at org.openapitools.codegen.OpenAPINormalizer.normalizeComponentsSchemas(OpenAPINormalizer.java:419)
	at org.openapitools.codegen.OpenAPINormalizer.normalize(OpenAPINormalizer.java:222)

This cast is not necessary, and should even be avoided because in 3.1 ComposeSchema is not used as suggested in a comment in org.openapitools.codegen.utils.ModelUtils#isComposedSchema:

    // in 3.0, ComposeSchema is used for anyOf/oneOf/allOf
    // in 3.1, it's not the case so we need more checks below

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.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.

@wing328
Copy link
Member

wing328 commented Feb 21, 2024

thanks for the fix, lgtm.

@wing328 wing328 merged commit 3af7363 into OpenAPITools:master Feb 21, 2024
14 checks passed
@wing328 wing328 added Issue: Bug OpenAPI Normalizer Normalize the spec for easier processing labels Feb 21, 2024
@wing328 wing328 added this to the 7.4.0 milestone Feb 21, 2024
kota65535 pushed a commit to kota65535/openapi-generator that referenced this pull request Feb 23, 2024
oscarr-reyes pushed a commit to oscarr-reyes/openapi-generator that referenced this pull request Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue: Bug OpenAPI Normalizer Normalize the spec for easier processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants