mirrors/btcpayserver
1
0
Fork 0
mirror of https://github.com/btcpayserver/btcpayserver.git synced 2024-11-19 18:11:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix OpenAPI 3.0 validation errors and warnings (#4235)

Browse Source
This commit is contained in:
d11n 2022-10-25 13:37:36 +02:00 committed by GitHub
parent 2e150f4bf4
commit f4af4ec4dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 445 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json
View File

@ -27,7 +27,7 @@
},
"security": [
{
"API_Key": [ "unrestricted" ],
"API_Key": ["unrestricted"],
"Basic": []
}
]
@ -51,6 +51,16 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -76,6 +86,16 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -103,6 +123,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"requestBody": {
@ -170,7 +210,8 @@
},
"tags": [
{
"name": "API Keys"
"name": "API Keys",
"description": "API Key operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.apps.json
View File

@ -365,7 +365,8 @@
},
"tags": [
{
"name": "Apps"
"name": "Apps",
"description": "App operations"
}
]
}

12
BTCPayServer/wwwroot/swagger/v1/swagger.template.authorization.json
View File

@ -82,12 +82,17 @@
"200": {
"description": "A HTML form that a user can use to confirm permissions to grant",
"content": {
"text/html": {
}
"text/html": {}
}
},
"307": {
"description": "Makes browser do an HTTP POST request to the specified url in `redirect` with a JSON body consisting of `apiKey` (the api key created or matched), `permissions` (the permissions the user consented to), and `userId` (the id of the user that consented) upon consent"
},
"401": {
"description": "Missing authorization",
"content": {
"text/html": {}
}
}
},
"security": []
@ -96,7 +101,8 @@
},
"tags": [
{
"name": "Authorization"
"name": "Authorization",
"description": "Authorization operations"
}
]
}

5
BTCPayServer/wwwroot/swagger/v1/swagger.template.custodians.json
View File

@ -10,7 +10,7 @@
"operationId": "Custodians_GetSupportedCustodians",
"responses": {
"200": {
"description": "list of supported custodians",
"description": "List of supported custodians",
"content": {
"application/json": {
"schema": {
@ -1125,7 +1125,8 @@
},
"tags": [
{
"name": "Custodians"
"name": "Custodians",
"description": "Custodian operations"
}
]
}

13
BTCPayServer/wwwroot/swagger/v1/swagger.template.health.json
View File

@ -18,6 +18,16 @@
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
@ -40,7 +50,8 @@
},
"tags": [
{
"name": "Health"
"name": "Health",
"description": "Health operations"
}
]
}

25
BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json
View File

@ -90,7 +90,7 @@
"operationId": "Invoices_GetInvoices",
"responses": {
"200": {
"description": "list of invoices",
"description": "List of invoices",
"content": {
"application/json": {
"schema": {
@ -98,6 +98,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -1243,7 +1263,8 @@
},
"tags": [
{
"name": "Invoices"
"name": "Invoices",
"description": "Invoice operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.json
View File

@ -115,6 +115,5 @@
"API_Key": [],
"Basic": []
}
],
"tags": []
]
}

27
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json
View File

@ -446,7 +446,7 @@
]
}
},
"/api/v1/server/lightning/{cryptoCode}/invoices/pay": {
"post": {
"tags": [
@ -525,7 +525,7 @@
]
}
},
"/api/v1/server/lightning/{cryptoCode}/invoices": {
"get": {
"tags": [
@ -582,8 +582,28 @@
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"503": {
"description": "Unable to access the lightning node"
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -665,7 +685,8 @@
},
"tags": [
{
"name": "Lightning (Internal Node)"
"name": "Lightning (Internal Node)",
"description": "Lightning (Internal Node) operations"
}
]
}

25
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json
View File

@ -454,7 +454,7 @@
]
}
},
"/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id}": {
"get": {
"tags": [
@ -673,8 +673,28 @@
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"503": {
"description": "Unable to access the lightning node"
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -765,7 +785,8 @@
},
"tags": [
{
"name": "Lightning (Store)"
"name": "Lightning (Store)",
"description": "Lightning (Store) operations"
}
]
}

33
BTCPayServer/wwwroot/swagger/v1/swagger.template.misc.json
View File

@ -32,6 +32,16 @@
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
@ -73,6 +83,16 @@
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
@ -111,6 +131,16 @@
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": []
@ -160,7 +190,8 @@
},
"tags": [
{
"name": "Miscelleneous"
"name": "Miscelleneous",
"description": "Miscelleneous operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json
View File

@ -251,7 +251,8 @@
},
"tags": [
{
"name": "Notifications (Current User)"
"name": "Notifications (Current User)",
"description": "Notifications operations"
}
]
}

15
BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json
View File

@ -19,7 +19,7 @@
"operationId": "PaymentRequests_GetPaymentRequests",
"responses": {
"200": {
"description": "list of payment requests",
"description": "List of payment requests",
"content": {
"application/json": {
"schema": {
@ -27,6 +27,16 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -374,7 +384,8 @@
},
"tags": [
{
"name": "Payment Requests"
"name": "Payment Requests",
"description": "Payment Requests operations"
}
]
}

6
BTCPayServer/wwwroot/swagger/v1/swagger.template.payout-processors.json
View File

@ -648,10 +648,12 @@
},
"tags": [
{
"name": "Stores (Payout Processors)"
"name": "Stores (Payout Processors)",
"description": "Stores (Payout Processors) operations"
},
{
"name": "Payout Processors"
"name": "Payout Processors",
"description": "Payout Processors operations"
}
]
}

9
BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json
View File

@ -879,13 +879,16 @@
},
"tags": [
{
"name": "Pull payments (Management)"
"name": "Pull payments (Management)",
"description": "Pull payments (Management) operations"
},
{
"name": "Pull payments (Public)"
"name": "Pull payments (Public)",
"description": "Pull payments (Public) operations"
},
{
"name": "Pull payments payout (Public)"
"name": "Pull payments payout (Public)",
"description": "Pull payments payout (Public) operations"
}
]
}

