review

algolia · Oct 4, 2023 · e7d0152 · e7d0152
1 parent a1c15fa
commit e7d0152
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 16 deletions.
diff --git a/specs/insights/common/schemas/AddedToCartObjectIDs.yml b/specs/insights/common/schemas/AddedToCartObjectIDs.yml
@@ -1,13 +1,16 @@
 type: object
 title: Added to cart object IDs
-description: Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use `addedToCartObjectIDs`.
+description: |
+  Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.
+
+  To track add-to-cart events related to Algolia requests, use the "Added to cart object IDs after search" event.
 additionalProperties: false
 properties:
   eventName:
     $ref: './EventAttributes.yml#/eventName'
   eventType:
     $ref: './ConversionEvent.yml'
-  eventSubType:
+  eventSubtype:
     $ref: './AddToCartEvent.yml'
   index:
     $ref: './EventAttributes.yml#/index'
@@ -24,7 +27,7 @@ properties:
 required:
   - eventName
   - eventType
-  - eventSubType
+  - eventSubtype
   - index
   - objectIDs
   - userToken
diff --git a/specs/insights/common/schemas/AddedToCartObjectIDsAfterSearch.yml b/specs/insights/common/schemas/AddedToCartObjectIDsAfterSearch.yml
@@ -2,14 +2,14 @@ type: object
 title: Added to cart object IDs after search
 description: |
   Use this event to track when users add items to their shopping cart after a previous Algolia request.
-  If you use Algolia to build your category pages, you'll also use the `addedToCartObjectIDsAfterSearch` event.
+  If you're building your category pages with Algolia, you'll also use this event.
 additionalProperties: false
 properties:
   eventName:
     $ref: './EventAttributes.yml#/eventName'
   eventType:
     $ref: './ConversionEvent.yml'
-  eventSubType:
+  eventSubtype:
     $ref: './AddToCartEvent.yml'
   index:
     $ref: './EventAttributes.yml#/index'
@@ -28,7 +28,7 @@ properties:
 required:
   - eventName
   - eventType
-  - eventSubType
+  - eventSubtype
   - queryID
   - index
   - objectIDs

diff --git a/specs/insights/common/schemas/EventAttributes.yml b/specs/insights/common/schemas/EventAttributes.yml
@@ -115,7 +115,7 @@ objectDataList:
   description: |
     Extra information about the records involved in the event—for example, to add price and quantities of purchased products.
 
-    If provided, must be the same length as objectIDs.
+    If provided, must be the same length as `objectIDs`.
   items:
     $ref: '#/objectData'
 
@@ -140,7 +140,7 @@ objectDataAfterSearchList:
   description: |
     Extra information about the records involved in the event—for example, to add price and quantities of purchased products.
 
-    If provided, must be the same length as objectIDs.
+    If provided, must be the same length as `objectIDs`.
   items:
     $ref: '#/objectDataAfterSearch'
 

diff --git a/specs/insights/common/schemas/PurchasedObjectIDs.yml b/specs/insights/common/schemas/PurchasedObjectIDs.yml
@@ -1,13 +1,13 @@
 type: object
 title: Purchased object IDs
-description: Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use `purchasedObjectIDs`.
+description: Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.
 additionalProperties: false
 properties:
   eventName:
     $ref: './EventAttributes.yml#/eventName'
   eventType:
     $ref: './ConversionEvent.yml'
-  eventSubType:
+  eventSubtype:
     $ref: './PurchaseEvent.yml'
   index:
     $ref: './EventAttributes.yml#/index'
@@ -24,7 +24,7 @@ properties:
 required:
   - eventName
   - eventType
-  - eventSubType
+  - eventSubtype
   - index
   - objectIDs
   - userToken
diff --git a/specs/insights/common/schemas/PurchasedObjectIDsAfterSearch.yml b/specs/insights/common/schemas/PurchasedObjectIDsAfterSearch.yml
@@ -2,14 +2,14 @@ type: object
 title: Purchased object IDs after search
 description: |
   Use this event to track when users make a purchase after a previous Algolia request.
-  If you use Algolia to build your category pages, you'll also use the `purchasedObjectIDsAfterSearch` event.
+  If you're building your category pages with Algolia, you'll also use this event.
 additionalProperties: false
 properties:
   eventName:
     $ref: './EventAttributes.yml#/eventName'
   eventType:
     $ref: './ConversionEvent.yml'
-  eventSubType:
+  eventSubtype:
     $ref: './PurchaseEvent.yml'
   index:
     $ref: './EventAttributes.yml#/index'
@@ -28,7 +28,7 @@ properties:
 required:
   - eventName
   - eventType
-  - eventSubType
+  - eventSubtype
   - queryID
   - index
   - objectIDs

diff --git a/tests/CTS/methods/requests/insights/pushEvents.json b/tests/CTS/methods/requests/insights/pushEvents.json
@@ -188,7 +188,7 @@
       "events": [
         {
           "eventType": "conversion",
-          "eventSubType": "addToCart",
+          "eventSubtype": "addToCart",
           "eventName": "Product Added To Cart",
           "index": "products",
           "queryID": "43b15df305339e827f0ac0bdc5ebcaa7",
@@ -221,7 +221,7 @@
         "events": [
           {
             "eventType": "conversion",
-            "eventSubType": "addToCart",
+            "eventSubtype": "addToCart",
             "eventName": "Product Added To Cart",
             "index": "products",
             "queryID": "43b15df305339e827f0ac0bdc5ebcaa7",