Skip to content

Fix rpc documentation for Router Service#10658

Open
saubyk wants to merge 2 commits intolightningnetwork:masterfrom
saubyk:fix_rpc_documentation
Open

Fix rpc documentation for Router Service#10658
saubyk wants to merge 2 commits intolightningnetwork:masterfrom
saubyk:fix_rpc_documentation

Conversation

@saubyk
Copy link
Collaborator

@saubyk saubyk commented Mar 24, 2026

Change Description

lncli tag added to SendPaymentV2, SendToRouteV2 and EstimateRouteFee rpcs to generate supporting API documentation for the shell commands.

E.g currently: https://lightning.engineering/api-docs/api/lnd/router/send-to-route-v2/ shows # There is no CLI command for this RPC on the shell section

Add lncli: tags to SendPaymentV2, SendToRouteV2, and EstimateRouteFee
proto definitions so the generated API docs correctly show their
corresponding CLI commands (sendpayment, sendtoroute, estimateroutefee)
instead of "There is no CLI command for this RPC".
@saubyk saubyk self-assigned this Mar 24, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue with the generation of API documentation for the Router Service. By introducing specific lncli tags to several RPC methods, it ensures that the lncli shell commands are properly referenced in the automatically generated documentation, improving clarity and usability for developers interacting with the Lightning Network Daemon.

Highlights

  • RPC Documentation: Added lncli tags to the SendPaymentV2, SendToRouteV2, and EstimateRouteFee RPC definitions within routerrpc.proto. This ensures that the generated API documentation correctly links these RPCs to their corresponding lncli shell commands.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly adds the lncli: tags to several RPCs in the router.proto file, which will fix the generated API documentation. The changes are consistent and follow the project's conventions. I have one minor suggestion to update a placeholder in the release notes.

@saubyk saubyk force-pushed the fix_rpc_documentation branch from 7a72c5e to 7b4ccd1 Compare March 24, 2026 04:39
@saubyk saubyk added this to the v0.21.0 milestone Mar 24, 2026
@saubyk saubyk added this to v0.21 Mar 24, 2026
@saubyk saubyk moved this to In review in v0.21 Mar 24, 2026
@saubyk saubyk marked this pull request as ready for review March 24, 2026 04:41
Copy link
Collaborator

@ellemouton ellemouton left a comment

Choose a reason for hiding this comment

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

need to regenerate the protos 🙏 see failing CI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants