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

How to get all jsonrpc methods, including request and response params? #1659

Open
thefinn93 opened this issue Dec 29, 2024 · 1 comment
Open

Comments

@thefinn93
Copy link
Contributor

I'm looking for a way to get a list of all jsonrpc methods and their associated request/response params, ideally in a machine-readable format. I'm hoping to use this to generate a client, rather than manually re-typing the entire protocol. Is this something that is already supported? If not, is it something there would be interest in supporting?

Thanks

@AsamK
Copy link
Owner

AsamK commented Jan 2, 2025

There's currently no machine-readable documentation.
The JSON-RPC commands are based on the cli arguments (see JSON-RPC man page and
cli man page)

I've had some ideas for creating a new API for defining commands, that can generate the argparse4j commands for the cli and parse JSON-RPC requests (with better validation, than the current state).
That API could then also be used to generate machine-readable documentation and maybe also for shell-completions.
However that's just some rough ideas and no code yet.

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

2 participants