Serialize enum values for API requests - #35
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.
Problem
The generated API models use Python
Enumclasses.requestsserializes a normalenum using its Python string representation rather than its wire value.
For example:
previously prepared a query parameter equivalent to:
The API expects:
This can cause entity filtering and sorting requests to return no results or be
rejected as invalid query parameters.
The same issue affects incident-status updates. For example:
previously sent:
rather than the API value:
Fix
Normalize
Enumvalues to their.valuerepresentation before sending queryparameters, including lists of enum values. Send the incident status enum's
.valuein the update request.Tests
Added regression coverage for:
"APPROVED"instead of the Python enum name.