From aab1eb0d36cee751bc62431fd32275a375cf5465 Mon Sep 17 00:00:00 2001 From: Umar Bolatov Date: Wed, 2 Feb 2022 03:12:48 -0800 Subject: [PATCH] Ensure Swagger docs are semantically and structurally correct (#3390) * Remove "delete" method from "/api/v1/stores/{storeId}/invoices/{invoiceId}/payment-methods" docs * Remove "requestBody" from "delete" method of "/api/v1/stores/{storeId}/webhooks/{webhookId}" * Rename "API Key" to "API_Key" * Remove "scheme" from API_Key security scheme * Remove "name" and "in" properties from "Basic"security scheme --- BTCPayServer.Tests/UnitTest1.cs | 2 +- .../swagger/v1/swagger.template.api-keys.json | 8 +- .../swagger/v1/swagger.template.invoices.json | 75 +++---------------- .../wwwroot/swagger/v1/swagger.template.json | 9 +-- .../swagger.template.lightning.internal.json | 16 ++-- .../v1/swagger.template.lightning.store.json | 16 ++-- .../v1/swagger.template.notifications.json | 8 +- .../v1/swagger.template.payment-requests.json | 10 +-- .../v1/swagger.template.pull-payments.json | 12 +-- .../v1/swagger.template.serverinfo.json | 2 +- ...agger.template.stores-payment-methods.json | 2 +- ...res-payment-methods.lightning-network.json | 8 +- ...template.stores-payment-methods.lnurl.json | 8 +- ...plate.stores-payment-methods.on-chain.json | 12 +-- ...agger.template.stores-wallet.on-chain.json | 16 ++-- .../swagger/v1/swagger.template.stores.json | 10 +-- .../swagger/v1/swagger.template.users.json | 6 +- .../swagger/v1/swagger.template.webhooks.json | 29 +++---- 18 files changed, 89 insertions(+), 160 deletions(-) diff --git a/BTCPayServer.Tests/UnitTest1.cs b/BTCPayServer.Tests/UnitTest1.cs index 69fe3471d..84891a051 100644 --- a/BTCPayServer.Tests/UnitTest1.cs +++ b/BTCPayServer.Tests/UnitTest1.cs @@ -193,7 +193,7 @@ namespace BTCPayServer.Tests JObject json = JObject.Parse(sresp); - Assert.Equal(description, json["components"]["securitySchemes"]["API Key"]["description"].Value()); + Assert.Equal(description, json["components"]["securitySchemes"]["API_Key"]["description"].Value()); } private async Task CheckDeadLinks(Regex regex, HttpClient httpClient, string file) diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json index af341e9b9..bc6986ac6 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json @@ -26,7 +26,7 @@ }, "security": [ { - "API Key": [ "unrestricted" ], + "API_Key": [ "unrestricted" ], "Basic": [] } ] @@ -53,7 +53,7 @@ }, "security": [ { - "API Key": [] + "API_Key": [] } ] }, @@ -77,7 +77,7 @@ }, "security": [ { - "API Key": [] + "API_Key": [] } ] } @@ -129,7 +129,7 @@ }, "security": [ { - "API Key": [ "unrestricted" ], + "API_Key": [ "unrestricted" ], "Basic": [] } ] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json index 5765a0dcd..8bed515ce 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json @@ -96,7 +96,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewinvoices" ], "Basic": [] @@ -158,7 +158,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreateinvoice" ], "Basic": [] @@ -214,7 +214,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewinvoices" ], "Basic": [] @@ -271,7 +271,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifyinvoices" ], "Basic": [] @@ -345,7 +345,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifyinvoices" ], "Basic": [] @@ -415,69 +415,12 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewinvoices" ], "Basic": [] } ] - }, - "delete": { - "tags": [ - "Invoices" - ], - "summary": "Archive invoice", - "description": "Archives the specified invoice.", - "operationId": "Invoices_ArchiveInvoice", - "parameters": [ - { - "name": "storeId", - "in": "path", - "required": true, - "description": "The store the invoice belongs to", - "schema": { - "type": "string" - } - }, - { - "name": "invoiceId", - "in": "path", - "required": true, - "description": "The invoice to remove", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The invoice has been archived" - }, - "400": { - "description": "A list of errors that occurred when archiving the invoice", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to archive the specified invoice" - }, - "404": { - "description": "The key is not found for this invoice" - } - }, - "security": [ - { - "API Key": [ - "btcpay.store.canmodifyinvoices" - ], - "Basic": [] - } - ] } }, "/api/v1/stores/{storeId}/invoices/{invoiceId}/status": { @@ -545,7 +488,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifyinvoices" ], "Basic": [] @@ -608,7 +551,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifyinvoices" ], "Basic": [] @@ -673,7 +616,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewinvoices" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.json index d73e70c7f..6d01f9b18 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.json @@ -74,25 +74,22 @@ } }, "securitySchemes": { - "API Key": { + "API_Key": { "type": "apiKey", "description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `unrestricted`: Unrestricted access\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canviewprofile`: View your profile\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.cancreatelightninginvoice`: Create invoices the lightning nodes associated with your stores\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n", "name": "Authorization", - "in": "header", - "scheme": "token" + "in": "header" }, "Basic": { "type": "http", "description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission", - "name": "Authorization", - "in": "header", "scheme": "Basic" } } }, "security": [ { - "API Key": [], + "API_Key": [], "Basic": [] } ], diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json index 67344a7cc..e3c41c7ca 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json @@ -40,7 +40,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -111,7 +111,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -159,7 +159,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -225,7 +225,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -274,7 +274,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -331,7 +331,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -402,7 +402,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.canuseinternallightningnode" ], "Basic": [] @@ -470,7 +470,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.cancreatelightninginvoiceinternalnode" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json index ee40f927a..dbcdce4e3 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json @@ -49,7 +49,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -129,7 +129,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -186,7 +186,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -264,7 +264,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -322,7 +322,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -389,7 +389,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -469,7 +469,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.cancreatelightninginvoice" ], "Basic": [] @@ -546,7 +546,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.cancreatelightninginvoiceinternalnode" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json index b840efcd9..d55ef7b0e 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json @@ -54,7 +54,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.canmanagenotificationsforuser", "btcpay.user.canviewnotificationsforuser" ], @@ -102,7 +102,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.canmanagenotificationsforuser", "btcpay.user.canviewnotificationsforuser" ], @@ -148,7 +148,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.canmanagenotificationsforuser" ], "Basic": [] @@ -196,7 +196,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.canmanagenotificationsforuser" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json index 5427d4dd4..606abd8ae 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json @@ -31,7 +31,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewpaymentrequests" ], "Basic": [] @@ -91,7 +91,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifypaymentrequests" ], "Basic": [] @@ -143,7 +143,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewpaymentrequests" ], "Basic": [] @@ -196,7 +196,7 @@ }, "security": [ { - "API Key": [ "btcpay.store.canmodifypaymentrequests"], + "API_Key": [ "btcpay.store.canmodifypaymentrequests"], "Basic": [] } ] @@ -261,7 +261,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifypaymentrequests" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json index 9008fa797..9bed84c40 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json @@ -41,7 +41,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] @@ -140,7 +140,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] @@ -213,7 +213,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] @@ -441,7 +441,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] @@ -463,7 +463,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] @@ -524,7 +524,7 @@ "tags": [ "Pull payments (Management)" ], "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmanagepullpayments" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json index b60d4c6a2..4d6eee6f7 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json @@ -22,7 +22,7 @@ }, "security": [ { - "API Key": [], + "API_Key": [], "Basic": [] } ] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json index 6eb962149..1f08f8677 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json @@ -45,7 +45,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] 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 5050f21ce..ea4136cd3 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 @@ -42,7 +42,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -99,7 +99,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -176,7 +176,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -233,7 +233,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] 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 a82a5d159..944d3dc74 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 @@ -42,7 +42,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -99,7 +99,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -176,7 +176,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -233,7 +233,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] 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 f6c334c79..937759e8c 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 @@ -42,7 +42,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -99,7 +99,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -176,7 +176,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -233,7 +233,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -308,7 +308,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -400,7 +400,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] 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 8fa34f208..d80ec6946 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 @@ -49,7 +49,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -116,7 +116,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -183,7 +183,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -231,7 +231,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -324,7 +324,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -397,7 +397,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -463,7 +463,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -523,7 +523,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json index d80e8904f..74e17df21 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json @@ -22,7 +22,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -74,7 +74,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -121,7 +121,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canviewstoresettings" ], "Basic": [] @@ -188,7 +188,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] @@ -235,7 +235,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.canmodifystoresettings" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json index 1ecd2586e..628724b09 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json @@ -22,7 +22,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.canviewprofile" ], "Basic": [] @@ -43,7 +43,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.user.candeleteuser" ], "Basic": [] @@ -121,7 +121,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.server.cancreateuser" ], "Basic": [] diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json index 671e9f360..3f171906d 100644 --- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json +++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json @@ -33,7 +33,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -82,7 +82,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -135,7 +135,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -183,7 +183,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -196,17 +196,6 @@ ], "summary": "Delete a webhook", "description": "Delete a webhook", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebhookDataBase" - } - } - }, - "required": true, - "x-position": 1 - }, "responses": { "200": { "description": "The webhook has been deleted" @@ -217,7 +206,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -277,7 +266,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -338,7 +327,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -400,7 +389,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": [] @@ -461,7 +450,7 @@ }, "security": [ { - "API Key": [ + "API_Key": [ "btcpay.store.webhooks.canmodifywebhooks" ], "Basic": []