docs: document encode_path_params Python generator option - #6496
docs: document encode_path_params Python generator option#6496devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Claude Code Review
Claude Code Review is paused for this repository. To reconnect it, an admin of this repository's GitHub organization (or the account owner, for personal repositories) who can also manage your Claude organization's Code Review settings needs to re-link GitHub in Code Review settings. This is a one-time step.
Tip: disable this comment in your organization's Code Review settings.
|
🌿 Preview your docs: https://fern-preview-devin-1785604053-encode-path-params.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Summary
Documents
encode_path_params, a new opt-in Python SDK generator flag that makes generated clients percent-encode path parameter values. Without it, a value such as../connectionsreaches the URL intact and, after normalization by the HTTP client or server, can resolve to a different endpoint than the SDK method targeted (a path-traversal-style risk). Enabling it brings the Python SDK in line with the TypeScript, Go, Java, and C# generators. It ships opt-in because APIs that intentionally accept slashes inside a path parameter value will now receive%2F.Implements docs for: feat(python): add encode_path_params config to percent-encode path parameters (fern-api/fern#17295)
Changes
fern/products/sdks/generators/python/configuration.mdx: added anencode_path_params<ParamField>(bool, defaultfalse) alongside the neighboring config options, covering the encoding behavior and the slash-containing-value caveat.Validation:
pre-commit run --files <changed file>(no new Vale findings) andfern check --warnings(0 errors; only pre-existing warnings).Link to Devin session: https://app.devin.ai/sessions/d4d0d61b9df44c87b58623621f6538a8