Merge pull request #214 from terminusdb/docs-update

documentation - document interface, add raw_json parameter

Author: Francesca-Bit

docs/api/typedef.md

@@ -32,6 +32,7 @@ the POST document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
+| [raw_json] | <code>boolean</code> | 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. |
 | [graph_type] | <code>GraphType</code> | default is instance  instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 | [full_replace] | <code>boolean</code> | default is false, If true, all existing documents are deleted  before inserting the posted documents. This allows the full replacement of the contents of a  database. This is especially useful for replacing the schema. |
 
@@ -44,6 +45,7 @@ the PUT document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
+| [raw_json] | <code>boolean</code> | 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. |
 | [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 
 

docs/api/woqlclient.md

@@ -699,7 +699,7 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
 | Param | Type | Description |
 | --- | --- | --- |
 | json | <code>object</code> |  |
-| [params] | <code>typedef.DocParamsPost</code> | the post parameters |
+| [params] | <code>typedef.DocParamsPost</code> | the post parameters [#typedef.DocParamsPost](#typedef.DocParamsPost) |
 | [dbId] | <code>string</code> | the dbid |
 | [string] | <code>message</code> | the insert commit message |
 | [lastDataVersion] | <code>string</code> | the last data version tracking id. |
@@ -866,7 +866,7 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
 | Param | Type | Description |
 | --- | --- | --- |
 | json | <code>object</code> |  |
-| [params] | <code>typedef.DocParamsPut</code> | the Put parameters |
+| [params] | <code>typedef.DocParamsPut</code> | the Put parameters [#typedef.DocParamsPut](#typedef.DocParamsPut) |
 | [dbId] | <code>\*</code> | the database id |
 | [message] | <code>\*</code> | the update commit message |
 | [lastDataVersion] | <code>string</code> | the last data version tracking id. |

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.