Allow common errors to be bound to a service #919
Merged
Conversation
This file contains 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
adamthom-amzn
approved these changes
Sep 24, 2021
This commit allows a common list of errors to be bound to a service shape so that every operation within the closure of the service implicitly can return the common errors. This is a very common pattern, and this change makes it easier to add common errors without needing things like validation to enforce them being added to every operation. Existing code generation tooling will either need to be updated to perform a model transform that copies common errors onto each operation bound within a service (see `copyServiceErrorsToOperations`), or they need to use the introduced `getErrors` method on `OperationIndex` that also takes in a service shape ID. Closes #894
mtdowling
force-pushed
the
add-errors-to-service
branch
from
5ce373c to
82e9167
Compare
JordonPhillips
requested changes
Sep 24, 2021
smithy-diff/src/main/java/software/amazon/smithy/diff/evaluators/AddedServiceError.java
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/shapes/OperationShape.java
Show resolved
Hide resolved
smithy-model/src/main/java/software/amazon/smithy/model/neighbor/NeighborVisitor.java
Show resolved
Hide resolved
JordonPhillips
approved these changes
Sep 24, 2021
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.
This commit allows a common list of errors to be bound to a service
shape so that every operation within the closure of the service
implicitly can return the common errors. This is a very common pattern,
and this change makes it easier to add common errors without needing
things like validation to enforce them being added to every operation.
Existing code generation tooling will either need to be updated to
perform a model transform that copies common errors onto each operation
bound within a service (see
copyServiceErrorsToOperations), or theyneed to use the introduced
getErrorsmethod onOperationIndexthatalso takes in a service shape ID.
Closes #894
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.