docs(sdks): document PHP encode-path-params config option - #6525
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(sdks): document PHP encode-path-params config option#6525devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 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:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1785863098-php-encode-path-params.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
PHP SDKs currently drop path parameter values into the URL path unencoded, so a value like
../connectionscan send a request to a different endpoint than the one the caller asked for. The PHP generator now offers an opt-inencode-path-paramsflag that percent-encodes those values, closing that class of bug and bringing PHP in line with TypeScript, Go, Java, and C#, which already encode path parameters. It stays off by default so existing SDKs don't change behavior; teams whose path parameter values intentionally contain slashes should know those are sent as%2Fonce enabled.Implements docs for: feat(php): add encode-path-params config to percent-encode path parameters (fern-api/fern#17294)
Pages changed:
fern/products/sdks/generators/php/configuration.mdx— adds a<ParamField>forencode-path-params(boolean, defaultfalse) in the SDK configuration options list, including the%2Fcaveat.No SDK changelog entry added (handled separately).
Link to Devin session: https://app.devin.ai/sessions/0ecfc6142c97495b84507590f5a8d3c6