23
BTCPayServer/wwwroot/swagger/v1/swagger.template.serverinfo.json
View File

@ -18,6 +18,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -116,7 +136,8 @@
},
"tags": [
{
"name": "ServerInfo"
"name": "ServerInfo",
"description": "Server Info operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-email.json
View File

@ -222,7 +222,8 @@
},
"tags": [
{
"name": "Stores (Email)"
"name": "Stores (Email)",
"description": "Store Emails operations"
}
]
}

23
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json
View File

@ -41,6 +41,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -92,7 +112,8 @@
},
"tags": [
{
"name": "Store Payment Methods"
"name": "Store Payment Methods",
"description": "Store Payment Methods operations"
}
]
}

25
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lightning-network.json
View File

@ -30,7 +30,7 @@
"operationId": "StoreLightningNetworkPaymentMethods_GetLightningNetworkPaymentMethods",
"responses": {
"200": {
"description": "list of payment methods",
"description": "List of payment methods",
"content": {
"application/json": {
"schema": {
@ -38,6 +38,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -311,7 +331,8 @@
},
"tags": [
{
"name": "Store Payment Methods (Lightning Network)"
"name": "Store Payment Methods (Lightning Network)",
"description": "Store Payment Methods (Lightning Network) operations"
}
]
}

51
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.lnurl.json
View File

@ -38,6 +38,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -90,11 +110,35 @@
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "If you are authenticated but forbidden to view the specified store"
"description": "If you are authenticated but forbidden to view the specified store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "The key is not found for this store/payment method"
"description": "The key is not found for this store/payment method",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -293,7 +337,8 @@
},
"tags": [
{
"name": "Store Payment Methods (LNURL Pay)"
"name": "Store Payment Methods (LNURL Pay)",
"description": "Store Payment Methods (LNURL Pay) operations"
}
]
}

25
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.on-chain.json
View File

@ -30,7 +30,7 @@
],
"responses": {
"200": {
"description": "list of payment methods",
"description": "List of payment methods",
"content": {
"application/json": {
"schema": {
@ -38,6 +38,26 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -697,7 +717,8 @@
},
"tags": [
{
"name": "Store Payment Methods (On Chain)"
"name": "Store Payment Methods (On Chain)",
"description": "Store Payment Methods (On Chain) operations"
}
]
}

7
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-rates-config.json
View File

@ -144,6 +144,7 @@
],
"summary": "Preview rate configuration results",
"description": "Preview rate configuration results before you set it on the store",
"operationId": "Stores_PreviewStoreRateConfiguration",
"requestBody": {
"x-name": "request",
"content": {
@ -186,7 +187,7 @@
},
"security": [
{
"API Key": [
"API_Key": [
"btcpay.store.canmodifystoresettings"
],
"Basic": []
@ -245,8 +246,8 @@
},
"tags": [
{
"name": "Stores (Rates Config)"
"name": "Stores (Rates Config)",
"description": "Store Rates Config operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-users.json
View File

@ -215,7 +215,8 @@
},
"tags": [
{
"name": "Stores (Users)"
"name": "Stores (Users)",
"description": "Store Users operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json
View File

@ -920,7 +920,8 @@
},
"tags": [
{
"name": "Store Wallet (On Chain)"
"name": "Store Wallet (On Chain)",
"description": "Store Wallet (On Chain) operations"
}
]
}

13
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json
View File

@ -18,6 +18,16 @@
}
}
}
},
"401": {
"description": "Missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
@ -424,7 +434,8 @@
},
"tags": [
{
"name": "Stores"
"name": "Stores",
"description": "Store operations"
}
]
}

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json
View File

@ -359,7 +359,8 @@
},
"tags": [
{
"name": "Users"
"name": "Users",
"description": "User operations"
}
]
}

94
BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json
View File

@ -827,7 +827,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoiceExpired": {
@ -859,7 +870,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoiceReceivedPayment": {
@ -891,7 +913,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoicePaymentSettled": {
@ -923,7 +956,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoiceProcessing": {
@ -955,7 +999,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoiceInvalid": {
@ -987,7 +1042,18 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"InvoiceSettled": {
@ -1019,13 +1085,25 @@
}
}
},
"responses": {}
"responses": {
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"tags": [
{
"name": "Webhooks"
"name": "Webhooks",
"description": "Webhook operations"
}
]
}