collection items array item_type now required; update_customer change…

…_trigger no longer accepts null; order payment_id now required; click_item collection_id now required; added more desc.
snowplow · Jun 28, 2024 · 5f747fd · 5f747fd
1 parent 1792342
commit 5f747fd
Show file tree

Hide file tree

Showing 34 changed files with 75 additions and 31 deletions.
diff --git a/schemas/io.snowplow.ecomm/add_discount/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_discount/jsonschema/1-0-0
@@ -1,21 +1,24 @@
 {
     "description": "This event fires when a customer adds a discount to their order.",
     "properties": {
+        "discount_id": {
+            "type": "string",
+            "description": "The ID of the discount entity that was applied.",
+            "maxLength": 255
+        },
         "success": {
             "type": [
                 "boolean",
                 "null"
-            ]
+            ],
+            "description": "Whether the discount was successfully added."
         },
         "error_code": {
             "type": [
                 "string",
                 "null"
             ],
-            "maxLength": 255
-        },
-        "discount_id": {
-            "type": "string",
+            "description": "If the discount was unsuccessful in been applied then any error code generated can be populated here.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/add_shipping/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_shipping/jsonschema/1-0-0
@@ -3,10 +3,12 @@
     "properties": {
         "cart_id": {
             "type": "string",
+            "description": "The ID of the cart entity for which the shipping address is added to during a checkout process.",
             "maxLength": 255
         },
         "location_id": {
             "type": "string",
+            "description": "The ID of the location ID which contains the shipping address information.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/add_to_cart/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_to_cart/jsonschema/1-0-0
@@ -13,11 +13,13 @@
         },
         "quantity": {
             "type": "integer",
+            "description": "The number of the item that is being added to the cart.",
             "minimum": 1,
             "maximum": 2147483647
         },
         "cart_id": {
             "type": "string",
+            "description": "The ID of the cart entity that the item it being added to.",
             "maxLength": 255
         },
         "source": {

diff --git a/schemas/io.snowplow.ecomm/begin_checkout/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/begin_checkout/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "cart_id": {
             "type": "string",
+            "description": "The ID of the cart entity that is being checked out.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/cancel_subscription/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/cancel_subscription/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "subscription_id": {
             "type": "string",
+            "description": "The primary identifier of the subscription in the system.",
             "maxLength": 255
         },
         "reason": {

diff --git a/schemas/io.snowplow.ecomm/click_item/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/click_item/jsonschema/1-0-0
@@ -38,6 +38,7 @@
     "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
     "required": [
         "item_id",
-        "item_type"
+        "item_type",
+        "collection_id"
     ]
 }
diff --git a/schemas/io.snowplow.ecomm/close_dispute/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/close_dispute/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "dispute_id": {
             "type": "string",
+            "description": "The ID of the dispute entity.",
             "maxLength": 255
         },
         "reason": {

diff --git a/schemas/io.snowplow.ecomm/collection/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/collection/jsonschema/1-0-0
@@ -20,11 +20,9 @@
                         "maxLength": 255
                     },
                     "item_type": {
-                        "type": [
-                            "string",
-                            "null"
-                        ],
-                        "description": "The type of the item. Examples: \"product\", \"bundle\"",
+                        "type": "string",
+                        "enum": ["product", "bundle"],
+                        "description": "The general type of the item, currently supports the two types of a singular product and a bundle of products.",
                         "maxLength": 255
                     },
                     "position": {
@@ -37,7 +35,8 @@
                 "additionalProperties": false,
                 "required": [
                     "item_id",
-                    "position"
+                    "position",
+                    "item_type"
                 ]
             }
         },

diff --git a/schemas/io.snowplow.ecomm/complete_checkout/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/complete_checkout/jsonschema/1-0-0
@@ -3,10 +3,12 @@
     "properties": {
         "cart_id": {
             "type": "string",
+            "description": "The ID of the cart entity.",
             "maxLength": 255
         },
         "order_id": {
             "type": "string",
+            "description": "The ID of the order entity that is created for the completion of the checkout.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/coupon/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/coupon/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "coupon_id": {
             "type": "string",
+            "description": "The ID of the coupon entity.",
             "maxLength": 255
         },
         "conditions": {
@@ -42,7 +43,8 @@
             "type": [
                 "boolean",
                 "null"
-            ]
+            ],
+            "description": "Whether this coupon's benefits are recurring."
         },
         "currency": {
             "type": [

diff --git a/schemas/io.snowplow.ecomm/create_customer/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/create_customer/jsonschema/1-0-0
@@ -1,17 +1,18 @@
 {
     "description": "This event fires when a customer record or account is created or registered for the first time.",
     "properties": {
+        "customer_id": {
+            "type": "string",
+            "description": "The ID of the customer entity that is being created.",
+            "maxLength": 255
+        },
         "component_id": {
             "type": [
                 "string",
                 "null"
             ],
             "description": "Where on the page the customer registration was clicked.",
             "maxLength": 255
-        },
-        "customer_id": {
-            "type": "string",
-            "maxLength": 255
         }
     },
     "additionalProperties": false,

diff --git a/schemas/io.snowplow.ecomm/create_dispute/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/create_dispute/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "dispute_id": {
             "type": "string",
+            "description": "The ID of the dispute entity that is being created.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/create_order/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/create_order/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "order_id": {
             "type": "string",
+            "description": "The ID of the order entity.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/delete_customer/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/delete_customer/jsonschema/1-0-0
@@ -1,17 +1,18 @@
 {
     "description": "This event fires when a customer record or account is deleted, merged or removed/hidden from the system.",
     "properties": {
+        "customer_id": {
+            "type": "string",
+            "description": "The ID of the customer entity.",
+            "maxLength": 255
+        },
         "reason": {
             "type": [
                 "string",
                 "null"
             ],
             "description": "What triggered the customer account removal.",
             "maxLength": 512
-        },
-        "customer_id": {
-            "type": "string",
-            "maxLength": 255
         }
     },
     "additionalProperties": false,

diff --git a/schemas/io.snowplow.ecomm/discount/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/discount/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "discount_id": {
             "type": "string",
+            "description": "The ID of the discount entity.",
             "maxLength": 255
         },
         "name": {

diff --git a/schemas/io.snowplow.ecomm/dispute/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/dispute/jsonschema/1-0-0
@@ -11,6 +11,7 @@
     "properties": {
       "dispute_id": {
         "type": "string",
+        "description": "The ID of the dispute entity.",
         "maxLength": 255
       },
       "description": {

diff --git a/schemas/io.snowplow.ecomm/location/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/location/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "location_id": {
             "type": "string",
+            "description": "The ID of the location entity.",
             "maxLength": 255
         },
         "latitude": {
@@ -76,6 +77,7 @@
                         "string",
                         "null"
                     ],
+                    "description": "The zipcode or the post code.",
                     "maxLength": 32
                 },
                 "country": {

diff --git a/schemas/io.snowplow.ecomm/order/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/order/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "order_id": {
             "type": "string",
+            "description": "The ID of the order entity.",
             "maxLength": 255
         },
         "status": {
@@ -119,6 +120,7 @@
     "required": [
         "order_id",
         "status",
-        "order_date"
+        "order_date",
+        "payment_id"
     ]
 }
diff --git a/schemas/io.snowplow.ecomm/pause_subscription/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/pause_subscription/jsonschema/1-0-0
@@ -3,13 +3,15 @@
     "properties": {
         "subscription_id": {
             "type": "string",
+            "description": "The primary identifier of the subscription in the system.",
             "maxLength": 255
         },
         "reason": {
             "type": [
                 "string",
                 "null"
             ],
+            "description": "The reason, if given, for why the subscription was paused.",
             "maxLength": 512
         }
     },

diff --git a/schemas/io.snowplow.ecomm/payment/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/payment/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "payment_id": {
             "type": "string",
+            "description": "The ID of the payment entity.",
             "maxLength": 255
         },
         "order_id": {
@@ -18,6 +19,7 @@
                 "string",
                 "null"
             ],
+            "description": "The ID of the customer entity if the user is a registered customer.",
             "maxLength": 255
         },
         "payment_methods": {
@@ -59,6 +61,7 @@
                 "string",
                 "null"
             ],
+            "description": "The primary identifier of the transaction.",
             "maxLength": 255
         },
         "status": {
@@ -88,6 +91,7 @@
                 "string",
                 "null"
             ],
+            "description": "The ID of the campaign entity if a campaign is associated with this payment.",
             "maxLength": 255
         },
         "total": {

diff --git a/schemas/io.snowplow.ecomm/product/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/product/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "product_id": {
             "type": "string",
+            "description": "The ID of the product entity.",
             "maxLength": 255
         },
         "common_id": {

diff --git a/schemas/io.snowplow.ecomm/remove_from_cart/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/remove_from_cart/jsonschema/1-0-0
@@ -16,6 +16,7 @@
                 "string",
                 "null"
             ],
+            "description": "The reason, if given, for why the item was removed from the cart.",
             "maxLength": 512
         }
     },

diff --git a/schemas/io.snowplow.ecomm/replacement/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/replacement/jsonschema/1-0-0
@@ -11,6 +11,7 @@
     "properties": {
       "replacement_id": {
         "type": "string",
+        "description": "The primary identifier of the replacement order.",
         "maxLength": 255
       },
       "order_id": {

diff --git a/schemas/io.snowplow.ecomm/resolve_dispute/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/resolve_dispute/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "dispute_id": {
             "type": "string",
+            "description": "The ID of the dispute entity that was resolved.",
             "maxLength": 255
         },
         "resolution": {

diff --git a/schemas/io.snowplow.ecomm/return/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/return/jsonschema/1-0-0
@@ -11,6 +11,7 @@
     "properties": {
       "return_id": {
         "type": "string",
+        "description": "The primary identifier of the return order.",
         "maxLength": 255
       },
       "order_id": {

diff --git a/schemas/io.snowplow.ecomm/search/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/search/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "search_id": {
             "type": "string",
+            "description": "The ID of the search entity.",
             "maxLength": 255
         },
         "search_index": {

diff --git a/schemas/io.snowplow.ecomm/store/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/store/jsonschema/1-0-0
@@ -3,6 +3,7 @@
     "properties": {
         "store_id": {
             "type": "string",
+            "description": "The ID of the store entity.",
             "maxLength": 255
         },
         "name": {
@@ -27,6 +28,7 @@
                 "string",
                 "null"
             ],
+            "description": "The contact phone number of the store if it exists.",
             "maxLength": 255
         },
         "store_type": {

diff --git a/schemas/io.snowplow.ecomm/submit_search/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/submit_search/jsonschema/1-0-0
@@ -3,7 +3,7 @@
     "properties": {
         "search_id": {
             "type": "string",
-            "description": "A unique identifier for this search.",
+            "description": "The ID of the search entity for this search.",
             "maxLength": 255
         }
     },

diff --git a/schemas/io.snowplow.ecomm/update_customer/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/update_customer/jsonschema/1-0-0
@@ -3,13 +3,11 @@
     "properties": {
         "customer_id": {
             "type": "string",
+            "description": "The ID of the customer entity that the update applies to.",
             "maxLength": 255
         },
         "change_trigger": {
-            "type": [
-                "string",
-                "null"
-            ],
+            "type": "string",
             "description": "What triggered the Customer information update.",
             "maxLength": 255
         },
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
                     "string",
                     "null"
                 ],
+                "description": "The reason, if given, for why the item was removed from the cart.",
                 "maxLength": 512
             }
         },
@@ Expand Down @@