Skip to content

docs: document encode_path_params Python generator option #6496

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.

Sign up for GitHub

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

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document encode_path_params Python generator option #6496

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/sdks/generators/python/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ The name of the generated client class. Must be PascalCase. For example, setting
The default number of retries for failed requests in the generated SDK. Set to `0` to disable retries by default. SDK users can still override this per-request via request options.
</ParamField>

<ParamField path="encode_path_params" type="bool" default="false" required={false} toc={true}>
When enabled, the generated SDK escapes reserved characters in path parameter values before building the request path. For example, `../connections` is sent as `..%2Fconnections`. APIs that accept slashes inside a path parameter value receive `%2F` instead of `/`.
</ParamField>

<ParamField path="enable_wire_tests" type="bool" default="false" required={false} toc={true}>
When enabled, generates [mock server (wire) tests](/sdks/deep-dives/testing#mock-server-tests) to verify that the SDK sends and receives HTTP requests as expected.
</ParamField>
Expand Down
Loading