Removing strict objects from Zodios clients generation #966
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.
Closes IMN-823
This PR removes
strictObjects
to avoid.strict()
on the generated Zod types used by Zodios.Why?
As we discussed, there are cases where we could be adding fields to an object that are not part of the model, without TS complaining - see this TS playground example
Thus, we must remove
.strict()
from Zod validators because it could cause a runtime error. For example:.strict()
validator and the extra properties, the API call failsWithout
.strict()
, the runtime validators strip the extra properties without erroring, which prevents these potential bugs.