typedef: add dbDoc object

Author: rrooij

lib/typedef.js

@@ -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"})