chore: add interface for all error response types #434
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
In the current formulation, downstream code cannot consume a generic `Error` type, because current error types inherit from a parent abstract class. This PR introduces an error interface, `IError`, which specifies that an error response has the following properties: - `InnerException` - `ErrorCode` - `Message` which is common to all error classes. With this in place we inherit the documentation from the interface, simplifying the doc strings in the response classes.
malandis
requested review from
nand4011,
cprice404,
pgautier404,
eaddingtonwhite and
poppoerika
| @@ -43,19 +43,19 @@ public Error(SdkException error) | |||
| _error = error; | |||
| } | |||
|
|
|||
| /// <include file="../docs.xml" path='docs/class[@name="Error"]/prop[@name="InnerException"]/*' /> | |||
| /// <inheritdoc /> | |||
eaddingtonwhite
approved these changes
May 2, 2023
cprice404
approved these changes
May 2, 2023
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.
In the current formulation, downstream code cannot consume a generic
Errortype, because current error types inherit from a parentabstract class.
This PR introduces an error interface,
IError, which specifies thatan error response has the following properties:
InnerExceptionErrorCodeMessagewhich is common to all error classes.
With this in place we inherit the documentation from the interface,
simplifying the doc strings in the response classes.
Eventually we should the same for
Success,Hit, andMiss.closes #433