Send JSON string payloads as objects - #39
Open
jsachs wants to merge 1 commit into
Open
Conversation
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
Send string payloads as JSON objects when request validation is disabled.
Problem
Public client methods accept request bodies as either a dictionary or a JSON string:
When
Config.validateis disabled, which is the default, a JSON string was passed directly torequestsusing itsjson=argument.requeststhen serialized that string as a JSON string literal instead of a JSON object.For example, this input:
was sent as:
"{\"incident_number\": \"1234\"}"instead of:
{ "incident_number": "1234" }Endpoints that require an
application/jsonobject can reject this payload or report validation errors because the top-level value is a string rather than an object.Fix
Parse JSON string payloads into Python objects before passing them to
requestswhen model validation is not being used.Dictionary payloads and validated payloads retain their existing behavior.
Tests
Added a regression test verifying that a JSON string payload is sent as a JSON object when validation is disabled.