review doc

Author: Francesca-Bit

lib/typedef.js

@@ -95,7 +95,6 @@
  * @property {RepoType | string} [repo] - set cursor to this repo
  * @property {string} [branch] - set branch to this id
  * @property {string} [ref]    - set commit ref
- * @property {string} [jwt] - jwt token, can use that token to get access to the associated resources in the cloud
  * @property {string} [default_branch_id] - set the default branch id
  */
 

lib/woqlClient.js

@@ -21,22 +21,25 @@ const { default: axios } = require('axios')
  * @example
  * //to connect with your local terminusDB
  * const client = new TerminusClient.WOQLClient(SERVER_URL,{user:"admin",key:"myKey"})
- * await client.connect()
- * client.db("test")
- * client.checkout("dev")
- * const schema = await client.getSchema()
+ * async function getSchema() {
+ *      await client.connect()
+ *      client.db("test")
+ *      client.checkout("dev")
+ *      const schema = await client.getSchema()
+ * }
  * //The client has an internal state which defines what
  * //organization / database / repository / branch / ref it is currently attached to
  * 
  * //to connect with your TerminusDB Cloud Instance
  * const client = new TerminusClient.WOQLClient(SERVER_URL,{user:"myemail@something.com",
- *                                                         jwt:"MY_ACCESS_TOKEN",
  *                                                         organization:'mycloudTeam'})
- * await client.connect()
- * client.db("test")
- * client.checkout("dev")
- * const schema = await client.getSchema()
- * 
+ * client.setApiKey(MY_ACCESS_TOKEN)
+ * async function getSchema() {
+ *      await client.connect()
+ *      client.db("test")
+ *      client.checkout("dev")
+ *      const schema = await client.getSchema()
+ * }
  */
 
 function WOQLClient(serverUrl, params) {
@@ -47,7 +50,7 @@ function WOQLClient(serverUrl, params) {
 
 
 /**
- *  
+ * set the api key to access the cloud resources 
  * @param {string} accessToken 
  */
 WOQLClient.prototype.setApiKey = function (accessToken){
@@ -65,15 +68,6 @@ WOQLClient.prototype.customHeaders = function(customHeaders) {
     else return this._customHeaders
 }
 
-/**
- * set the api access token to connect to TerminusX Cloud
- * @param {string} accessToken 
- */
-
-WOQLClient.prototype.setApiKey = function(accessToken) {
-    this.localAuth({type: "jwt", key: accessToken} )
-}
-
 WOQLClient.CONST = CONST
 
 /**