Skip to content

docs(sdks): document PHP encode-path-params config option #6525

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
+4 −0
Open

docs(sdks): document PHP encode-path-params config option #6525

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/php/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Allows customization of the generated `composer.json` file contents. You can spe
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>

<ParamField path="encode-path-params" type="boolean" default="false" required={false} toc={true}>
Percent-encodes path parameter values as the generated SDK substitutes them into the request path, so a value containing `/` or `..` can't change which endpoint the request resolves to. Values that intentionally contain slashes, such as file-path-like IDs, are sent as `%2F`.
</ParamField>

<ParamField path="inlinePathParameters" type="boolean" required={false} toc={true}>
When enabled, path parameters are included as properties in the request class instead of being passed as separate method parameters. This creates a more unified request structure where all parameters are grouped together in the request object.
</ParamField>
Expand Down
Loading