FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: preserve omitted and null JSON request bodies by CodingCossack · Pull Request #1488 · openapi-generators/openapi-python-client · GitHub

  1. openapi-generators
  2. openapi-python-client

Repository navigation

fix: preserve omitted and null JSON request bodies #1488

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
CodingCossack wants to merge 2 commits into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 0 Commits 2 Checks 1 Files changed
Open

fix: preserve omitted and null JSON request bodies #1488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f1bfb3
fix: preserve omitted and null JSON request bodies
CodingCossack Sep 15, 2026
b492588
test: compare structured request bodies as decoded JSON
CodingCossack Sep 15, 2026
File filter

Filter by extension

Filter by extension .jinja  (1) .py  (18) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
          • misc_metadata_escapes.py
          • non_string_example.py
          • property_escapes.py
          • with_braces_path.py
          • json_like.py
          • optional_body.py
          • post_bodies_multiple.py
          • refs.py
          • content_type_override.py
          • post_const_path.py
          • post_prefix_items.py
400 changes: 400 additions & 0 deletions end_to_end_tests/functional_tests/generated_code_execution/test_nullable_request_bodies.py
Show comments
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions ...d_tests/golden-records/escapes-client/escapes_client/api/default/misc_metadata_escapes.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ..._end_tests/golden-records/escapes-client/escapes_client/api/default/non_string_example.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...to_end_tests/golden-records/escapes-client/escapes_client/api/default/property_escapes.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...ests/golden-records/escapes-client/escapes_client/api/printtag_escape/with_braces_path.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = 'application/json; profile="https://example.com/escape" + print("uh oh") + "'

Expand Down
7 changes: 7 additions & 0 deletions ...to_end_tests/golden-records/my-test-api-client/my_test_api_client/api/bodies/json_like.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@ def _get_kwargs(
"url": "/bodies/json-like",
}

_kwargs["json"] = UNSET
if not isinstance(body, Unset):
_kwargs["json"] = body.to_dict()
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/vnd+json"

Expand Down
7 changes: 7 additions & 0 deletions ...nd_tests/golden-records/my-test-api-client/my_test_api_client/api/bodies/optional_body.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@ def _get_kwargs(
"url": "/bodies/optional",
}

_kwargs["json"] = UNSET
if not isinstance(body, Unset):
_kwargs["json"] = body.to_dict()
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
7 changes: 7 additions & 0 deletions ...s/golden-records/my-test-api-client/my_test_api_client/api/bodies/post_bodies_multiple.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,15 @@ def _get_kwargs(
}

if isinstance(body, PostBodiesMultipleJsonBody):
_kwargs["json"] = UNSET
if not isinstance(body, Unset):
_kwargs["json"] = body.to_dict()
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"
if isinstance(body, File):
Expand Down
7 changes: 7 additions & 0 deletions end_to_end_tests/golden-records/my-test-api-client/my_test_api_client/api/bodies/refs.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@ def _get_kwargs(
"url": "/bodies/refs",
}

_kwargs["json"] = UNSET
if not isinstance(body, Unset):
_kwargs["json"] = body.to_dict()
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
9 changes: 7 additions & 2 deletions .../golden-records/my-test-api-client/my_test_api_client/api/config/content_type_override.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,13 @@ def _get_kwargs(
"url": "/config/content-type-override",
}

if not isinstance(body, Unset):
_kwargs["json"] = body
_kwargs["json"] = body
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "openapi/python/client"

Expand Down
11 changes: 10 additions & 1 deletion ...ds/my-test-api-client/my_test_api_client/api/default/post_types_unions_duplicate_types.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,18 @@ def _get_kwargs(
"url": "/types/unions/duplicate-types",
}

if isinstance(body, AModel):
if isinstance(body, Unset):
_kwargs["json"] = UNSET
else:
_kwargs["json"] = body.to_dict()

if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

_kwargs["headers"] = headers
Expand Down
7 changes: 7 additions & 0 deletions ...est-api-client/my_test_api_client/api/naming/post_naming_property_conflict_with_import.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,15 @@ def _get_kwargs(
"url": "/naming/property-conflict-with-import",
}

_kwargs["json"] = UNSET
if not isinstance(body, Unset):
_kwargs["json"] = body.to_dict()
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
elif _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...end_tests/golden-records/my-test-api-client/my_test_api_client/api/tests/callback_test.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...records/my-test-api-client/my_test_api_client/api/tests/json_body_tests_json_body_post.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...en-records/my-test-api-client/my_test_api_client/api/tests/post_tests_json_body_string.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def _get_kwargs(
}

_kwargs["json"] = body
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...sts/golden-records/my-test-api-client/my_test_api_client/api/tests/test_inline_objects.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...en-records/test-3-1-features-client/test_3_1_features_client/api/const/post_const_path.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
4 changes: 4 additions & 0 deletions ...s/test-3-1-features-client/test_3_1_features_client/api/prefix_items/post_prefix_items.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ def _get_kwargs(
}

_kwargs["json"] = body.to_dict()
if _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]

headers["Content-Type"] = "application/json"

Expand Down
15 changes: 10 additions & 5 deletions openapi_python_client/templates/endpoint_macros.py.jinja
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,18 @@ if not isinstance(body, Unset):
{% set property = body.prop %}
{% import "property_templates/" + property.template as prop_template %}
{% if prop_template.transform %}
{{ prop_template.transform(property, property.python_name, "_kwargs[\"json\"]", skip_unset=True, declare_type=False) }}
{% elif property.required %}
_kwargs["json"] = {{ property.python_name }}
{{ prop_template.transform(property, property.python_name, "_kwargs[\"json\"]", declare_type=False) }}
{% else %}
if not isinstance({{property.python_name}}, Unset):
_kwargs["json"] = {{ property.python_name }}
_kwargs["json"] = {{ property.python_name }}
{% endif %}
{% if not property.required %}
if isinstance(_kwargs["json"], Unset):
del _kwargs["json"]
{% endif %}
{% if property.required %}if{% else %}elif{% endif %} _kwargs["json"] is None:
# HTTPX treats json=None as no body; send JSON null explicitly.
_kwargs["content"] = b"null"
del _kwargs["json"]
{% endmacro %}

{% macro multipart_body(body) %}
Expand Down
Back | FazBrowse Home | New Git URL