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(rpc): Create documentation resource for all RPCs #8324

Closed
upbqdn opened this issue Feb 26, 2024 · 1 comment · Fixed by #8342 or #8351
Closed

add(rpc): Create documentation resource for all RPCs #8324

upbqdn opened this issue Feb 26, 2024 · 1 comment · Fixed by #8342 or #8351
Assignees
Labels
A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces I-usability Zebra is hard to understand or use

Comments

@upbqdn
Copy link
Member

upbqdn commented Feb 26, 2024

Motivation

Zebra now contains RPCs that are only documented in the API docs rendered at https://docs.rs/zebra-grpc/0.1.0-alpha.2/zebra_grpc/server/struct.ScannerRPC.html. These docs are Rust-specific and not suitable as general documentation for an RPC endpoint.

Zebra also implements JSON RPCs for lightwalletd: https://docs.rs/zebra-rpc/1.0.0-beta.35/zebra_rpc/methods/index.html; and JSON RPCs for mining, which are currently not rendered in the public API due to #8169. Note that the JSON RPCs are in a different crate than the gRPCs, which complicates discoverability.

zcashd renders its RPCs here: https://zcash.github.io/rpc/. Ideally, we should create a similar resource that would:

  • be language-agnostic,
  • contain the docs for all RPCs under one roof,
  • render the docs directly from the source code.

It would be great if we found a tool that would fulfill the requirements above, and we could integrate it into CD.

@upbqdn upbqdn added A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces labels Feb 26, 2024
@github-project-automation github-project-automation bot moved this to New in Zebra Feb 26, 2024
@mpguerra mpguerra moved this from New to Product Backlog in Zebra Feb 28, 2024
@mpguerra mpguerra added the I-usability Zebra is hard to understand or use label Feb 28, 2024
@oxarbitrage oxarbitrage self-assigned this Feb 28, 2024
@mpguerra mpguerra moved this from Product Backlog to Sprint Backlog in Zebra Feb 29, 2024
@mpguerra mpguerra moved this from Sprint Backlog to In progress in Zebra Mar 6, 2024
@upbqdn upbqdn mentioned this issue Mar 14, 2024
7 tasks
This was linked to pull requests Mar 15, 2024
@mpguerra mpguerra moved this from In progress to Product Backlog in Zebra Apr 1, 2024
@oxarbitrage
Copy link
Contributor

I think we can close this and do the grpc in #8407

@github-project-automation github-project-automation bot moved this from Product Backlog to Done in Zebra Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces I-usability Zebra is hard to understand or use
Projects
Archived in project
3 participants