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

[BUG][python-fastapi] Copy escapeReservedWord implementation from python generator #20035

Merged

Conversation

andlien
Copy link
Contributor

@andlien andlien commented Nov 6, 2024

Fixes #20030

Copied implementation from PythonClientCodegen.escapeReservedWord() to handle fields with reserved words in pydantic models.
I'm unsure whether to target master or a minor release branch even if this results in field renaming. Decided to go with master since affected models were inherently broken, and since python-fastapi is currently in beta. Please comment if you decide otherwise.

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.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.

@cbornet @tomplus @krjakbrjak @fa0311 @multani

@wing328
Copy link
Member

wing328 commented Nov 7, 2024

thanks for the PR

we can consider this change a bug fix.

@wing328 wing328 merged commit e2553a4 into OpenAPITools:master Nov 7, 2024
15 checks passed
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.

[BUG][python-fastapi] fieldNames with reserved words are turned into private attributes in pydantic models
2 participants