Merge pull request #216 from terminusdb/docs-update

Docs update

Author: Francesca-Bit

README.md

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

docs/api/woqlclient.md

@@ -384,14 +384,14 @@ user has fields: [id, name, notes, author]
 **Desription**: Gets the user's organization id  
 
 ## databaseInfo
-##### woqlClient.databaseInfo([dbId]) ⇒ <code>object</code>
+##### woqlClient.databaseInfo([dbName]) ⇒ <code>object</code>
 Gets the database's details
 
-**Returns**: <code>object</code> - the database description object //getDatabaseInfo  
+**Returns**: <code>object</code> - the database description object  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [dbId] | <code>string</code> | the datbase id |
+| [dbName] | <code>string</code> | the datbase name |
 
 
 ## db

lib/woqlClient.js

@@ -208,13 +208,13 @@ WOQLClient.prototype.userOrganization = function () {
 
 /**
  * Gets the database's details
- * @param {string} [dbId] - the datbase id
- * @returns {object} the database description object //getDatabaseInfo
+ * @param {string} [dbName] - the datbase name
+ * @returns {object} the database description object
  */
-WOQLClient.prototype.databaseInfo = function (dbId) {
+WOQLClient.prototype.databaseInfo = function (dbName) {
   // const dbIdVal = dbId || this.db();
   // const orgIdVal = orgId || this.organization()
-  const database = this.databases().find((element) => element.name === dbId);
+  const database = this.databases().find((element) => element.name === dbName);
   return database || {};
 };
 
@@ -1518,8 +1518,8 @@ WOQLClient.prototype.getJSONDiff = function (before, after, options) {
  * })
  */
 WOQLClient.prototype.getVersionObjectDiff = function (dataVersion, jsonObject, id, options) {
-  if (typeof jsonObject !== 'object' || typeof dataVersion !== 'string') {
-    const errmsg = 'Parameters error - you must specify a valid jsonObject document and valid branch or commit';
+  if (typeof jsonObject !== 'object' || typeof dataVersion !== 'string' || typeof id !== 'string') {
+    const errmsg = 'Parameters error - you must specify a valid jsonObject document, a valid branch or commit and a valid id';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
@@ -1529,11 +1529,9 @@ WOQLClient.prototype.getVersionObjectDiff = function (dataVersion, jsonObject, i
   const payload = {
     after: jsonObject,
     before_data_version: dataVersion,
+    id,
     ...opt,
   };
-  if (id) {
-    payload.id = id;
-  }
   return this.dispatch(
     CONST.POST,
     this.connectionConfig.diffURL(),