feat: disable client-side response validation #243
Merged
+322
−2,111
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
The client-side response validation that Goa generated makes it impossible to add new required fields to server responses without disrupting clients that are connected to older versions of the Control Plane server. Adding new fields is typically a backwards compatible change, but in this case the client will return a validation error when the server does not include the response. This commit adds a small Goa plugin to produce an empty validation function for server response bodies.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
The client-side response validation Goa generated makes it impossible to add new required fields or enum values to server responses without disrupting clients connected to older versions of the Control Plane server. Adding new fields is typically a backward-compatible change, but in this case, the client will return a validation error when the server does not include the response.
This commit adds a small Goa plugin to produce an empty validation function for server response bodies.
Changes
api/pluginsandapi/apiv1/design/api.gomake -C api generateTesting
Shouldn't have any noticeable affect until we add a new
requiredfield or enum value to a server response.