📝 update documentation links #3234

open-wa · Aug 7, 2024 · 3ebc0f8 · 3ebc0f8
1 parent 32fafcd
commit 3ebc0f8
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 9 deletions.
diff --git a/docs-v3/docs/api/enums/structures_preProcessors.PREPROCESSORS.md b/docs-v3/docs/api/enums/structures_preProcessors.PREPROCESSORS.md
@@ -54,4 +54,4 @@ ___
 
 Uploads file to a cloud storage provider (GCP/AWS for now).
 
-If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html#cloudUploadOptions) in the config.
+If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions) in the config.
diff --git a/docs/docs/configuration/config-object.md b/docs/docs/configuration/config-object.md
@@ -5,7 +5,7 @@ description:
 sidebar_position: 0
 ---
 
-# Configration
+# Configuration
 
 There are quite a few ways you can customize your session.
 
@@ -32,7 +32,6 @@ const launchConfig = {
     sessionId: 'hr'
 };
 
-
 function start(client) {
   client.onMessage(async message => {
     if (message.body === 'Hi') {

diff --git a/patches.json b/patches.json
diff --git a/src/api/model/config.ts b/src/api/model/config.ts
@@ -212,6 +212,7 @@ export interface ProxyServerCredentials {
 
 export interface ConfigObject {
     /**
+     * @deprecated
      * The authentication object (as a JSON object or a base64 encoded string) that is required to migrate a session from one instance to another or to just restart an existing instance.
      * This sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event.
      * 

diff --git a/src/build/build-postman.ts b/src/build/build-postman.ts
@@ -157,8 +157,8 @@ const postmanRequestGeneratorGenerator = setup => method => {
             }
         },
         url,
-        "documentationUrl": `https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${method.name}`,
-        "description": `${method.text}\n[External Documentation](https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${method.name})`
+        "documentationUrl": `https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${(method.name || "").toLowerCase()}`,
+        "description": `${method.text}\n[External Documentation](https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${(method.name || "").toLowerCase()})`
     };
     if (!(setup === null || setup === void 0 ? void 0 : setup.key))
         delete request.auth;

diff --git a/src/cli/collections.ts b/src/cli/collections.ts
@@ -20,7 +20,7 @@ export const generateCollections: any = async (config: { [x: string]: any; sessi
             "description": "All methods from the Client",
             "externalDocs": {
                 "description": "Find out more",
-                "url": "https://docs.openwa.dev/classes/api_Client.Client.html"
+                "url": "https://docs.openwa.dev/docs/reference/api/Client/classes/Client"
             }
         },
         {

diff --git a/src/cli/setup.ts b/src/cli/setup.ts
@@ -85,7 +85,7 @@ export const helptext = commandLineUsage([{
     ]
 },
 {
-    content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/interfaces/api_model_config.configobject}`
+    content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject}`
 },
 {
     content: 'Project home: {underline https://github.com/open-wa/wa-automate-nodejs}'

diff --git a/src/structures/preProcessors.ts b/src/structures/preProcessors.ts
@@ -214,7 +214,7 @@ export enum PREPROCESSORS {
    * 
    * Uploads file to a cloud storage provider (GCP/AWS for now).
    * 
-   * If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html#cloudUploadOptions) in the config.
+   * If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions) in the config.
    * 
    */
   UPLOAD_CLOUD = "UPLOAD_CLOUD",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -54,4 +54,4 @@ ___

		Uploads file to a cloud storage provider (GCP/AWS for now).

		If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html#cloudUploadOptions) in the config.
		If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions) in the config.
-Original file line number
+Diff line change
@@ Expand Up / @@ -85,7 +85,7 @@ export const helptext = commandLineUsage([{ @@
         ]
     },
     {
-        content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/interfaces/api_model_config.configobject}`
+        content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject}`
     },
     {
         content: 'Project home: {underline https://github.com/open-wa/wa-automate-nodejs}'
@@ Expand Down @@