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

Update documentation for ledger_entry Request #2745

Open
ckeshava opened this issue Sep 3, 2024 · 1 comment
Open

Update documentation for ledger_entry Request #2745

ckeshava opened this issue Sep 3, 2024 · 1 comment

Comments

@ckeshava
Copy link
Contributor

ckeshava commented Sep 3, 2024

  1. The documentation does not mention "unexpectedLedgerType" error under the "Possible Errors" section. Here are examples of this error from the unit tests. This is the corresponding source code for the origin of the error message.
  2. In case of parsing failures, API v1 returns a generic throw whereas API v2 returns invalidParams error. This recent change is coded here This difference in the behavior between v1 and v2 might need to specified in the docs page.
@ckeshava
Copy link
Contributor Author

ckeshava commented Sep 9, 2024

Under the "Possible Errors" section, "malformedDocumentID" needs to be documented. This error is returned for incorrectly specified Oracle ledger objects. This is the source code responsible for that error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant