review documentation

Author: Francesca-Bit

lib/woqlClient.js

@@ -1473,7 +1473,7 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * but you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
- * client.getDiff(
+ * client.getJSONDiff(
  *      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
  *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
  *  ).then(diffResult=>{
@@ -1503,31 +1503,32 @@ WOQLClient.prototype.getJSONDiff = function (before, after, options) {
 
 /**
  * Get the patch of difference between two documents.
+ * @param {string} dataVersion - The version from which to compare the object
+ * @param {object} jsonObject - The updated state of JSON document
  * @param {string} id - The object id to be diffed
- * @param {string} before - The version from which to compare the object
- * @param {object} afterVersion - The updated state of JSON document
  * @param {object} [options] - {keep:{}} Options to send to the diff endpoint
  * the diff api outputs the changes between the input (branches or commits),
  * but you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  * const jsonObj =  { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
- * client.getVersionObjectDiff(jsonObj, "a73ssscfx0kke7z76083cgswszdxy6l").then(diffResp=>{
+ * client.getVersionObjectDiff("main",jsonObj
+ *      "Person/Jane").then(diffResp=>{
  *    console.log(diffResp)
  * })
  */
-WOQLClient.prototype.getVersionObjectDiff = function (jsonObject, dataVersion, id, options) {
-  if (typeof id !== 'string' || typeof beforeVersion !== 'string' || typeof after !== 'object') {
-    const errmsg = '"id", "beforeVersion" or "after" parameter error - you must specify a valid after json document and valid id and version';
+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';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
     );
   }
   const opt = options || {};
   const payload = {
-    before: jsonObject,
-    after_data_version: dataVersion,
+    after: jsonObject,
+    before_data_version: dataVersion,
     ...opt,
   };
   if (id) {