From 9843f66bb651572bc89f7817c8bde45fb98e6f3d Mon Sep 17 00:00:00 2001 From: "nicolas.dorier" Date: Wed, 22 Dec 2021 11:39:43 +0900 Subject: [PATCH] Add example to cryptoCode in greenfield doc --- .../swagger/v1/swagger.template.invoices.json | 3 ++- .../swagger.template.lightning.internal.json | 24 ++++++++++++------- .../v1/swagger.template.lightning.store.json | 24 ++++++++++++------- .../v1/swagger.template.serverinfo.json | 3 ++- ...res-payment-methods.lightning-network.json | 9 ++++--- ...template.stores-payment-methods.lnurl.json | 9 ++++--- ...plate.stores-payment-methods.on-chain.json | 15 ++++++++---- ...agger.template.stores-wallet.on-chain.json | 24 ++++++++++++------- 8 files changed, 74 insertions(+), 37 deletions(-) diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json index 0f5f8291b..5765a0dcd 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json @@ -1156,7 +1156,8 @@ }, "cryptoCode": { "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": { "type": "string", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json index 0650e111b..67344a7cc 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json @@ -14,7 +14,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the lightning node", @@ -61,7 +62,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Connect to another lightning node.", @@ -131,7 +133,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the current channels of the lightning node", @@ -176,7 +179,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "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", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Get an on-chain deposit address for the lightning node ", @@ -292,7 +297,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } , { "name": "id", "in": "path", @@ -347,7 +353,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Pay a lightning invoice.", @@ -417,7 +424,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Create a lightning invoice.", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json index c6c07f662..ee40f927a 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json @@ -14,7 +14,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -70,7 +71,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -149,7 +151,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -203,7 +206,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -283,7 +287,8 @@ "schema": { "type": "string", "description": "A bitcoin address belonging to the lightning node" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -340,7 +345,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -405,7 +411,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", @@ -484,7 +491,8 @@ "description": "The cryptoCode of the lightning-node to query", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "storeId", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json index f7fb6159a..b60d4c6a2 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json @@ -89,7 +89,8 @@ "properties": { "cryptoCode": { "type": "string", - "description": "The CryptoCode of the crypto currency (eg. BTC)" + "description": "The CryptoCode of the crypto currency (eg. BTC)", + "example": "BTC" }, "nodeInformation": { "$ref": "#/components/schemas/ApplicationServerInfoNodeStatusData" diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json index 7a4f33272..5050f21ce 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json @@ -73,7 +73,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the specified payment method", @@ -127,7 +128,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Update the specified store's payment method", @@ -203,7 +205,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Removes the specified store payment method.", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json index 2ccd4f849..a82a5d159 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json @@ -73,7 +73,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the specified payment method", @@ -127,7 +128,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Update the specified store's payment method", @@ -203,7 +205,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Removes the specified store payment method.", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json index c9a2217f8..2389a7129 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json @@ -73,7 +73,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the specified payment method", @@ -127,7 +128,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Update the specified store's payment method", @@ -203,7 +205,8 @@ "description": "The crypto code of the payment method to update", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Removes the specified store payment method.", @@ -261,7 +264,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "offset", @@ -333,7 +337,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "offset", diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json index 5d294620a..2faf33965 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json @@ -23,7 +23,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "View information about the specified wallet", @@ -79,7 +80,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "blockTarget", @@ -145,7 +147,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "forceGenerate", @@ -209,7 +212,8 @@ "description": "The crypto code of the payment method to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "UnReserve address", @@ -258,7 +262,8 @@ "description": "The crypto code of the wallet to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "statusFilter", @@ -345,7 +350,8 @@ "description": "The crypto code of the wallet", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "requestBody": { @@ -419,7 +425,8 @@ "description": "The crypto code of the wallet to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" }, { "name": "transactionId", @@ -484,7 +491,8 @@ "description": "The crypto code of the wallet to fetch", "schema": { "type": "string" - } + }, + "example": "BTC" } ], "description": "Get store on-chain wallet utxos",