Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description for errors #340

Open
bevalorous opened this issue Apr 16, 2021 · 3 comments
Open

Add description for errors #340

bevalorous opened this issue Apr 16, 2021 · 3 comments
Labels
discuss enhancement New feature or request

Comments

@bevalorous
Copy link

A description field could be helpful for adding some additional information to the errors that doesn't necessarily end up going over the wire: what the error means, when and why it happens, how it can be handled or walked around, which actions may be performed to mitigate it, etc.

@github-actions
Copy link

Welcome to OpenRPC! Thank you for taking the time to create an issue. Please review the guidelines

@stale
Copy link

stale bot commented Jun 16, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jun 16, 2021
@stale stale bot closed this as completed Jun 26, 2021
@BelfordZ
Copy link
Member

BelfordZ commented Jul 5, 2022

Hey there

Good thinking. code, message and data are all fields which are returned as part of the json-rpc error response. As such, there is no where to add documentation that is to be consumed outside the request-response lifecycle.

In addition to description, I think we should also add a name field, which is essential for code generators to be able to produce typed errors.

@BelfordZ BelfordZ reopened this Jul 5, 2022
@stale stale bot removed the stale label Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants