From 48b1f4db51ee4182759fbc9dde088fa531fa19bd Mon Sep 17 00:00:00 2001 From: Ankit Siva Date: Tue, 30 Jul 2024 15:17:09 -0700 Subject: [PATCH 1/2] feat: add user_id to event.schema --- schema/1.0.0/event.schema.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/schema/1.0.0/event.schema.json b/schema/1.0.0/event.schema.json index e6e89cb..16788bf 100644 --- a/schema/1.0.0/event.schema.json +++ b/schema/1.0.0/event.schema.json @@ -51,6 +51,12 @@ "maxLength": 100, "examples": ["5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5","quepid-nightly-bot", "BugsBunny::Firefox@0967084"] }, + "user_id": { + "description": "The user ID associated with the person performing the interactions being logged on the site. Can be null/empty in case of an unauthenticated user.", + "type": "string", + "maxLength": 100, + "examples": ["5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5"] + }, "timestamp": { "description": "When the event took place.", "type": "string", From b633bdd2763598aa698440e642428f7e92e9ae14 Mon Sep 17 00:00:00 2001 From: Ankit Siva Date: Wed, 7 Aug 2024 09:16:34 -0700 Subject: [PATCH 2/2] fix: remove user_id documentation from client_id The client_id field had some lingering documentation about where user_ids could go. This commit cleans that up. --- schema/1.0.0/event.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/1.0.0/event.schema.json b/schema/1.0.0/event.schema.json index 16788bf..ce1536b 100644 --- a/schema/1.0.0/event.schema.json +++ b/schema/1.0.0/event.schema.json @@ -46,7 +46,7 @@ ] }, "client_id": { - "description": "The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. If only authenticated users are tracked, then you could use a specific user id here, otherwise you should use something permanent and track user id as an _Additional Property_.", + "description": "The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot.", "type": "string", "maxLength": 100, "examples": ["5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5","quepid-nightly-bot", "BugsBunny::Firefox@0967084"]