Incorrect Endpoint and Deprecated Parameter in lookupInvoice API Documentation

[sandrovw64]

Hi LND team,

I’ve encountered an issue with the API documentation for the lookupInvoice endpoint. The current documentation at https://lightning.engineering/api-docs/api/lnd/lightning/lookup-invoice/ contains two errors:

Incorrect Endpoint Path:
The documentation states the endpoint as /v1/invoice/.

However, the correct endpoint should be /v1/invoices/ (plural).
This discrepancy is causing confusion and errors when trying to use the API.

Deprecated Parameter:
The documentation suggests using the parameter r_hash_str, which is deprecated.

The correct parameter to use is r_hash, as in ?r_hash={r_hash}.
This aligns with the current implementation and best practices.

Steps to Reproduce:
Visit the API documentation page: https://lightning.engineering/api-docs/api/lnd/lightning/lookup-invoice/

Observe the endpoint path /v1/invoice/ and the parameter r_hash_str.

Attempt to use the endpoint as documented, and notice the mismatch with the actual API behavior.

Expected Behavior:
The endpoint should be documented as /v1/invoices/.
The parameter should be documented as r_hash, not r_hash_str.

Thank you for your attention to this matter.
Let me know if you need further details or clarification.

Best regards,

Sandro

[guggero]

The /v1/invoice/ path is correct, according to the REST mapping: https://github.com/lightningnetwork/lnd/blob/8a2c3a3d850b03494933ffe37ed62345e75eacea/lnrpc/lightning.yaml#L95

Or do you mean it should be renamed to be more RESTy? I guess we could add an additional (more correct) mapping. But renaming would break backward compatibility, which we don't do.

Also, the r_hash_str was specifically added to support REST calls, back when there were some issues with base64 encoded parts in the URL. This has since been resolved, that's why the string parameter was deprecated.

Anyway, the API generator doesn't need to change anything, all the data comes from the proto and REST mapping files in lnd.