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

fixes Object of type date is not JSON serializable error #18485

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

bgunebakan
Copy link

@bgunebakan bgunebakan commented Apr 24, 2024

The to_json function in the Python generator currently throws a TypeError when attempting to serialize objects that contain date types such as datetime.date. This issue affects all Python clients generated by the OpenAPI generator where the schema contains date types. The error encountered is: "Object of type date is not JSON serializable."

Related Issue: #18397

Proposed Changes:
This update modifies the to_json method in the model_generic.mustache template to incorporate a more dynamic approach to excluding fields during serialization. This approach ensures that fields that could potentially cause serialization errors, such as read-only fields or additional properties, are automatically excluded based on the model configuration.

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 Apr 25, 2024

thanks for the PR. please follow step 3 to update the samples so that the CI can verify the change.

@wing328
Copy link
Member

wing328 commented Apr 30, 2024

cc
@cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)

@wing328
Copy link
Member

wing328 commented Apr 30, 2024

the python tests failed.

can you please take a look when you've time?

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.

None yet

2 participants