fix!: URL-encode path parameters in generated endpoints #1349
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Path parameters containing reserved characters were being inserted directly into URLs without encoding, causing malformed requests and potential security issues.
Problem
When path parameters contain special characters like:
/)?)&)#)These were not being URL-encoded, leading to:
Solution
urllib.parse.quotein the endpoint templatequote(str(...), safe="")to ensure proper percent-encodingChanges
openapi_python_client/templates/endpoint_module.py.jinjato add URL encodingend_to_end_tests/functional_tests/generated_code_execution/test_path_parameters.pywith testsTest plan
pdm regenExample
Before:
After: