From 49be370e51c92139bb702e009fd9a730ea903720 Mon Sep 17 00:00:00 2001
From: "nicolas.dorier" <nicolas.dorier@gmail.com>
Date: Fri, 27 Mar 2020 12:43:06 +0900
Subject: [PATCH] Rename GreenField auth to APIKey auth in swagger doc

---
 .../wwwroot/swagger/v1/swagger.template.json    | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.json
index 7d167d9d9..0e11854ca 100644
--- a/BTCPayServer/wwwroot/swagger/v1/swagger.template.json
+++ b/BTCPayServer/wwwroot/swagger/v1/swagger.template.json
@@ -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": [