TechDocs: Use @deprecated for techdocs config urls

2021-02-02 23:16:09 +01:00
parent 436ca3f625
commit 93a53ea093
2 changed files with 21 additions and 18 deletions
@@ -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;
  };
 }