Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
7 changes: 5 additions & 2 deletions generators/python/core_utilities/shared/jsonable_encoder.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
from pathlib import PurePath
from types import GeneratorType
from typing import Any, Callable, Dict, List, Optional, Set, Union
from urllib.parse import quote

import pydantic
from .datetime_utils import serialize_datetime
Expand Down Expand Up @@ -111,8 +112,10 @@ def encode_path_param(obj: Any) -> str:

Ensures proper string conversion for all types, including
booleans which need lowercase 'true'/'false' rather than
Python's 'True'/'False'.
Python's 'True'/'False'. The result is percent-encoded so that a
value containing "/" or ".." cannot change which endpoint the
request resolves to.
"""
if isinstance(obj, bool):
return "true" if obj else "false"
return str(jsonable_encoder(obj))
return quote(str(jsonable_encoder(obj)), safe="")
Comment thread
willkendall01 marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# yaml-language-server: $schema=../../../../../fern-changes-yml.schema.json

- summary: |
Percent-encode path parameter values. `encode_path_param` previously only stringified the value,
so a value containing `/` or `..` could change which endpoint the request resolved to. It now
applies `urllib.parse.quote(..., safe="")`, matching the TypeScript, Go, Java, and C# generators.
type: fix
Comment thread
willkendall01 marked this conversation as resolved.
Outdated
11 changes: 10 additions & 1 deletion generators/python/tests/sdk/test_jsonable_encoder.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,19 @@

from fern.generator_exec.logging import GeneratorUpdate, InitUpdateV2

from core_utilities.shared.jsonable_encoder import jsonable_encoder
from core_utilities.shared.jsonable_encoder import encode_path_param, jsonable_encoder


def test_jsonable_encoder() -> None:
updates: List[GeneratorUpdate] = [GeneratorUpdate.factory.init_v_2(InitUpdateV2(publishing_to_registry=None))]
serialized = jsonable_encoder(updates)
assert serialized == [{"_type": "initV2", "publishingToRegistry": None}]


def test_encode_path_param() -> None:
assert encode_path_param("../connections") == "..%2Fconnections"
assert encode_path_param("user id?") == "user%20id%3F"
assert encode_path_param("user_1") == "user_1"
assert encode_path_param(42) == "42"
assert encode_path_param(True) == "true"
assert encode_path_param(False) == "false"
Comment thread
willkendall01 marked this conversation as resolved.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions seed/python-sdk/alias/src/seed/core/jsonable_encoder.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions seed/python-sdk/any-auth/src/seed/core/jsonable_encoder.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions seed/python-sdk/audiences/src/seed/core/jsonable_encoder.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions seed/python-sdk/basic-auth/src/seed/core/jsonable_encoder.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading