From 93a53ea093b809d1e8ac4d721e79ff41017fa198 Mon Sep 17 00:00:00 2001
From: Himanshu Mishra <himanshu@orkohunter.net>
Date: Tue, 2 Feb 2021 23:16:09 +0100
Subject: [PATCH] TechDocs: Use @deprecated for techdocs config urls

---
 plugins/techdocs-backend/config.d.ts | 15 ++++++++-------
 plugins/techdocs/config.d.ts         | 24 +++++++++++++-----------
 2 files changed, 21 insertions(+), 18 deletions(-)

diff --git a/plugins/techdocs-backend/config.d.ts b/plugins/techdocs-backend/config.d.ts
index 1e4298688e..7ec1162d03 100644
--- a/plugins/techdocs-backend/config.d.ts
+++ b/plugins/techdocs-backend/config.d.ts
@@ -14,17 +14,12 @@
  * limitations under the License.
  */
 /**
- * techdocs schema below is an abstract of what's used within techdocs-backend and for its visibility
- * to view the complete techdoc schema please refer: plugins/techdocs/config.d.ts
+ * TechDocs schema below is an abstract of what's used within techdocs-backend and for its visibility
+ * to view the complete TechDocs schema please refer: plugins/techdocs/config.d.ts
  * */
 export interface Config {
   /** Configuration options for the techdocs-backend plugin */
   techdocs: {
-    /**
-     * attr: 'storageUrl' - accepts a string value
-     * e.g. storageUrl: http://localhost:7000/api/techdocs/static/docs
-     */
-    storageUrl?: string;
     /**
      * documentation building process depends on the builder attr
      * attr: 'builder' - accepts a string value
@@ -45,5 +40,11 @@ export interface Config {
        */
       type: 'local' | 'googleGcs' | 'awsS3';
     };
+    /**
+     * attr: 'storageUrl' - accepts a string value
+     * e.g. storageUrl: http://localhost:7000/api/techdocs/static/docs
+     * @deprecated
+     */
+    storageUrl?: string;
   };
 }
diff --git a/plugins/techdocs/config.d.ts b/plugins/techdocs/config.d.ts
index ef4e026911..1104d75237 100644
--- a/plugins/techdocs/config.d.ts
+++ b/plugins/techdocs/config.d.ts
@@ -17,17 +17,6 @@
 export interface Config {
   /** Configuration options for the techdocs plugin */
   techdocs: {
-    /**
-     * attr: 'requestUrl' - accepts a string value
-     * e.g. requestUrl: http://localhost:7000/api/techdocs
-     * @visibility frontend
-     */
-    requestUrl?: string;
-    /**
-     * attr: 'storageUrl' - accepts a string value
-     * e.g. storageUrl: http://localhost:7000/api/techdocs/static/docs
-     */
-    storageUrl?: string;
     /**
      * documentation building process depends on the builder attr
      * attr: 'builder' - accepts a string value
@@ -184,5 +173,18 @@ export interface Config {
             credentials?: string;
           };
         };
+    /**
+     * attr: 'requestUrl' - accepts a string value
+     * e.g. requestUrl: http://localhost:7000/api/techdocs
+     * @visibility frontend
+     * @deprecated
+     */
+    requestUrl?: string;
+    /**
+     * attr: 'storageUrl' - accepts a string value
+     * e.g. storageUrl: http://localhost:7000/api/techdocs/static/docs
+     * @deprecated
+     */
+    storageUrl?: string;
   };
 }