Merge pull request #18 from AnkitSiva/object_id_type

RFC/PROPOSAL: add object_id_type to event.schema
o19s · Aug 31, 2024 · 2a2c464 · 2a2c464
2 parents 700f4ce + 7e1013b
commit 2a2c464
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/schema/1.0.0/event.schema.json b/schema/1.0.0/event.schema.json
@@ -106,6 +106,20 @@
                 }
               ]            
             },
+            "object_id_type": {
+              "description": "The type of the object id that the user is searching for. For a social e-commerce site, these could include product, user, post, comment and so on.",
+              "oneOf": [
+                {
+                  "type": "string",
+                  "maxLength": 100,
+                  "enum": ["product", "user", "post", "comment", "video"]
+                },
+                {
+                  "type": "string",
+                  "maxLength": 100
+                }
+              ]
+            },
             "object_id_field":{
               "description": "The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`.  If you do not provide this value then the default primary identifier in your search index will be used.  For example `_id` on OpenSearch. ",
               "type": "string",