Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.2.0 of UBI Specification #30

Merged
merged 8 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/)).

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion out/event.schema.json

This file was deleted.

1 change: 0 additions & 1 deletion out/query.request.schema.json

This file was deleted.

1 change: 0 additions & 1 deletion out/query.response.schema.json

This file was deleted.

2 changes: 1 addition & 1 deletion schema/1.2.0/event.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion schema/1.2.0/query.request.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion schema/1.2.0/query.response.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down