Merge pull request #253 from terminusdb/fix_typedef

Fix typedef

Author: GavinMendelGleason

docs/api/typedef.md

@@ -1,7 +1,7 @@
 
 # TypeDef
 ##### TypeDef
-Type definations
+Type definitions
 
 
 ## DocParamsGet
@@ -150,6 +150,20 @@ the DELETE document interface query parameters
 | [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
 
 
+## DbDoc
+##### DbDoc:  `  Object`
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | "Database ID" |
+| [label] | <code>string</code> | "Textual DB Name" |
+| [comment] | <code>string</code> | "Text description of DB" |
+| [organization] | <code>string</code> | "Organization to which the db belongs" |
+| [public] | <code>boolean</code> | - |
+| [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
+
+
 ## RemoteRepoDetails
 ##### RemoteRepoDetails:  `  Object`
 {remote: "origin", "remote_branch": "main", "author":

docs/api/woqlclient.md

@@ -550,16 +550,14 @@ const branch_resource = client.resource("branch")
 ```
 
 ## updateDatabase
-##### woqlClient.updateDatabase(dbId, dbDetails, [orgId]) ⇒ <code>Promise</code>
+##### woqlClient.updateDatabase(dbDoc) ⇒ <code>Promise</code>
 Update a database in TerminusDB server
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| dbId | <code>string</code> | The id of the database to be updated |
-| dbDetails | <code>typedef.DbDetails</code> | object containing details about the database to be updated |
-| [orgId] | <code>string</code> | optional organization id - if absent default local organization id is used |
+| dbDoc | <code>typedef.DbDoc</code> | object containing details about the database to be updated |
 
 **Example**  
 ```javascript

lib/typedef.js

@@ -1,6 +1,6 @@
 /**
  * @module TypeDef
- * @description Type definations
+ * @description Type definitions
  * */
 /* eslint-disable no-unused-vars */
 const Utils = require('./utils');
@@ -132,6 +132,16 @@ const { ACTIONS } = Utils.ACTIONS;
  * @property {boolean} [schema] - if set to true, a schema graph will be created
  */
 
+/**
+ * @typedef {Object} DbDoc
+ * @property {string} id - "Database ID"
+ * @property {string} [label] - "Textual DB Name"
+ * @property {string} [comment] - "Text description of DB"
+ * @property {string} [organization] - "Organization to which the db belongs"
+ * @property {boolean} [public] -
+ * @property {boolean} [schema] - if set to true, a schema graph will be created
+ */
+
 /**
  *@typedef {Object} RemoteRepoDetails - {remote: "origin", "remote_branch": "main", "author":
  "admin","message": "message"}

lib/woqlClient.js

@@ -460,10 +460,7 @@ WOQLClient.prototype.createDatabase = function (dbId, dbDetails, orgId) {
 
 /**
  * Update a database in TerminusDB server
- * @param {string} dbId - The id of the database to be updated
- * @param {typedef.DbDetails} dbDetails - object containing details about the database to be updated
- * @param {string} [orgId] - optional organization id - if absent default local organization
- * id is used
+ * @param {typedef.DbDoc} dbDoc - object containing details about the database to be updated
  * @returns {Promise} A promise that returns the call response object, or an Error if rejected.
  * @example
  * client.updateDatabase({id: "mydb", label: "My Database", comment: "Testing"})