Disable client-side validation of responses #490
Merged
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
jhamon
force-pushed
the
jhamon/no-clientside-validation
branch
from
9d1209f to
674a390
Compare
jhamon
commented
May 16, 2025
| if (name,) in self.validations and self._enforce_validations: | ||
| # Disabling validation on response makes the SDK | ||
| # less fragile if unexpected values are returned. In general, | ||
| # we want the SDK to display whatever is returned by the API. |
There was a problem hiding this comment.
This is where the logic change actually comes into force.
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
Sometimes unexpected values in API responses can cause unnecessary errors due to validation logic being applied. Fields labeled in the openapi as
enumfields will error when unexpected values appear in the response. In general, we want the client to just display what the API returns without applying validation.Solution
Adjust the code generation to disable validation logic when instantiating model objects from API response.
Type of Change
Test Plan
I created a mock server script to do some manual testing of different responses with odd values in them and saw this works without erroring. For example, these responses no longer raise: