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

Bugfix for content_type discriminator issue #20187

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

IvanVas
Copy link

@IvanVas IvanVas commented Nov 26, 2024

This isn't the full fix yet, I'd like to get a guidance for the next way to proceed.

Bug:
The discriminatorName in oneOf template is set to contentType if the content_type is used as a discriminator in the OpenAPI spec.
It will then fail in runtime during response deserialization with the error TypeError: typeMap[type].getAttributeTypeMap is not a function.
Same might happen for serialization, didn't test that yet.

We need to make sure "content_type" is used, or that the "content_type" is transformed to "contentType" (might not be desirable).

What are the best next steps?

@amakhrov
@davidgamero
@mkusaka
@joscha

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

@IvanVas IvanVas changed the title [Draft] A comment for content_type discriminator issues [Draft] Bugfix for content_type discriminator issue Nov 26, 2024
@IvanVas IvanVas changed the title [Draft] Bugfix for content_type discriminator issue Bugfix for content_type discriminator issue Nov 29, 2024
@IvanVas
Copy link
Author

IvanVas commented Dec 2, 2024

@amakhrov, would you be able to point me to the right direction to fix this?

@amakhrov
Copy link
Contributor

amakhrov commented Dec 2, 2024

@IvanVas do you have an example spec the demonstrates the problem?
Perhaps also helpful to start with creating an issue describing the problem, and then link the PR to it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants