mirrors/btcpayserver
1
0
Fork 0
mirror of https://github.com/btcpayserver/btcpayserver.git synced 2025-02-22 06:21:44 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add example to cryptoCode in greenfield doc

Browse source
This commit is contained in:
nicolas.dorier 2021-12-22 11:39:43 +09:00
parent b2c1846ebb
commit 9843f66bb6
No known key found for this signature in database
GPG key ID: 6618763EF09186FE
8 changed files with 74 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json
View file

@ -1156,7 +1156,8 @@
}, },
"cryptoCode": { "cryptoCode": {
"type": "string", "type": "string",
"description": "Crypto code of the payment method (e.g., \"BTC\" or \"LTC\")" "description": "Crypto code of the payment method (e.g., \"BTC\" or \"LTC\")",
"example": "BTC"
}, },
"destination": { "destination": {
"type": "string", "type": "string",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json
View file

@ -14,7 +14,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the lightning node", "description": "View information about the lightning node",
@ -61,7 +62,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Connect to another lightning node.", "description": "Connect to another lightning node.",
@ -131,7 +133,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the current channels of the lightning node", "description": "View information about the current channels of the lightning node",
@ -176,7 +179,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Open a channel with another lightning node. You should connect to that node first.", "description": "Open a channel with another lightning node. You should connect to that node first.",
@ -243,7 +247,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Get an on-chain deposit address for the lightning node ", "description": "Get an on-chain deposit address for the lightning node ",
@ -292,7 +297,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} , { } , {
"name": "id", "name": "id",
"in": "path", "in": "path",
@ -347,7 +353,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Pay a lightning invoice.", "description": "Pay a lightning invoice.",
@ -417,7 +424,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Create a lightning invoice.", "description": "Create a lightning invoice.",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json
View file

@ -14,7 +14,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -70,7 +71,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -149,7 +151,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -203,7 +206,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -283,7 +287,8 @@
"schema": { "schema": {
"type": "string", "type": "string",
"description": "A bitcoin address belonging to the lightning node" "description": "A bitcoin address belonging to the lightning node"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -340,7 +345,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -405,7 +411,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",
@ -484,7 +491,8 @@
"description": "The cryptoCode of the lightning-node to query", "description": "The cryptoCode of the lightning-node to query",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "storeId", "name": "storeId",

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json
View file

@ -89,7 +89,8 @@
"properties": { "properties": {
"cryptoCode": { "cryptoCode": {
"type": "string", "type": "string",
"description": "The CryptoCode of the crypto currency (eg. BTC)" "description": "The CryptoCode of the crypto currency (eg. BTC)",
"example": "BTC"
}, },
"nodeInformation": { "nodeInformation": {
"$ref": "#/components/schemas/ApplicationServerInfoNodeStatusData" "$ref": "#/components/schemas/ApplicationServerInfoNodeStatusData"

9
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json
View file

@ -73,7 +73,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the specified payment method", "description": "View information about the specified payment method",
@ -127,7 +128,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Update the specified store's payment method", "description": "Update the specified store's payment method",
@ -203,7 +205,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Removes the specified store payment method.", "description": "Removes the specified store payment method.",

9
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json
View file

@ -73,7 +73,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the specified payment method", "description": "View information about the specified payment method",
@ -127,7 +128,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Update the specified store's payment method", "description": "Update the specified store's payment method",
@ -203,7 +205,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Removes the specified store payment method.", "description": "Removes the specified store payment method.",

15
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json
View file

@ -73,7 +73,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the specified payment method", "description": "View information about the specified payment method",
@ -127,7 +128,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Update the specified store's payment method", "description": "Update the specified store's payment method",
@ -203,7 +205,8 @@
"description": "The crypto code of the payment method to update", "description": "The crypto code of the payment method to update",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Removes the specified store payment method.", "description": "Removes the specified store payment method.",
@ -261,7 +264,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "offset", "name": "offset",
@ -333,7 +337,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "offset", "name": "offset",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json
View file

@ -23,7 +23,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "View information about the specified wallet", "description": "View information about the specified wallet",
@ -79,7 +80,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "blockTarget", "name": "blockTarget",
@ -145,7 +147,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "forceGenerate", "name": "forceGenerate",
@ -209,7 +212,8 @@
"description": "The crypto code of the payment method to fetch", "description": "The crypto code of the payment method to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "UnReserve address", "description": "UnReserve address",
@ -258,7 +262,8 @@
"description": "The crypto code of the wallet to fetch", "description": "The crypto code of the wallet to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "statusFilter", "name": "statusFilter",
@ -345,7 +350,8 @@
"description": "The crypto code of the wallet", "description": "The crypto code of the wallet",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"requestBody": { "requestBody": {
@ -419,7 +425,8 @@
"description": "The crypto code of the wallet to fetch", "description": "The crypto code of the wallet to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
}, },
{ {
"name": "transactionId", "name": "transactionId",
@ -484,7 +491,8 @@
"description": "The crypto code of the wallet to fetch", "description": "The crypto code of the wallet to fetch",
"schema": { "schema": {
"type": "string" "type": "string"
} },
"example": "BTC"
} }
], ],
"description": "Get store on-chain wallet utxos", "description": "Get store on-chain wallet utxos",