Update docs with return payload #469
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
iansuvak
requested review from
feuGeneA,
geoff-vball,
minghinmatthewlam,
bernard-avalabs,
michaelkaplan13 and
cam-schultz
geoff-vball
approved these changes
Sep 3, 2024
|
We have previously gone with the standard of leaving HTTP status codes to any network level issues/infra, and always returning 200 with an error message for any application level errors. To stay consistent, I'd recommend we do that here as well to match other platform APIs |
Sure thing -- I'll remove references but I am curious about the reasoning here. In general I think that there is value in distinguishing between client caused failures and internal errors |
geoff-vball
approved these changes
Sep 4, 2024
iansuvak
changed the title
cam-schultz
approved these changes
Sep 5, 2024
bernard-avalabs
approved these changes
Sep 5, 2024
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.
Why this should be merged
Returns error status codes and adds response documentation to the signature aggregator API
How this works
How this was tested
How is this documented