update jsdocs

graphistry · Mar 7, 2024 · 0276ecb · 0276ecb
1 parent 8d51cda
commit 0276ecb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/projects/js-upload-api/src/Client.ts b/projects/js-upload-api/src/Client.ts
@@ -6,7 +6,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/token/generate';
 /**
  * # Client examples
  * 
- * Authenticate against a Graphistry server and manage communications with it.
+ * Authenticate against a Graphistry server using a username and password, and manage communications with it.
  * 
  * Different authentication modes may be desirable depending on the type of Graphistry server.
  * 
@@ -35,7 +35,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/token/generate';
  * @example **Authenticate against a private Graphistry server**
  * ```javascript
  * import { Client } from '@graphistry/node-api';
- * const client = new Client('my_username', 'my_password', 'http', 'my-ec2.aws.com:8080');
+ * const client = new Client('my_username', 'my_password', '', 'http', 'my-ec2.aws.com:8080');
  * ```
  * 
  * <br>
@@ -44,7 +44,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/token/generate';
  * ```javascript
  * import { Client } from '@graphistry/node-api';
  * const client = new Client(
- *  'my_username', 'my_password',
+ *  'my_username', 'my_password', '',
  *  'http', '10.20.0.1:8080',
  *  'https://www.my-site.com'
  * );
@@ -56,7 +56,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/token/generate';
  * ```javascript
  * import { Client } from '@graphistry/node-api';
  * const client = new Client(
- *  'my_username', 'my_password',
+ *  'my_username', 'my_password', '',
  *  'http', 'nginx',
  *  'https://www.my-site.com'
  * );

diff --git a/projects/js-upload-api/src/ClientPkey.ts b/projects/js-upload-api/src/ClientPkey.ts
@@ -6,7 +6,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/pkey/jwt/';
 /**
  * # Client examples
  * 
- * Authenticate against a Graphistry server and manage communications with it.
+ * Authenticate against a Graphistry server using a personal key id and secret, and manage communications with it.
  * 
  * Different authentication modes may be desirable depending on the type of Graphistry server.
  * 
@@ -19,23 +19,23 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/pkey/jwt/';
  * @example **Authenticate against Graphistry Hub for a personal account**
  * ```javascript
  * import { Client } from '@graphistry/node-api';
- * const client = new Client('my_username', 'my_password');
+ * const client = new Client('my_personal_key_id', 'my_personal_key_secret');
  * ```
  * 
  * <br>
  *  
  * @example **Authenticate against an org in Graphistry Hub**
  * ```javascript
  * import { Client } from '@graphistry/node-api';
- * const client = new Client('my_username', 'my_password', 'my_org');
+ * const client = new Client('my_personal_key_id', 'my_personal_key_secret', 'my_org');
  * ```
  * 
  * <br>
  * 
  * @example **Authenticate against a private Graphistry server**
  * ```javascript
  * import { Client } from '@graphistry/node-api';
- * const client = new Client('my_username', 'my_password', 'http', 'my-ec2.aws.com:8080');
+ * const client = new Client('my_personal_key_id', 'my_personal_key_secret', '', 'http', 'my-ec2.aws.com:8080');
  * ```
  * 
  * <br>
@@ -44,7 +44,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/pkey/jwt/';
  * ```javascript
  * import { Client } from '@graphistry/node-api';
  * const client = new Client(
- *  'my_username', 'my_password',
+ *  'my_username', 'my_password', '',
  *  'http', '10.20.0.1:8080',
  *  'https://www.my-site.com'
  * );
@@ -56,7 +56,7 @@ const AUTH_API_ENDPOINT = 'api/v2/auth/pkey/jwt/';
  * ```javascript
  * import { Client } from '@graphistry/node-api';
  * const client = new Client(
- *  'my_username', 'my_password',
+ *  'my_username', 'my_password', '',
  *  'http', 'nginx',
  *  'https://www.my-site.com'
  * );