documentation - document interface, add raw_json parameter

Author: Francesca-Bit

lib/accessControl.js

@@ -126,6 +126,7 @@ AccessControl.prototype.getAPIUrl = function (cloudAPIUrl) {
   return `${cloudAPIUrl}api`;
 };
 
+
 AccessControl.prototype.dispatch = function (requestUrl, action, payload) {
   if (!requestUrl) {
     return Promise.reject(

lib/typedef.js

@@ -27,6 +27,9 @@ const { ACTIONS } = require('./utils');
 
 /**
  *@typedef {Object} DocParamsPost - the POST document interface query parameters
+ *@property {boolean} [raw_json] - default is false, If true, the input documents
+ are treated as raw JSON, inserted as type sys:JSONDocument and are not subject
+ to schema restrictions.
  *@property {GraphType} [graph_type] - default is instance  instance|schema Used to switch between
  getting documents from the instance or the schema graph.
  *@property {boolean} [full_replace] - default is false, If true, all existing documents are deleted
@@ -36,6 +39,9 @@ const { ACTIONS } = require('./utils');
 
 /**
  *@typedef {Object} DocParamsPut - the PUT document interface query parameters
+ *@property {boolean} [raw_json] - default is false, If true, the input documents
+ are treated as raw JSON, inserted as type sys:JSONDocument and are not subject
+ to schema restrictions.
  *@property {GraphType} [graph_type] - default is instance, instance|schema Used to switch between
  getting documents from the instance or the schema graph.
  */

lib/woqlClient.js

@@ -942,7 +942,7 @@ WOQLClient.prototype.updateDatabase = function (dbDoc) {
 /**
  * to add a new document or a list of new documents into the instance or the schema graph.
  * @param {object} json
- * @param {typedef.DocParamsPost} [params] - the post parameters
+ * @param {typedef.DocParamsPost} [params] - the post parameters {@link #typedef.DocParamsPost}
  * @param {string} [dbId] - the dbid
  * @param {message} [string] - the insert commit message
  * @param {string} [lastDataVersion] the last data version tracking id.
@@ -1159,7 +1159,7 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
 /**
  *
  * @param {object} json
- * @param {typedef.DocParamsPut} [params] - the Put parameters
+ * @param {typedef.DocParamsPut} [params] - the Put parameters {@link #typedef.DocParamsPut}
  * @param {*} [dbId] - the database id
  * @param {*} [message] - the update commit message
  * @param {string} [lastDataVersion] the last data version tracking id.