aljaz/btcpayserver
1
0
Fork 0
mirror of https://github.com/aljazceru/btcpayserver.git synced 2026-02-03 05:14:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename GreenField auth to APIKey auth in swagger doc

Browse Source
This commit is contained in:
nicolas.dorier
2020-03-27 12:43:06 +09:00
parent fbe89f1784
commit 49be370e51
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -22,7 +22,7 @@
"parameters": [
{
"name": "permissions",
"description": "The permissions to request. (See GreenField Authentication)",
"description": "The permissions to request. (See API Key authentication)",
"in": "query",
"style": "form",
"explode": true,
@@ -102,7 +102,7 @@
},
"security": [
{
"GreenField Authentication": [
"API Key": [
"btcpay.user.canviewprofile"
],
"Basic": []
@@ -180,7 +180,7 @@
},
"security": [
{
"GreenField Authentication": [
"API Key": [
"btcpay.server.cancreateuser"
],
"Basic": []
@@ -209,7 +209,7 @@
},
"security": [
{
"GreenField Authentication": []
"API Key": []
}
]
},
@@ -233,7 +233,7 @@
},
"security": [
{
"GreenField Authentication": [ "unrestricted" ]
"API Key": [ "unrestricted" ]
}
]
}
@@ -326,7 +326,7 @@
"properties": {
"apiKey": {
"type": "string",
"description": "The API Key to use for Greenfield Authentication",
"description": "The API Key to use for API Key Authentication",
"nullable": false
},
"label": {
@@ -346,7 +346,7 @@
}
},
"securitySchemes": {
"GreenField Authentication": {
"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 applies to the context of the user creating the API Key:\n * `unrestricted`: Allow unrestricted access to your account.\n * `btcpay.server.canmodifyserversettings`: Allow total control on the server settings. (only if user is administrator)\n * `btcpay.server.cancreateuser`: Allow the creation of new users on this server. (only if user is an administrator)\n * `btcpay.user.canviewprofile`: Allow view access to your user profile.\n * `btcpay.user.canmodifyprofile`: Allow view and modification access to your user profile.\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 * `btcpay.store.canviewstoresettings`: Allow view access to the stores settings. \n * `btcpay.store.canmodifystoresettings`: Allow view and modification access to the stores settings.\n * `btcpay.store.cancreateinvoice`: Allow invoice creation of the store.\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.\n",
"name": "Authorization",
@@ -364,7 +364,8 @@
},
"security": [
{
"GreenField Authentication": []
"API Key": [],
"Basic": []
}
],
"tags": [