-
Notifications
You must be signed in to change notification settings - Fork 19
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
Initial attempt at order error enum docs #2010
Conversation
This PR adds some documentation to the order error proto in order to improve the documentation, so that we can point people at our API docs to figure out why an order they submitted ended up this way. There are two errors I don't yet understand so this isn't ready yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ORDER_ERROR_TIME_FAILURE // Unable to get Vega (blockchain) time
ORDER_ERROR_REMOVAL_FAILURE // Failed to remove an order from the book
Amended instead of Ammended
ORDER_ERROR_AMEND_FAILURE // Amend failure because amend details do not match original order
ORDER_ERROR_NOT_FOUND // Order not found in the order book or in order store
ORDER_ERROR_EDIT_NOT_ALLOWED // This occurs when the client tries to amend a field that is not amendable (like order type, creation time etc) |
Also specifically this task is related https://github.com/vegaprotocol/docs/issues/77 |
Nice! Be aware that it takes longer than you think to work out the reasons why some error codes are triggered - I thought I could bash this out in 20 minutes, but it's probably been an hour + 20 minutes of Pete's time, and I'm not even sure that they're right. But they're definitely better than nothing. |
Add @peterbarrow's descriptions for: - Add edit not allowed description - Add time failure description - Add amend failure description - Add not found error description
Thanks @peterbarrow, I've merged all yours in to the PR. I still have to regenerate the gubbins so I'll mark this as draft until I have. |
- Update ORDER_ERROR_EDIT_NOT_ALLOWED description not to use the term ‘edited’
system-tests failed.
|
This PR adds some documentation to the order error proto in order to improve the generated documentation.
Closes #2002