Merge pull request #30 from o19s/release_1_2_0

Release 1.2.0 of UBI Specification
o19s · Oct 24, 2024 · 288590e · 288590e
2 parents e32f88b + d070841
commit 288590e
Show file tree

Hide file tree

Showing 12 changed files with 8 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -30,8 +30,9 @@ Many Search teams struggle with understanding "Why is my user doing this". They
 There are A LOT of tools out there for tracking events, Google Analytics, Snowplow, etc, but each is a bit different, and each tends to lock you in. None of them think about the needs of Search teams specifically either.
 
 The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for
- * [OpenSearch](https://github.com/o19s/documentation-website/tree/ubi-docs-consolidation/_search-plugins/ubi)
+ * [OpenSearch](https://opensearch.org/docs/latest/search-plugins/ubi)
  * [Apache Solr](https://github.com/apache/solr/pull/2452)
+ * [Elasticsearch](https://github.com/o19s/user-behavior-insights-elasticsearch)
 
 
 ## 🪛 How to use it
@@ -41,9 +42,9 @@ UBI requires coordination between the client (a browser, a mobile app, etc) and
 
 | JSON Schema | HTML Docs |
 | --- | --- |
- [query.request.schema.json](https://o19s.github.io/ubi/schema/1.1.0/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/query.request.schema.html) |
-| [query.response.schema.json](https://o19s.github.io/ubi/schema/1.1.0/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/query.response.schema.html) |
-| [event.schema.json](https://o19s.github.io/ubi/schema/1.1.0/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/event.schema.html) |
+ [query.request.schema.json](https://o19s.github.io/ubi/schema/1.2.0/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/query.request.schema.html) |
+| [query.response.schema.json](https://o19s.github.io/ubi/schema/1.2.0/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/query.response.schema.html) |
+| [event.schema.json](https://o19s.github.io/ubi/schema/1.2.0/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/event.schema.html) |
 
 You just need to copy, download or reference one of the schema files to validate a UBI data structure, built as a JSON file from scratch, or a JSON generated previously (for example, [these samples](https://github.com/o19s/ubi/blob/master/samples/)).
 

diff --git a/docs/html/event.schema.html → docs/html/1.0.0/event.schema.html b/docs/html/event.schema.html → docs/html/1.0.0/event.schema.html
diff --git a/docs/html/query.request.schema.html → docs/html/1.0.0/query.request.schema.html b/docs/html/query.request.schema.html → docs/html/1.0.0/query.request.schema.html
diff --git a/docs/html/query.response.schema.html → docs/html/1.0.0/query.response.schema.html b/docs/html/query.response.schema.html → docs/html/1.0.0/query.response.schema.html
diff --git a/docs/html/schema_doc.css → docs/html/1.0.0/schema_doc.css b/docs/html/schema_doc.css → docs/html/1.0.0/schema_doc.css
diff --git a/docs/html/schema_doc.min.js → docs/html/1.0.0/schema_doc.min.js b/docs/html/schema_doc.min.js → docs/html/1.0.0/schema_doc.min.js
diff --git a/out/event.schema.json b/out/event.schema.json
diff --git a/out/query.request.schema.json b/out/query.request.schema.json
diff --git a/out/query.response.schema.json b/out/query.response.schema.json
diff --git a/schema/1.2.0/event.schema.json b/schema/1.2.0/event.schema.json
@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://o19s.github.io/ubi/schema/1.2.0/event.schema.json",
   "title": "Event tracking for UBI",
-  "description": "Version 1.2.0; last updated 2024-???.  An event that occurred, typically in response to a user.",
+  "description": "Version 1.2.0; last updated 2024-10-24.  An event that occurred, typically in response to a user.",
   "type": "object",
   "required": ["action_name", "timestamp"],
   "properties": {

diff --git a/schema/1.2.0/query.request.schema.json b/schema/1.2.0/query.request.schema.json
@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://o19s.github.io/ubi/schema/1.2.0/query.request.schema.json",
   "title": "Query Tracking for UBI",
-  "description": "Version 1.2.0; last updated 2024-??.  A query made by a user should include these attributes for UBI tracking.",
+  "description": "Version 1.2.0; last updated 2024-10-24.  A query made by a user should include these attributes for UBI tracking.",
   "type": "object",
   "required": [ "user_query" ],
   "properties": {  

diff --git a/schema/1.2.0/query.response.schema.json b/schema/1.2.0/query.response.schema.json
@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://o19s.github.io/ubi/schema/1.2.0/query.response.schema.json",
   "title": "Query Response When Using UBI",
-  "description": "Version 1.2.0; last updated 2024-??.  The response to a query made by a user should support this schema.",
+  "description": "Version 1.2.0; last updated 2024-10-24.  The response to a query made by a user should support this schema.",
   "type": "object",
   "required": [ "query_id" ],
   "properties": {