BTCPayServer.Lightning icon indicating copy to clipboard operation
BTCPayServer.Lightning copied to clipboard

Add missing parameters from the current lnd lightning swagger definition

Open DocBrown101 opened this issue 3 years ago • 0 comments

Source: https://github.com/lightningnetwork/lnd/blob/master/lnrpc/lightning.swagger.json

For example, paging parameters for the "listinvoices" function are missing:

{
"/v1/invoices": {
      "get": {
        "summary": "lncli: `listinvoices`\nListInvoices returns a list of all the invoices currently stored within the\ndatabase. Any active debug invoices are ignored. It has full support for\npaginated responses, allowing users to query for specific invoices through\ntheir add_index. This can be done by using either the first_index_offset or\nlast_index_offset fields included in the response as the index_offset of the\nnext request. By default, the first 100 invoices created will be returned.\nBackwards pagination is also supported through the Reversed flag.",
        "operationId": "Lightning_ListInvoices",
        "responses": {
          "200": {
            "description": "A successful response.",
            "schema": {
              "$ref": "#/definitions/lnrpcListInvoiceResponse"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/rpcStatus"
            }
          }
        },
        "parameters": [
          {
            "name": "pending_only",
            "description": "If set, only invoices that are not settled and not canceled will be returned\nin the response.",
            "in": "query",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "index_offset",
            "description": "The index of an invoice that will be used as either the start or end of a\nquery to determine which invoices should be returned in the response.",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "num_max_invoices",
            "description": "The max number of invoices to return in the response to this query.",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "uint64"
          },
          {
            "name": "reversed",
            "description": "If set, the invoices returned will result from seeking backwards from the\nspecified index offset. This can be used to paginate backwards.",
            "in": "query",
            "required": false,
            "type": "boolean"
          }
        ],
        "tags": [
          "Lightning"
        ]
      }
}

DocBrown101 avatar Nov 21 '21 12:11 DocBrown101