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

[python] fix: Annotate free-form object as dict in Python #17082

Merged

Conversation

robertschweizer
Copy link
Contributor

Model properties annotated only with type: object are currently turned into Union[str, Any] in Python. This is wrong, since they must be dictionaries. They cannot be strings.

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.

@multani @fa0311 @wing328

@wing328
Copy link
Member

wing328 commented Nov 18, 2023

LGTM. Let's give it a try.

@wing328 wing328 merged commit 5e7f2f2 into OpenAPITools:master Nov 18, 2023
26 checks passed
@mtraynham
Copy link
Contributor

mtraynham commented Mar 4, 2024

@robertschweizer What if the free form object is a dictionary or array? This change kind of prevents you from being able to parse it yourself from a string.

@robertschweizer
Copy link
Contributor Author

A "free form object" must have type: object in the JSON schema I believe. So it must be a "dictionary" in Python terms, it cannot be a string or array.

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.

None yet

3 participants