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

YAML specification for ledger_entry request #7

Merged
merged 3 commits into from
Sep 17, 2024

Conversation

ckeshava
Copy link
Collaborator

@ckeshava ckeshava commented Sep 4, 2024

This specification borrows content from the documentation webpage: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry#response-format

I'd like to see these issues fixed in the main documentation site. We need to update the specification after that change.

As part of future work, I'd like to add unit test to validate the correctness of these models. More importantly, unit tests are absent for all the models relevant to the current prototype specification. We need to port tests from the client libraries into the code-generation repository to make up for the deficit.

bridge:
type: object
properties:
IssuingChainDoor:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these fields are required for BridgeEntry

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated in 0730767

@pdp2121
Copy link
Collaborator

pdp2121 commented Sep 17, 2024

Tricky part here would be to handle things like Omitted if "binary": true specified. or Required if ticket is specified as an object). I guess we will know better when we do codegen or docgen. Will just approve for now

@pdp2121 pdp2121 merged commit 90b9adb into ripple:main Sep 17, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

2 participants