Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
forgot to mention the new object.object_details.json field.
Browse files Browse the repository at this point in the history
  • Loading branch information
RasonJ committed Apr 19, 2024
1 parent 8c00d4e commit 48fa719
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions documentation/schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ When UBI is turned on, a *search client* will get a `query_id` back from OpenSea
# TODO: `key_field` rename?
The `object` structure has two ways to refer to the object:
- `event_attributes.object.object_id` is the unique id that OpenSearch can use internally to index the object.
- `event_attributes.object.catalog_id` is the id that a user could look up the object in a *catelog*

- `event_attributes.object.catalog_id` is the id that a user could look up the object in a *catalog*

Therefore, the `query_id` signals the beginning of a user's *Search Journey*,
`action_name` tells us how the user is interacting with the query results within the application,
Expand Down Expand Up @@ -67,7 +66,9 @@ The current event mappings file can be found [here](../src/main/resources/events
- `event_attributes.object.to_user_id` \
  optionally points to another user, if they are the recipient of this object, perhaps as a gift, from the user's `user_id`
- `event_attributes.object.object_detail` \
  optional data object/map of further data details
  optional text for further data object details
- `event_attributes.object.object_detail.json` \
  if the user has a json object representing what was acted upon, it can be stored here; however, note that that could lead to index bloat if the json objects are large.
- `event_attributes.position` \
  nested object to track user events to the location of the event origins
- `event_attributes.position.ordinal` \
Expand Down

0 comments on commit 48fa719

Please sign in to comment.