Merge pull request #219 from terminusdb/docs-update

Docs update

Author: Francesca-Bit

docs/README.md

@@ -100,7 +100,7 @@ const bankerSchema = [
       "@type":"Class",
       "@id":"Person",
       "@key":{
-         "@type":"Hash",
+         "@type":"Lexical",
          "@fields":[
             "name"
          ]

docs/_sidebar.md

@@ -60,9 +60,10 @@
     - [getPrefixes](api/woqlClient.js?id=getPrefixes)
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [userOrganizations](api/woqlClient.js?id=userOrganizations)
-    - [getDiff](api/woqlClient.js?id=getDiff)
+    - [getJSONDiff](api/woqlClient.js?id=getJSONDiff)
     - [getVersionObjectDiff](api/woqlClient.js?id=getVersionObjectDiff)
     - [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
+    - [apply](api/woqlClient.js?id=apply)
     - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)
   - [using](api/woql.js?id=using)
@@ -169,6 +170,7 @@
   - [setApiToken](api/accessControl.js?id=setApiToken)
   - [setApiKey](api/accessControl.js?id=setApiKey)
   - [getAPIUrl](api/accessControl.js?id=getAPIUrl)
+  - [customHeaders](api/accessControl.js?id=customHeaders)
   - [getAllOrganizations](api/accessControl.js?id=getAllOrganizations)
   - [createOrganization](api/accessControl.js?id=createOrganization)
   - [deleteOrganization](api/accessControl.js?id=deleteOrganization)

docs/api/woqlclient.md

@@ -1132,7 +1132,7 @@ Get the patch of difference between two documents.
 | --- | --- | --- |
 | before | <code>object</code> | The current state of JSON document |
 | after | <code>object</code> | The updated state of JSON document |
-| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint. The diff api outputs the changes between the input (branches or commits), in options you can list the properties that you would like to see in the diff result in any case. |
+| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint. The diff api outputs the changes between the input, in options you can list the properties that you would like to see in the diff result in any case. |
 
 **Example**  
 ```javascript
@@ -1157,8 +1157,8 @@ Get the patch of difference between two documents.
 | --- | --- | --- |
 | dataVersion | <code>string</code> | The version from which to compare the object |
 | jsonObject | <code>object</code> | The updated state of JSON document |
-| id | <code>string</code> | The object id to be diffed |
-| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint the diff api outputs the changes between the input (branches or commits), but you can list the properties that you would like to see in the diff result in any case. |
+| id | <code>string</code> | The document id to be diffed |
+| [options] | <code>object</code> | {keep:{}} Options to send to the diff endpoint the diff api outputs the changes between the input, but you can list the properties that you would like to see in the diff result in any case. |
 
 **Example**  
 ```javascript
@@ -1244,7 +1244,7 @@ Patch the difference between two documents.
 
 **Example**  
 ```javascript
-let diffPatch = await client.getDiff(
+let diffPatch = await client.getJSONDiff(
      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
  );

lib/woqlClient.js

@@ -1469,7 +1469,7 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * @param {object} before - The current state of JSON document
  * @param {object} after - The updated state of JSON document
  * @param {object} [options] - {keep:{}} Options to send to the diff endpoint.
- * The diff api outputs the changes between the input (branches or commits),
+ * The diff api outputs the changes between the input,
  * in options you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
@@ -1505,9 +1505,9 @@ WOQLClient.prototype.getJSONDiff = function (before, after, options) {
  * Get the patch of difference between two documents.
  * @param {string} dataVersion - The version from which to compare the object
  * @param {object} jsonObject - The updated state of JSON document
- * @param {string} id - The object id to be diffed
+ * @param {string} id - The document id to be diffed
  * @param {object} [options] - {keep:{}} Options to send to the diff endpoint
- * the diff api outputs the changes between the input (branches or commits),
+ * the diff api outputs the changes between the input,
  * but you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
@@ -1640,7 +1640,7 @@ WOQLClient.prototype.apply = function (beforeVersion, afterVersion, message, mat
  * @param {object} patch - The patch object
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
- *  let diffPatch = await client.getDiff(
+ *  let diffPatch = await client.getJSONDiff(
  *      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
  *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
  *  );

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminusdb-client",
-  "version": "10.0.17",
+  "version": "10.0.18",
   "description": "TerminusDB client library",
   "main": "index.js",
   "types": "./dist/typescript/index.d.ts",