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(fastapi): use correct impl & package vars on custom user values #20970

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

Conversation

hegerdes
Copy link

@hegerdes hegerdes commented Mar 25, 2025

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.

Changes

This fixes an error when the user supplys custom values for fastapiImplementationPackage and packageName in the python-fastapi generator.

Currently when the user sets these, the implPackage will be generated on the wrong path (using the default package name) and starting the uvicorn python server would fail, due to wrong imports.

The behavior can be tested with these commands run from the projects root dir:

# Latest upstream
docker run --rm -it --user $(id -u $USER):$(id -g $USER) \
  -v ${PWD}:/local openapitools/openapi-generator-cli generate \
  -i /local/modules/openapi-generator/src/test/resources/3_1/nodesc.yaml \
  -g python-fastapi \
  -o /local/out/ \
  --additional-properties=packageName=my_name,fastapiImplementationPackage=logic

# Fixed version
docker run --rm -it --user $(id -u $USER):$(id -g $USER) \
  -v ${PWD}:/local hegerdes/debug:openapi-generator generate \
  -i /local/modules/openapi-generator/src/test/resources/3_1/nodesc.yaml \
  -g python-fastapi \
  -o /local/out/ \
  --additional-properties=packageName=my_name,fastapiImplementationPackage=logic

Please compare the src/<moduleName> and src/<moduleName>/impl names.

NOTE: There are existing tests, unfortunately these contained the same error as in the source-code. The source and test have been adapted and the handling of implPackage now aligns more to the handling of other attributes like packageName.

cc: @cbornet @tomplus @krjakbrjak @fa0311 @multani @krjakbrjak

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.

1 participant