DocWorks for wix-crm-backend - 4 changes detected, but 3 issue detected

changes: Service wix-crm-backend operation createContact has changed summary Service wix-crm-backend operation createContact has changed description Service wix-crm-backend operation deleteContact has changed summary Service wix-crm-backend operation deleteContact has changed description issues: Operation eq has an unknown param type * (queryContacts.js (51)) Operation ne has an unknown param type * (queryContacts.js (95)) ERROR: The @snippet tag - file 'velo-docs/examples/Users-backend-register_email.es6' not found. File: emailMember.js line: 1
wix-incubator · Jun 4, 2024 · 9a3f2a8 · 9a3f2a8
1 parent 752635a
commit 9a3f2a8
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 68 deletions.
diff --git a/wix-crm-backend/wix-crm-backend.service.json b/wix-crm-backend/wix-crm-backend.service.json
@@ -1,7 +1,7 @@
-{ 
-  "name": "wix-crm-backend",
+{ "name": "wix-crm-backend",
   "mixes": [],
-  "labels": [],
+  "labels":
+    [ "changed" ],
   "location":
     { "lineno": 1,
       "filename": "contacts.js" },
@@ -16,8 +16,7 @@
       "links": [],
       "examples": [],
       "extra":
-        {  } 
-    },
+        {  } },
   "properties":
     [ { "name": "contacts",
         "labels": [],
@@ -166,7 +165,8 @@
           {  } } ],
   "operations":
     [ { "name": "createContact",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "contactInfo",
@@ -182,15 +182,15 @@
           [ { "lineno": 42,
               "filename": "contacts.js" } ],
         "docs":
-          { "summary": "**Deprecated.**\nThis function will continue to work, but a newer version is available at\n[wix-crm-backend.contacts.createContact()](https://www.wix.com/velo/reference/wix-crm-backend/contacts/createcontact).",
+          { "summary": "**Deprecated.**\nThis function will continue to work, but a newer version is available at\n[wix-crm-backend.contacts.createContact()](/contacts/create-contact).",
             "description":
               [ "Creates a new contact or updates an existing contact.",
                 "",
                 "> #### Migration Instructions",
                 ">",
                 "> If this function is already in your code, it will continue to work.",
                 "> To stay compatible with future changes, migrate to",
-                "> [`wix-crm-backend.contacts.createContact()`](wix-crm-backend/contacts/createcontact).",
+                "> [`wix-crm-backend.contacts.createContact()`](/contacts/create-contact).",
                 ">",
                 "> To migrate to the new function:",
                 ">",
@@ -241,7 +241,8 @@
         "extra":
           {  } },
       { "name": "deleteContact",
-        "labels": [],
+        "labels":
+          [ "changed" ],
         "nameParams": [],
         "params":
           [ { "name": "contactId",
@@ -260,15 +261,15 @@
           [ { "lineno": 220,
               "filename": "contacts.js" } ],
         "docs":
-          { "summary": "**Deprecated.**\nThis function will continue to work, but a newer version is available at\n[wix-crm-backend.contacts.deleteContact()](https://www.wix.com/velo/reference/wix-crm-backend/contacts/deletecontact).",
+          { "summary": "**Deprecated.**\nThis function will continue to work, but a newer version is available at\n[wix-crm-backend.contacts.deleteContact()](/contacts/delete-contact).",
             "description":
               [ "Deletes an existing contact.",
                 "",
                 "> #### Migration Instructions",
                 ">",
                 "> If this function is already in your code, it will continue to work.",
                 "> To stay compatible with future changes, migrate to",
-                "> [`wix-crm-backend.contacts.deleteContact()`](wix-crm-backend/contacts/deletecontact).",
+                "> [`wix-crm-backend.contacts.deleteContact()`](/contacts/delete-contact).",
                 ">",
                 "> To migrate to the new function:",
                 ">",
@@ -665,4 +666,4 @@
   "relatedContent":
     [ { "icon": "example",
         "text": "Members Area",
-        "url": "https://www.wix.com/velo/example/members-area" } ] }
+        "url": "https://www.wix.com/velo/example/members-area" } ] }
diff --git a/wix-crm-backend/wix-crm-backend/Contacts.service.json b/wix-crm-backend/wix-crm-backend/Contacts.service.json
@@ -4030,11 +4030,11 @@
               "optional": true },
             { "name": "picture",
               "type": "wix-crm-backend.Contacts.Picture",
-              "doc": "**Deprecated.** Use `profilePicture` instead.", "deprecation": {
-        "replacedBy": "some replacement",
-        "targetRemovalDate": "11/11/21",
-        "message": "some instructions"
-      } },
+              "doc": "**Deprecated.** Use `profilePicture` instead.",
+              "deprecation":
+                { "replacedBy": "some replacement",
+                  "targetRemovalDate": "11/11/21",
+                  "message": "some instructions" } },
             { "name": "emails",
               "type":
                 { "name": "Array",
@@ -4321,19 +4321,19 @@
           [ { "name": "image",
               "type": "string",
               "doc": "**Deprecated.** Use `profilePicture` instead.",
-              "optional": true, "deprecation": {
-        "replacedBy": "some replacement",
-        "targetRemovalDate": "11/11/21",
-        "message": "some instructions"
-      } },
+              "optional": true,
+              "deprecation":
+                { "replacedBy": "some replacement",
+                  "targetRemovalDate": "11/11/21",
+                  "message": "some instructions" } },
             { "name": "imageProvider",
               "type": "string",
               "doc": "**Deprecated.**",
-              "optional": true, "deprecation": {
-        "replacedBy": "some replacement",
-        "targetRemovalDate": "11/11/21",
-        "message": "some instructions"
-      } } ],
+              "optional": true,
+              "deprecation":
+                { "replacedBy": "some replacement",
+                  "targetRemovalDate": "11/11/21",
+                  "message": "some instructions" } } ],
         "extra":
           {  },
         "labels": [] },
@@ -4467,4 +4467,4 @@
           {  },
         "labels": [] } ],
   "extra":
