Custom ValidationException RFC
#4272
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
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
aajtodd
reviewed
Aug 21, 2025
| Currently, if there is a constrained shape in the input shape closure of an operation, the operation **must** add `smithy.framework#ValidationException` to the operation's error list, otherwise a build error is raised: | ||
|
|
||
| ``` | ||
| Caused by: ValidationResult(shouldAbort=true, messages=[LogMessage(level=SEVERE, message=Operation com.aws.example#GetStorage takes in input that is constrained (https://smithy.io/2.0/spec/constraint-traits.html), and as such can fail with a validation exception. You must model this behavior in the operation shape in your model file. |
There was a problem hiding this comment.
if this comes from smithy how are you disabling or getting around this validation? Also this seems like something we'd want to upstream to smithy anyway right?
There was a problem hiding this comment.
No, we do this as part of the server code here:
GJason88
reviewed
Sep 12, 2025
| How to actually implement this RFC | ||
| ---------------------------------- | ||
|
|
||
| ### 1. Create validation exception traits |
There was a problem hiding this comment.
Does it makes sense/what are the implications of getting these implemented upstream in https://github.com/smithy-lang/smithy/tree/main/smithy-model/src/main/java/software/amazon/smithy/model/traits?
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.
Rendered
Motivation and Context
Add an RFC to support custom
ValidationException. This will allow server developers to use a custom structure Smithy shape as aValidationException.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.