v1.3.0

This release includes a few community findings and improvements that reduce redundancy and increase its readability und usability.

What's Changed

• Update docs to reflect that Opensearch is finicky about timezones by @epugh in #31
• add user_query to events schema by @wrigleyDan in #38
• add query_response_hit_ids to query request schema by @wrigleyDan in #38
• removes click_through from enums in events schema by @AnkitSiva in #38
• remove index property from events schema for tracking positional information noticed by @russcam in the UBI plugin repository (opensearch-project/user-behavior-insights#74)
• remove uuid from all schemas to reduce redundancy by @wrigleyDan in #38

New Contributors

• @wrigleyDan made their first contribution in #38

Full Changelog: v1.2.0...v1.3.0

v1.2.0

This release introduces a formal application element to both queries and events so you can distingush different sources of queries and their follow on events. Think type-ahead and search as two common applications.

We also formalize that the timestamps are ISO 8601 formatted. JSON Schema doesn't provide actual validation of dates however.

What's Changed

• add in the community files, inspired by MAC by @epugh in #24
• Introduce UBI Spec 1.2.0 by @epugh in #28
• Release 1.2.0 of UBI Specification by @epugh in #30

Full Changelog: v1.1.0...v1.2.0

1.1.0

First release with third party users looking to leverage UBI. This release is primarily adding things we initially decided to skip, and being more relaxed in our requirements for validation.

We are NOT trying to rock the boat in this release, instead we are trying to learn!

What's Changed

• Add faq and descriptive text to provide more details on common use case of UBI. by @epugh in #13
• Add to FAQ how to correlating private data with public events by @epugh in #21
• Adds impression to action enum by @miike in #22
• RFC/PROPOSAL: add session_id to event.schema by @AnkitSiva in #17
• RFC/PROPOSAL: add user_id to event.schema by @AnkitSiva in #15
• fix[event.schema.json]: query_id optional by @AnkitSiva in #20
• RFC/PROPOSAL: add object_id_type to event.schema by @AnkitSiva in #18
• Prep 1.1.0 release by @epugh in #25

New Contributors

• @miike made their first contribution in #22
• @AnkitSiva made their first contribution in #17

Full Changelog: v1.0.0...v1.1.0

1.0.0 - Initial Release

This is the first release of the User Behavior Insights specification that supports tracking of user queries and subsequent actions. Using this schema allows you to validate that your query data and event data are UBI compliant.