-    {  } }
+    {  } }
diff --git a/wix-crm-backend/wix-crm-backend/Workflows.service.json b/wix-crm-backend/wix-crm-backend/Workflows.service.json
@@ -1,8 +1,7 @@
 { "name": "Workflows",
   "memberOf": "wix-crm-backend",
   "mixes": [],
-  "labels":
-    [ "changed" ],
+  "labels": [],
   "location":
     { "lineno": 1,
       "filename": "workflows.js" },
@@ -64,8 +63,7 @@
   "properties": [],
   "operations":
     [ { "name": "archiveCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -109,8 +107,7 @@
         "extra":
           {  } },
       { "name": "createCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -183,8 +180,7 @@
         "extra":
           {  } },
       { "name": "createPhase",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -246,8 +242,7 @@
         "extra":
           {  } },
       { "name": "createWorkflow",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowInfo",
@@ -294,8 +289,7 @@
         "extra":
           {  } },
       { "name": "deleteCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -339,8 +333,7 @@
         "extra":
           {  } },
       { "name": "deletePhase",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "phaseId",
@@ -384,8 +377,7 @@
         "extra":
           {  } },
       { "name": "deleteWorkflow",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -429,8 +421,7 @@
         "extra":
           {  } },
       { "name": "getCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -483,8 +474,7 @@
         "extra":
           {  } },
       { "name": "getPhaseInfo",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "phaseId",
@@ -532,8 +522,7 @@
         "extra":
           {  } },
       { "name": "getWorkflowInfo",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -585,8 +574,7 @@
         "extra":
           {  } },
       { "name": "listCards",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -678,8 +666,7 @@
         "extra":
           {  } },
       { "name": "listPhasesInfo",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",
@@ -760,8 +747,7 @@
         "extra":
           {  } },
       { "name": "listWorkflowsInfo",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "options",
@@ -840,8 +826,7 @@
         "extra":
           {  } },
       { "name": "moveCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -897,8 +882,7 @@
         "extra":
           {  } },
       { "name": "movePhase",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "phaseId",
@@ -955,8 +939,7 @@
         "extra":
           {  } },
       { "name": "restoreCard",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -1015,8 +998,7 @@
         "extra":
           {  } },
       { "name": "updateCardFields",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "cardId",
@@ -1071,8 +1053,7 @@
         "extra":
           {  } },
       { "name": "updatePhaseFields",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "phaseId",
@@ -1127,8 +1108,7 @@
         "extra":
           {  } },
       { "name": "updateWorkflowFields",
-        "labels":
-          [ "changed" ],
+        "labels": [],
         "nameParams": [],
         "params":
           [ { "name": "workflowId",