lightninglabs / lightninglabs/lightning-api-ng

Incorrect Endpoint and Deprecated Parameter in lookupInvoice API Documentation

Open
#39 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
6
Forks
7
PR merge metrics
No merged PRs in 30d

Description

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/](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/](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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the lookupInvoice API documentation page linked in the issue and trace it to the documentation source in this automated-generation repository. Update the displayed endpoint path and parameter, then verify the rendered page shows /v1/invoices/ and r_hash instead of the deprecated values.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.