diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 88e9712..fcdbf08 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -21,4 +21,4 @@ generate-schema-doc --config-file jsfh-conf.yaml ./schema ./docs/html We then check them into Github. -https://o19s.github.io/blob/main/docs/html/event.request.schema.html +https://o19s.github.io/blob/main/docs/ diff --git a/README.md b/README.md index e49b5fd..7afdd18 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,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/X.Y.Z/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/query.request.schema.html) | -| [query.response.schema.json](https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/query.response.schema.html) | -| [event.schema.json](https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/event.schema.html) | + [query.request.schema.json](https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/query.request.schema.html) | +| [query.response.schema.json](https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/query.response.schema.html) | +| [event.schema.json](https://o19s.github.io/ubi/schema/1.0.0/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/event.schema.html) | To validate 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/)). @@ -62,8 +62,6 @@ To get started, you can copy both schema and sample in an **online validator** l } ``` -!["JSON Schema"](https://github.com/o19s/ubi/blob/master/assets/readme/MAC_online_validator_example.png?raw=true "JSON Schema") - You also have implementations to validate a JSON file programmatically in almost every [coding language](https://json-schema.org/implementations.html). > :warning: **The current UBI Schema has been designed using the 2020-12 Specification Draft**: When choosing a validator, please, check if it's compliant with the 2020-12 Draft. You can get much more information about the JSON Schema Specification in [json-schema.org](https://json-schema.org/). @@ -107,9 +105,7 @@ UBI is available under the Apache Software License, version 2. If you want to say thank you and/or support active development of UBI: - Add a GitHub Star to the project! -- ??? -- ? - +- Contact Eric at epugh@opensourceconnections.com or Stavros at macrakis@gmail.com Thanks so much for your interest in growing the reach of UBI! diff --git a/docs/html/event.schema.html b/docs/html/event.schema.html index 5edf019..a0fdb64 100644 --- a/docs/html/event.schema.html +++ b/docs/html/event.schema.html @@ -1,4 +1,4 @@ - Event tracking for UBI

Event tracking for UBI

Type: object

Version X.Y.Z; last updated 2024-05-23. An event that occurred, typically in response to a user. See schemas.md and events-mapping.json for more info.

root application
Type: string

name of the application tracking UBI events.

Must be at most 100 characters long


Examples:

"amazon-shop"
+ Event tracking for UBI 
   
 
 
Event tracking for UBI
Type: object
 
Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.
  
 
 
 
  
 
 
 
 
root    application
Type: string
 
name of the application tracking UBI events.
  
Must be at most 100 characters long
 
 
Examples:
 
"amazon-shop"
 
 
"ABC-microservice"
 
 
"doctor-search"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    action_name

 
The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.
 
  
 
 
root    action_name    oneOf    item 0
Type: enum (of string)
 
 
Must be one of:
 
  • "click_through"
  • "add_to_cart"
  • "click"
  • "watch"
  • "view"
  • "purchase"
 
 
 
root    action_name    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    query_id

 
The unique identifier of a query, typically a UUID, but can be any string.
 
  
 
 
root    query_id    oneOf    item 0
Type: stringFormat: uuid
 
 
Example:
 
"00112233-4455-6677-8899-aabbccddeeff"
@@ -17,4 +17,4 @@
 
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 
root    event_attributes    object    additionalProperties
Type: object

root event_attributes position

Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.

root event_attributes position oneOf item 0
Type: object

root event_attributes position oneOf item 0 ordinal
Type: object

The nth position of the document on the search results page.

root event_attributes position oneOf item 0 ordinal index
Type: integer

The position of the document. For grid layout this would be left to right, ignoring wrapping.
Examples:

1
 
3
 
24
-
root event_attributes position oneOf item 1
Type: object

root event_attributes position oneOf item 1 xy
Type: object

The x,y coordinates on the screen for triggering an event.

root event_attributes position oneOf item 1 xy x
Type: number

The horizontal location on the page or screen of the event.

root event_attributes position oneOf item 1 xy y
Type: number

The vertical location on the page or screen of the event.

Additional Properties of any type are allowed.

root event_attributes position additionalProperties
Type: object

Additional Properties of any type are allowed.

root event_attributes additionalProperties
Type: object
\ No newline at end of file +
root event_attributes position oneOf item 1
Type: object

root event_attributes position oneOf item 1 xy
Type: object

The x,y coordinates on the screen for triggering an event.

root event_attributes position oneOf item 1 xy x
Type: number

The horizontal location on the page or screen of the event.

root event_attributes position oneOf item 1 xy y
Type: number

The vertical location on the page or screen of the event.

Additional Properties of any type are allowed.

root event_attributes position additionalProperties
Type: object

Additional Properties of any type are allowed.

root event_attributes additionalProperties
Type: object
\ No newline at end of file diff --git a/docs/html/query.request.schema.html b/docs/html/query.request.schema.html index de25f1e..efe3458 100644 --- a/docs/html/query.request.schema.html +++ b/docs/html/query.request.schema.html @@ -1,6 +1,6 @@ - Query Tracking for UBI

Query Tracking for UBI

Type: object

Version X.Y.Z; last updated 2024-05-23. A query made by a user should include these attributes for UBI tracking.

root query_id

The unique identifier of a query, typically a UUID, but can be any string.

root query_id oneOf item 0
Type: stringFormat: uuid

Example:

"00112233-4455-6677-8899-aabbccddeeff"
+ Query Tracking for UBI 
   
 
 
Query Tracking for UBI
Type: object
 
Version 1.0.0; last updated 2024-06-14. A query made by a user should include these attributes for UBI tracking.
  
 
 
 
  
 
 
 
 
root    query_id

 
The unique identifier of a query, typically a UUID, but can be any string.
 
  
 
 
root    query_id    oneOf    item 0
Type: stringFormat: uuid
 
 
Example:
 
"00112233-4455-6677-8899-aabbccddeeff"
 
 
 
 
root    query_id    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
Example:
 
"1234-user-5678"
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    client_id
Type: string
 
The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot.
  
Must be at most 100 characters long
 
 
Examples:
 
"5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5"
 
 
"quepid-nightly-bot"
 
 
"BugsBunny::Firefox@0967084"
-
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    user_query
Type: string
 
The query as the user entered it. No length limit specified.
  
 
 
 
 
 
 
 
  
 
 
 
 
root    query_attributes
Type: object
 
Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.
  
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 
root    query_attributes    additionalProperties
Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    object_id_field
Type: string
 
The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be sku and if you are querying for people, maybe this is ssn. If you do not provide this value then the default primary identifier in your search index will be used. For example _id on OpenSearch. 
  
Must be at most 100 characters long
 
 
 
 
  
\ No newline at end of file
+

root user_query
Type: string

The query as the user entered it. No length limit specified.

root query_attributes
Type: object

Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.

Additional Properties of any type are allowed.

root query_attributes additionalProperties
Type: object

root object_id_field
Type: string

The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be sku and if you are querying for people, maybe this is ssn. If you do not provide this value then the default primary identifier in your search index will be used. For example _id on OpenSearch.

Must be at most 100 characters long

\ No newline at end of file diff --git a/docs/html/query.response.schema.html b/docs/html/query.response.schema.html index 381a0a6..88e5afa 100644 --- a/docs/html/query.response.schema.html +++ b/docs/html/query.response.schema.html @@ -1,3 +1,3 @@ - Query Response When Using UBI

Query Response When Using UBI

Type: object

Version X.Y.Z; last updated 2024-05-23. The response to a query made by a user should support this schema.

root query_id

The unique identifier of a query, typically a UUID, but can be any string.

root query_id oneOf item 0
Type: stringFormat: uuid

Example:

"00112233-4455-6677-8899-aabbccddeeff"
+ Query Response When Using UBI 
   
 
 
Query Response When Using UBI
Type: object
 
Version 1.0.0; last updated 2024-06-14. The response to a query made by a user should support this schema.
  
 
 
 
  
 
 
 
 
root    query_id

 
The unique identifier of a query, typically a UUID, but can be any string.
 
  
 
 
root    query_id    oneOf    item 0
Type: stringFormat: uuid
 
 
Example:
 
"00112233-4455-6677-8899-aabbccddeeff"
 
 
 
 
root    query_id    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
Example:
 
"1234-user-5678"
-
 
 
 
 
 
 
  
\ No newline at end of file
+
\ No newline at end of file diff --git a/docs/schema/README.md b/docs/schema/README.md index c6dedae..24453db 100644 --- a/docs/schema/README.md +++ b/docs/schema/README.md @@ -2,31 +2,31 @@ ## Top-level Schemas -* [Event tracking for UBI](./event.md "Version X") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json` +* [Event tracking for UBI](./event.md "Version 1") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json` -* [Query Response When Using UBI](./query.md "Version X") – `https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json` +* [Query Response When Using UBI](./query.md "Version 1") – `https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json` -* [Query Tracking for UBI](./query-1.md "Version X") – `https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json` +* [Query Tracking for UBI](./query-1.md "Version 1") – `https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json` ## Other Schemas ### Objects -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes.md "Extensible details about a specific event") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes.md "Extensible details about a specific event") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-object.md "Structure which contains identifying information of the object returned from the query that the user interacts with (i") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-object.md "Structure which contains identifying information of the object returned from the query that the user interacts with (i") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position.md "Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position.md "Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-0.md) – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-0.md) – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "The nth position of the document on the search results page") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "The nth position of the document on the search results page") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-1.md) – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-1.md) – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1` -* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "The x,y coordinates on the screen for triggering an event") – `https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy` +* [Untitled object in Event tracking for UBI](./event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "The x,y coordinates on the screen for triggering an event") – `https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy` -* [Untitled object in Query Tracking for UBI](./query-1-properties-query_attributes.md "Any query modifiers like filter choices or pagination") – `https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_attributes` +* [Untitled object in Query Tracking for UBI](./query-1-properties-query_attributes.md "Any query modifiers like filter choices or pagination") – `https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_attributes` ### Arrays diff --git a/docs/schema/event-properties-action_name-oneof-0.md b/docs/schema/event-properties-action_name-oneof-0.md index cb269d3..bd68500 100644 --- a/docs/schema/event-properties-action_name-oneof-0.md +++ b/docs/schema/event-properties-action_name-oneof-0.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/action_name/oneOf/0 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/action_name/oneOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/event-properties-action_name-oneof-1.md b/docs/schema/event-properties-action_name-oneof-1.md index 77214d6..5879d43 100644 --- a/docs/schema/event-properties-action_name-oneof-1.md +++ b/docs/schema/event-properties-action_name-oneof-1.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/action_name/oneOf/1 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/action_name/oneOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/event-properties-action_name.md b/docs/schema/event-properties-action_name.md index f5dac9a..f03983f 100644 --- a/docs/schema/event-properties-action_name.md +++ b/docs/schema/event-properties-action_name.md @@ -1,14 +1,14 @@ # Untitled undefined type in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/action_name +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/action_name ``` The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## action\_name Type diff --git a/docs/schema/event-properties-application.md b/docs/schema/event-properties-application.md index 6923f9b..9f4e4ec 100644 --- a/docs/schema/event-properties-application.md +++ b/docs/schema/event-properties-application.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/application +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/application ``` name of the application tracking UBI events. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## application Type diff --git a/docs/schema/event-properties-client_id.md b/docs/schema/event-properties-client_id.md index a0a20e2..2c477f2 100644 --- a/docs/schema/event-properties-client_id.md +++ b/docs/schema/event-properties-client_id.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/client_id +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/client_id ``` The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## client\_id Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-0.md b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-0.md index 6485bb2..4d2f911 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-0.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-0.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id/anyOf/0 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id/anyOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-1.md b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-1.md index 8b13610..1a14f14 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-1.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id-anyof-1.md @@ -1,14 +1,14 @@ # Untitled integer in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id/anyOf/1 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id/anyOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id.md b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id.md index 414e6ae..00709f9 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-internal_id.md @@ -1,14 +1,14 @@ # Untitled undefined type in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id ``` A unique id that the an individual search engine uses internally to index the object via. For example, in OpenSearch, think the `_id` field in the indices. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## internal\_id Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-0.md b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-0.md index af170a3..e366080 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-0.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-0.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id/anyOf/0 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id/anyOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-1.md b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-1.md index b9ebed6..60cd051 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-1.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id-anyof-1.md @@ -1,14 +1,14 @@ # Untitled integer in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id/anyOf/1 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id/anyOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id.md b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id.md index 9c82311..cf2dac2 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id.md @@ -1,14 +1,14 @@ # Untitled undefined type in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id ``` The id that a user could look up and find the object instance within the *document corpus*. Examples include: *ssn*, *isbn*, *ean*, etc. Variants need to be incorporated in the `object_id`, so for a t-shirt that is red, you would need SKU level as the `object_id`. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## object\_id Type diff --git a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id_field.md b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id_field.md index 568c757..84df844 100644 --- a/docs/schema/event-properties-event_attributes-properties-object-properties-object_id_field.md +++ b/docs/schema/event-properties-event_attributes-properties-object-properties-object_id_field.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field ``` The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## object\_id\_field Type diff --git a/docs/schema/event-properties-event_attributes-properties-object.md b/docs/schema/event-properties-event_attributes-properties-object.md index a8e31c5..d1e4c5e 100644 --- a/docs/schema/event-properties-event_attributes-properties-object.md +++ b/docs/schema/event-properties-event_attributes-properties-object.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object ``` Structure which contains identifying information of the object returned from the query that the user interacts with (i.e.: a book, a product, a post, etc..). | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## object Type @@ -18,9 +18,9 @@ Structure which contains identifying information of the object returned from the | Property | Type | Required | Nullable | Defined by | | :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [object\_id](#object_id) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id") | -| [object\_id\_field](#object_id_field) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id_field.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field") | -| [internal\_id](#internal_id) | Merged | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-internal_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id") | +| [object\_id](#object_id) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id") | +| [object\_id\_field](#object_id_field) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id_field.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field") | +| [internal\_id](#internal_id) | Merged | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-internal_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id") | | Additional Properties | Any | Optional | can be null | | ## object\_id @@ -35,7 +35,7 @@ The id that a user could look up and find the object instance within the *docume * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id") ### object\_id Type @@ -73,7 +73,7 @@ The name of the field that has the id of the objects that will be stored in the * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id_field.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-object_id_field.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/object_id_field") ### object\_id\_field Type @@ -95,7 +95,7 @@ A unique id that the an individual search engine uses internally to index the ob * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-internal_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object-properties-internal_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object/properties/internal_id") ### internal\_id Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md index ff9f77d..aa617d9 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md @@ -1,14 +1,14 @@ # Untitled integer in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index ``` The position of the document. For grid layout this would be left to right, ignoring wrapping. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## index Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md index bd2fd65..7692551 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal ``` The nth position of the document on the search results page. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## ordinal Type @@ -18,7 +18,7 @@ The nth position of the document on the search results page. | Property | Type | Required | Nullable | Defined by | | :-------------- | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [index](#index) | `integer` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index") | +| [index](#index) | `integer` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index") | ## index @@ -32,7 +32,7 @@ The position of the document. For grid layout this would be left to right, igno * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal-properties-index.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal/properties/index") ### index Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-0.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-0.md index 7bc85f5..11d27a3 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-0.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-0.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 0 Type @@ -18,7 +18,7 @@ https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attr | Property | Type | Required | Nullable | Defined by | | :------------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [ordinal](#ordinal) | `object` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal") | +| [ordinal](#ordinal) | `object` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal") | ## ordinal @@ -32,7 +32,7 @@ The nth position of the document on the search results page. * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-0-properties-ordinal.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/0/properties/ordinal") ### ordinal Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md index 0282c40..d920669 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md @@ -1,14 +1,14 @@ # Untitled number in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x ``` The horizontal location on the page or screen of the event. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## x Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md index 8beffab..f6088c9 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md @@ -1,14 +1,14 @@ # Untitled number in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y ``` The vertical location on the page or screen of the event. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## y Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy.md index c9c48e3..49f55af 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-1-properties-xy.md @@ -1,7 +1,7 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy ``` The x,y coordinates on the screen for triggering an event. @@ -10,7 +10,7 @@ The x,y coordinates on the screen for triggering an event. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## xy Type @@ -20,8 +20,8 @@ The x,y coordinates on the screen for triggering an event. | Property | Type | Required | Nullable | Defined by | | :------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [x](#x) | `number` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x") | -| [y](#y) | `number` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y") | +| [x](#x) | `number` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x") | +| [y](#y) | `number` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y") | ## x @@ -35,7 +35,7 @@ The horizontal location on the page or screen of the event. * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-x.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/x") ### x Type @@ -53,7 +53,7 @@ The vertical location on the page or screen of the event. * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy-properties-y.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy/properties/y") ### y Type diff --git a/docs/schema/event-properties-event_attributes-properties-position-oneof-1.md b/docs/schema/event-properties-event_attributes-properties-position-oneof-1.md index f4c8afe..1fb9eec 100644 --- a/docs/schema/event-properties-event_attributes-properties-position-oneof-1.md +++ b/docs/schema/event-properties-event_attributes-properties-position-oneof-1.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 1 Type @@ -18,7 +18,7 @@ https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attr | Property | Type | Required | Nullable | Defined by | | :-------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [xy](#xy) | `object` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy") | +| [xy](#xy) | `object` | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy") | ## xy @@ -34,7 +34,7 @@ The x,y coordinates on the screen for triggering an event. * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position-oneof-1-properties-xy.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position/oneOf/1/properties/xy") ### xy Type diff --git a/docs/schema/event-properties-event_attributes-properties-position.md b/docs/schema/event-properties-event_attributes-properties-position.md index 5a5ae43..a4c7805 100644 --- a/docs/schema/event-properties-event_attributes-properties-position.md +++ b/docs/schema/event-properties-event_attributes-properties-position.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position ``` Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## position Type diff --git a/docs/schema/event-properties-event_attributes.md b/docs/schema/event-properties-event_attributes.md index 831c523..04a2a98 100644 --- a/docs/schema/event-properties-event_attributes.md +++ b/docs/schema/event-properties-event_attributes.md @@ -1,14 +1,14 @@ # Untitled object in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes ``` Extensible details about a specific event. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## event\_attributes Type @@ -18,8 +18,8 @@ Extensible details about a specific event. | Property | Type | Required | Nullable | Defined by | | :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [object](#object) | `object` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object") | -| [position](#position) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position") | +| [object](#object) | `object` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-object.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object") | +| [position](#position) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-event_attributes-properties-position.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position") | | Additional Properties | Any | Optional | can be null | | ## object @@ -34,7 +34,7 @@ Structure which contains identifying information of the object returned from the * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/object") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-object.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/object") ### object Type @@ -52,7 +52,7 @@ Structure that contains information on the location of the event origin, such as * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes/properties/position") +* defined in: [Event tracking for UBI](event-properties-event_attributes-properties-position.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes/properties/position") ### position Type diff --git a/docs/schema/event-properties-message.md b/docs/schema/event-properties-message.md index d03cb52..c84ea22 100644 --- a/docs/schema/event-properties-message.md +++ b/docs/schema/event-properties-message.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message ``` Optional text message for the log entry. For example, for a message\_type of QUERY, we would expect the text to be about what the user is searching on. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## message Type diff --git a/docs/schema/event-properties-message_type.md b/docs/schema/event-properties-message_type.md index 847abc5..76cf6b5 100644 --- a/docs/schema/event-properties-message_type.md +++ b/docs/schema/event-properties-message_type.md @@ -1,7 +1,7 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message_type +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message_type ``` Group various `action_name`'s into logical bins. @@ -10,7 +10,7 @@ Group various `action_name`'s into logical bins. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## message\_type Type diff --git a/docs/schema/event-properties-query_id-oneof-0.md b/docs/schema/event-properties-query_id-oneof-0.md index d6bc009..ae597fd 100644 --- a/docs/schema/event-properties-query_id-oneof-0.md +++ b/docs/schema/event-properties-query_id-oneof-0.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/query_id/oneOf/0 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/query_id/oneOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/event-properties-query_id-oneof-1.md b/docs/schema/event-properties-query_id-oneof-1.md index 5fedeb2..84d4b9b 100644 --- a/docs/schema/event-properties-query_id-oneof-1.md +++ b/docs/schema/event-properties-query_id-oneof-1.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/query_id/oneOf/1 +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/query_id/oneOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/event-properties-query_id.md b/docs/schema/event-properties-query_id.md index 6ad1197..5a0c1a4 100644 --- a/docs/schema/event-properties-query_id.md +++ b/docs/schema/event-properties-query_id.md @@ -1,14 +1,14 @@ # Untitled undefined type in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/query_id +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/query_id ``` The unique identifier of a query, typically a UUID, but can be any string. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## query\_id Type diff --git a/docs/schema/event-properties-timestamp.md b/docs/schema/event-properties-timestamp.md index cc28e91..7731511 100644 --- a/docs/schema/event-properties-timestamp.md +++ b/docs/schema/event-properties-timestamp.md @@ -1,14 +1,14 @@ # Untitled string in Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/timestamp +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/timestamp ``` When the event took place. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [event.schema.json\*](../../out/1.0.0/event.schema.json "open original schema") | ## timestamp Type diff --git a/docs/schema/event.md b/docs/schema/event.md index eb54486..a6d5291 100644 --- a/docs/schema/event.md +++ b/docs/schema/event.md @@ -1,14 +1,14 @@ # Event tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json +https://o19s.github.io/ubi/schema/1.0.0/event.schema.json ``` -Version X.Y.Z; last updated 2024-05-23. An event that occurred, typically in response to a user. See [schemas.md](https://github.com/o19s/opensearch-ubi/blob/2.14.0/documentation/schemas.md) and [events-mapping.json](https://github.com/o19s/opensearch-ubi/blob/2.14.0/src/main/resources/events-mapping.json) for more info. +Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json](../../out/X.Y.Z/event.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [event.schema.json](../../out/1.0.0/event.schema.json "open original schema") | ## Event tracking for UBI Type @@ -18,14 +18,14 @@ Version X.Y.Z; last updated 2024-05-23. An event that occurred, typically in re | Property | Type | Required | Nullable | Defined by | | :------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [application](#application) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-application.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/application") | -| [action\_name](#action_name) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-action_name.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/action_name") | -| [query\_id](#query_id) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/query_id") | -| [client\_id](#client_id) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-client_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/client_id") | -| [timestamp](#timestamp) | `string` | Required | cannot be null | [Event tracking for UBI](event-properties-timestamp.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/timestamp") | -| [message\_type](#message_type) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-message_type.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message_type") | -| [message](#message) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-message.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message") | -| [event\_attributes](#event_attributes) | `object` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes") | +| [application](#application) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-application.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/application") | +| [action\_name](#action_name) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-action_name.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/action_name") | +| [query\_id](#query_id) | Merged | Required | cannot be null | [Event tracking for UBI](event-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/query_id") | +| [client\_id](#client_id) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-client_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/client_id") | +| [timestamp](#timestamp) | `string` | Required | cannot be null | [Event tracking for UBI](event-properties-timestamp.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/timestamp") | +| [message\_type](#message_type) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-message_type.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message_type") | +| [message](#message) | `string` | Optional | cannot be null | [Event tracking for UBI](event-properties-message.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message") | +| [event\_attributes](#event_attributes) | `object` | Optional | cannot be null | [Event tracking for UBI](event-properties-event_attributes.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes") | ## application @@ -39,7 +39,7 @@ name of the application tracking UBI events. * cannot be null -* defined in: [Event tracking for UBI](event-properties-application.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/application") +* defined in: [Event tracking for UBI](event-properties-application.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/application") ### application Type @@ -75,7 +75,7 @@ The name of the action that triggered the event. We have a set of common defaul * cannot be null -* defined in: [Event tracking for UBI](event-properties-action_name.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/action_name") +* defined in: [Event tracking for UBI](event-properties-action_name.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/action_name") ### action\_name Type @@ -99,7 +99,7 @@ The unique identifier of a query, typically a UUID, but can be any string. * cannot be null -* defined in: [Event tracking for UBI](event-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/query_id") +* defined in: [Event tracking for UBI](event-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/query_id") ### query\_id Type @@ -123,7 +123,7 @@ The client issuing the query. This could be a unique browser, a microservice th * cannot be null -* defined in: [Event tracking for UBI](event-properties-client_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/client_id") +* defined in: [Event tracking for UBI](event-properties-client_id.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/client_id") ### client\_id Type @@ -159,7 +159,7 @@ When the event took place. * cannot be null -* defined in: [Event tracking for UBI](event-properties-timestamp.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/timestamp") +* defined in: [Event tracking for UBI](event-properties-timestamp.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/timestamp") ### timestamp Type @@ -189,7 +189,7 @@ Group various `action_name`'s into logical bins. * cannot be null -* defined in: [Event tracking for UBI](event-properties-message_type.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message_type") +* defined in: [Event tracking for UBI](event-properties-message_type.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message_type") ### message\_type Type @@ -221,7 +221,7 @@ Optional text message for the log entry. For example, for a message\_type of QUE * cannot be null -* defined in: [Event tracking for UBI](event-properties-message.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/message") +* defined in: [Event tracking for UBI](event-properties-message.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/message") ### message Type @@ -243,7 +243,7 @@ Extensible details about a specific event. * cannot be null -* defined in: [Event tracking for UBI](event-properties-event_attributes.md "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json#/properties/event_attributes") +* defined in: [Event tracking for UBI](event-properties-event_attributes.md "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json#/properties/event_attributes") ### event\_attributes Type diff --git a/docs/schema/query-1-properties-client_id.md b/docs/schema/query-1-properties-client_id.md index 939f546..6a2f6d3 100644 --- a/docs/schema/query-1-properties-client_id.md +++ b/docs/schema/query-1-properties-client_id.md @@ -1,14 +1,14 @@ # Untitled string in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/client_id +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/client_id ``` The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## client\_id Type diff --git a/docs/schema/query-1-properties-object_id_field.md b/docs/schema/query-1-properties-object_id_field.md index 3f1c50b..ca5753b 100644 --- a/docs/schema/query-1-properties-object_id_field.md +++ b/docs/schema/query-1-properties-object_id_field.md @@ -1,14 +1,14 @@ # Untitled string in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/object_id_field +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/object_id_field ``` The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## object\_id\_field Type diff --git a/docs/schema/query-1-properties-query_attributes.md b/docs/schema/query-1-properties-query_attributes.md index 81a7184..ff4d753 100644 --- a/docs/schema/query-1-properties-query_attributes.md +++ b/docs/schema/query-1-properties-query_attributes.md @@ -1,14 +1,14 @@ # Untitled object in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_attributes +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_attributes ``` Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## query\_attributes Type diff --git a/docs/schema/query-1-properties-query_id-oneof-0.md b/docs/schema/query-1-properties-query_id-oneof-0.md index 30b025c..3540909 100644 --- a/docs/schema/query-1-properties-query_id-oneof-0.md +++ b/docs/schema/query-1-properties-query_id-oneof-0.md @@ -1,14 +1,14 @@ # Untitled string in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_id/oneOf/0 +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_id/oneOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/query-1-properties-query_id-oneof-1.md b/docs/schema/query-1-properties-query_id-oneof-1.md index 5982147..97c5d0d 100644 --- a/docs/schema/query-1-properties-query_id-oneof-1.md +++ b/docs/schema/query-1-properties-query_id-oneof-1.md @@ -1,14 +1,14 @@ # Untitled string in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_id/oneOf/1 +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_id/oneOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/query-1-properties-query_id.md b/docs/schema/query-1-properties-query_id.md index a7110b6..e8b586e 100644 --- a/docs/schema/query-1-properties-query_id.md +++ b/docs/schema/query-1-properties-query_id.md @@ -1,14 +1,14 @@ # Untitled undefined type in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_id +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_id ``` The unique identifier of a query, typically a UUID, but can be any string. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## query\_id Type diff --git a/docs/schema/query-1-properties-user_query.md b/docs/schema/query-1-properties-user_query.md index ff710a3..1647882 100644 --- a/docs/schema/query-1-properties-user_query.md +++ b/docs/schema/query-1-properties-user_query.md @@ -1,7 +1,7 @@ # Untitled string in Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/user_query +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/user_query ``` The query as the user entered it. No length limit specified. @@ -10,7 +10,7 @@ The query as the user entered it. No length limit specified. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.request.schema.json\*](../../out/1.0.0/query.request.schema.json "open original schema") | ## user\_query Type diff --git a/docs/schema/query-1.md b/docs/schema/query-1.md index 0550c05..27fa0b0 100644 --- a/docs/schema/query-1.md +++ b/docs/schema/query-1.md @@ -1,14 +1,14 @@ # Query Tracking for UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json +https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json ``` -Version X.Y.Z; last updated 2024-05-23. A query made by a user should include these attributes for UBI tracking. +Version 1.0.0; last updated 2024-06-14. A query made by a user should include these attributes for UBI tracking. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [query.request.schema.json](../../out/X.Y.Z/query.request.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [query.request.schema.json](../../out/1.0.0/query.request.schema.json "open original schema") | ## Query Tracking for UBI Type @@ -18,11 +18,11 @@ Version X.Y.Z; last updated 2024-05-23. A query made by a user should include t | Property | Type | Required | Nullable | Defined by | | :------------------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [query\_id](#query_id) | Merged | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_id") | -| [client\_id](#client_id) | `string` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-client_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/client_id") | -| [user\_query](#user_query) | `string` | Required | cannot be null | [Query Tracking for UBI](query-1-properties-user_query.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/user_query") | -| [query\_attributes](#query_attributes) | `object` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-query_attributes.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_attributes") | -| [object\_id\_field](#object_id_field) | `string` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-object_id_field.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/object_id_field") | +| [query\_id](#query_id) | Merged | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_id") | +| [client\_id](#client_id) | `string` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-client_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/client_id") | +| [user\_query](#user_query) | `string` | Required | cannot be null | [Query Tracking for UBI](query-1-properties-user_query.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/user_query") | +| [query\_attributes](#query_attributes) | `object` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-query_attributes.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_attributes") | +| [object\_id\_field](#object_id_field) | `string` | Optional | cannot be null | [Query Tracking for UBI](query-1-properties-object_id_field.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/object_id_field") | ## query\_id @@ -36,7 +36,7 @@ The unique identifier of a query, typically a UUID, but can be any string. * cannot be null -* defined in: [Query Tracking for UBI](query-1-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_id") +* defined in: [Query Tracking for UBI](query-1-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_id") ### query\_id Type @@ -60,7 +60,7 @@ The client issuing the query. This could be a unique browser, a microservice th * cannot be null -* defined in: [Query Tracking for UBI](query-1-properties-client_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/client_id") +* defined in: [Query Tracking for UBI](query-1-properties-client_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/client_id") ### client\_id Type @@ -98,7 +98,7 @@ The query as the user entered it. No length limit specified. * cannot be null -* defined in: [Query Tracking for UBI](query-1-properties-user_query.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/user_query") +* defined in: [Query Tracking for UBI](query-1-properties-user_query.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/user_query") ### user\_query Type @@ -116,7 +116,7 @@ Any query modifiers like filter choices or pagination. Other attributes such as * cannot be null -* defined in: [Query Tracking for UBI](query-1-properties-query_attributes.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/query_attributes") +* defined in: [Query Tracking for UBI](query-1-properties-query_attributes.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/query_attributes") ### query\_attributes Type @@ -134,7 +134,7 @@ The name of the field that has the id of the objects that will be stored in the * cannot be null -* defined in: [Query Tracking for UBI](query-1-properties-object_id_field.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json#/properties/object_id_field") +* defined in: [Query Tracking for UBI](query-1-properties-object_id_field.md "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json#/properties/object_id_field") ### object\_id\_field Type diff --git a/docs/schema/query-properties-query_id-oneof-0.md b/docs/schema/query-properties-query_id-oneof-0.md index c8b095b..80dce2c 100644 --- a/docs/schema/query-properties-query_id-oneof-0.md +++ b/docs/schema/query-properties-query_id-oneof-0.md @@ -1,14 +1,14 @@ # Untitled string in Query Response When Using UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json#/properties/query_id/oneOf/0 +https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json#/properties/query_id/oneOf/0 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/X.Y.Z/query.response.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/1.0.0/query.response.schema.json "open original schema") | ## 0 Type diff --git a/docs/schema/query-properties-query_id-oneof-1.md b/docs/schema/query-properties-query_id-oneof-1.md index 243dd8e..8fac320 100644 --- a/docs/schema/query-properties-query_id-oneof-1.md +++ b/docs/schema/query-properties-query_id-oneof-1.md @@ -1,14 +1,14 @@ # Untitled string in Query Response When Using UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json#/properties/query_id/oneOf/1 +https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json#/properties/query_id/oneOf/1 ``` | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/X.Y.Z/query.response.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/1.0.0/query.response.schema.json "open original schema") | ## 1 Type diff --git a/docs/schema/query-properties-query_id.md b/docs/schema/query-properties-query_id.md index a0ef78e..8b30358 100644 --- a/docs/schema/query-properties-query_id.md +++ b/docs/schema/query-properties-query_id.md @@ -1,14 +1,14 @@ # Untitled undefined type in Query Response When Using UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json#/properties/query_id +https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json#/properties/query_id ``` The unique identifier of a query, typically a UUID, but can be any string. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ | -| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/X.Y.Z/query.response.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [query.response.schema.json\*](../../out/1.0.0/query.response.schema.json "open original schema") | ## query\_id Type diff --git a/docs/schema/query.md b/docs/schema/query.md index fa192cd..24e4b53 100644 --- a/docs/schema/query.md +++ b/docs/schema/query.md @@ -1,14 +1,14 @@ # Query Response When Using UBI Schema ```txt -https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json +https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json ``` -Version X.Y.Z; last updated 2024-05-23. The response to a query made by a user should support this schema. +Version 1.0.0; last updated 2024-06-14. The response to a query made by a user should support this schema. | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | -| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [query.response.schema.json](../../out/X.Y.Z/query.response.schema.json "open original schema") | +| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [query.response.schema.json](../../out/1.0.0/query.response.schema.json "open original schema") | ## Query Response When Using UBI Type @@ -18,7 +18,7 @@ Version X.Y.Z; last updated 2024-05-23. The response to a query made by a user | Property | Type | Required | Nullable | Defined by | | :--------------------- | :----- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [query\_id](#query_id) | Merged | Required | cannot be null | [Query Response When Using UBI](query-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json#/properties/query_id") | +| [query\_id](#query_id) | Merged | Required | cannot be null | [Query Response When Using UBI](query-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json#/properties/query_id") | ## query\_id @@ -32,7 +32,7 @@ The unique identifier of a query, typically a UUID, but can be any string. * cannot be null -* defined in: [Query Response When Using UBI](query-properties-query_id.md "https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json#/properties/query_id") +* defined in: [Query Response When Using UBI](query-properties-query_id.md "https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json#/properties/query_id") ### query\_id Type diff --git a/out/event.schema.json b/out/event.schema.json index 35a37a8..b15639d 100644 --- a/out/event.schema.json +++ b/out/event.schema.json @@ -1 +1 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json","title":"Event tracking for UBI","description":"Version X.Y.Z; last updated 2024-05-23. An event that occurred, typically in response to a user. See [schemas.md](https://github.com/o19s/opensearch-ubi/blob/2.14.0/documentation/schemas.md) and [events-mapping.json](https://github.com/o19s/opensearch-ubi/blob/2.14.0/src/main/resources/events-mapping.json) for more info.","type":"object","required":["action_name","query_id","timestamp"],"properties":{"application":{"description":"name of the application tracking UBI events.","type":"string","maxLength":100,"examples":["amazon-shop","ABC-microservice","doctor-search"]},"action_name":{"description":"The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.","oneOf":[{"type":"string","maxLength":100,"enum":["click_through","add_to_cart","click","watch","view","purchase"]},{"type":"string","maxLength":100}]},"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"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"]},"timestamp":{"description":"When the event took place.","type":"string","format":"date-time","examples":["2018-11-13T20:20:39+00:00"]},"message_type":{"description":"Group various `action_name`'s into logical bins.","type":"string","maxLength":100,"examples":["QUERY","CONVERSION"],"$comment":"TDB: action_type? event_type? Should the front end even define this?"},"message":{"description":"Optional text message for the log entry. For example, for a message_type of QUERY, we would expect the text to be about what the user is searching on.","type":"string","maxLength":1024},"event_attributes":{"description":"Extensible details about a specific event.","type":"object","additionalProperties":true,"required":["position"],"properties":{"object":{"description":"Structure which contains identifying information of the object returned from the query that the user interacts with (i.e.: a book, a product, a post, etc..).","type":"object","additionalProperties":true,"required":["object_id"],"properties":{"object_id":{"description":"The id that a user could look up and find the object instance within the *document corpus*. Examples include: _ssn_, _isbn_, _ean_, etc. Variants need to be incorporated in the `object_id`, so for a t-shirt that is red, you would need SKU level as the `object_id`.","examples":["XYZ-12345","ISBN 0-061-96436-0","123"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100},"internal_id":{"description":"A unique id that the an individual search engine uses internally to index the object via. For example, in OpenSearch, think the `_id` field in the indices.","examples":["1","123456"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]}}},"position":{"description":"Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.","type":"object","additionalProperties":true,"oneOf":[{"type":"object","properties":{"ordinal":{"description":"The nth position of the document on the search results page.","type":"object","properties":{"index":{"description":"The position of the document. For grid layout this would be left to right, ignoring wrapping.","type":"integer","examples":[1,3,24]}},"required":["index"]}},"required":["ordinal"]},{"type":"object","properties":{"xy":{"description":"The x,y coordinates on the screen for triggering an event.","$comment":"What about bounding boxes?","type":"object","properties":{"x":{"description":"The horizontal location on the page or screen of the event.","type":"number"},"y":{"description":"The vertical location on the page or screen of the event.","type":"number"}},"required":["x","y"]}},"required":["xy"]}]}}}}} +{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/event.schema.json","title":"Event tracking for UBI","description":"Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.","type":"object","required":["action_name","query_id","timestamp"],"properties":{"application":{"description":"name of the application tracking UBI events.","type":"string","maxLength":100,"examples":["amazon-shop","ABC-microservice","doctor-search"]},"action_name":{"description":"The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.","oneOf":[{"type":"string","maxLength":100,"enum":["click_through","add_to_cart","click","watch","view","purchase"]},{"type":"string","maxLength":100}]},"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"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"]},"timestamp":{"description":"When the event took place.","type":"string","format":"date-time","examples":["2018-11-13T20:20:39+00:00"]},"message_type":{"description":"Group various `action_name`'s into logical bins.","type":"string","maxLength":100,"examples":["QUERY","CONVERSION"],"$comment":"TDB: action_type? event_type? Should the front end even define this?"},"message":{"description":"Optional text message for the log entry. For example, for a message_type of QUERY, we would expect the text to be about what the user is searching on.","type":"string","maxLength":1024},"event_attributes":{"description":"Extensible details about a specific event.","type":"object","additionalProperties":true,"required":["position"],"properties":{"object":{"description":"Structure which contains identifying information of the object returned from the query that the user interacts with (i.e.: a book, a product, a post, etc..).","type":"object","additionalProperties":true,"required":["object_id"],"properties":{"object_id":{"description":"The id that a user could look up and find the object instance within the *document corpus*. Examples include: _ssn_, _isbn_, _ean_, etc. Variants need to be incorporated in the `object_id`, so for a t-shirt that is red, you would need SKU level as the `object_id`.","examples":["XYZ-12345","ISBN 0-061-96436-0","123"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100},"internal_id":{"description":"A unique id that the an individual search engine uses internally to index the object via. For example, in OpenSearch, think the `_id` field in the indices.","examples":["1","123456"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]}}},"position":{"description":"Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.","type":"object","additionalProperties":true,"oneOf":[{"type":"object","properties":{"ordinal":{"description":"The nth position of the document on the search results page.","type":"object","properties":{"index":{"description":"The position of the document. For grid layout this would be left to right, ignoring wrapping.","type":"integer","examples":[1,3,24]}},"required":["index"]}},"required":["ordinal"]},{"type":"object","properties":{"xy":{"description":"The x,y coordinates on the screen for triggering an event.","$comment":"What about bounding boxes?","type":"object","properties":{"x":{"description":"The horizontal location on the page or screen of the event.","type":"number"},"y":{"description":"The vertical location on the page or screen of the event.","type":"number"}},"required":["x","y"]}},"required":["xy"]}]}}}}} diff --git a/out/query.request.schema.json b/out/query.request.schema.json index b7926a1..a29e3ea 100644 --- a/out/query.request.schema.json +++ b/out/query.request.schema.json @@ -1 +1 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json","title":"Query Tracking for UBI","description":"Version X.Y.Z; last updated 2024-05-23. A query made by a user should include these attributes for UBI tracking.","type":"object","required":["user_query"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"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"]},"user_query":{"description":"The query as the user entered it. No length limit specified.","type":"string","$comment":"Currently not required to support recommendation systems etc that might not have a user generated query."},"query_attributes":{"description":"Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.","type":"object","additionalProperties":true},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100}}} +{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json","title":"Query Tracking for UBI","description":"Version 1.0.0; last updated 2024-06-14. A query made by a user should include these attributes for UBI tracking.","type":"object","required":["user_query"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"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"]},"user_query":{"description":"The query as the user entered it. No length limit specified.","type":"string","$comment":"Currently not required to support recommendation systems etc that might not have a user generated query."},"query_attributes":{"description":"Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.","type":"object","additionalProperties":true},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100}}} diff --git a/out/query.response.schema.json b/out/query.response.schema.json index 391caa3..8034dd8 100644 --- a/out/query.response.schema.json +++ b/out/query.response.schema.json @@ -1 +1 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json","title":"Query Response When Using UBI","description":"Version X.Y.Z; last updated 2024-05-23. The response to a query made by a user should support this schema.","type":"object","required":["query_id"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]}}} +{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json","title":"Query Response When Using UBI","description":"Version 1.0.0; last updated 2024-06-14. The response to a query made by a user should support this schema.","type":"object","required":["query_id"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]}}} diff --git a/schema/X.Y.Z/event.schema.json b/schema/1.0.0/event.schema.json similarity index 94% rename from schema/X.Y.Z/event.schema.json rename to schema/1.0.0/event.schema.json index 2c4ff59..e111c98 100644 --- a/schema/X.Y.Z/event.schema.json +++ b/schema/1.0.0/event.schema.json @@ -1,8 +1,8 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://o19s.github.io/ubi/schema/X.Y.Z/event.schema.json", + "$id": "https://o19s.github.io/ubi/schema/1.0.0/event.schema.json", "title": "Event tracking for UBI", - "description": "Version X.Y.Z; last updated 2024-05-23. An event that occurred, typically in response to a user. See [schemas.md](https://github.com/o19s/opensearch-ubi/blob/2.14.0/documentation/schemas.md) and [events-mapping.json](https://github.com/o19s/opensearch-ubi/blob/2.14.0/src/main/resources/events-mapping.json) for more info.", + "description": "Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.", "type": "object", "required": ["action_name", "query_id", "timestamp"], "properties": { diff --git a/schema/X.Y.Z/query.request.schema.json b/schema/1.0.0/query.request.schema.json similarity index 94% rename from schema/X.Y.Z/query.request.schema.json rename to schema/1.0.0/query.request.schema.json index 585d0c1..a8876d6 100644 --- a/schema/X.Y.Z/query.request.schema.json +++ b/schema/1.0.0/query.request.schema.json @@ -1,8 +1,8 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://o19s.github.io/ubi/schema/X.Y.Z/query.request.schema.json", + "$id": "https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json", "title": "Query Tracking for UBI", - "description": "Version X.Y.Z; last updated 2024-05-23. A query made by a user should include these attributes for UBI tracking.", + "description": "Version 1.0.0; last updated 2024-06-14. A query made by a user should include these attributes for UBI tracking.", "type": "object", "required": [ "user_query" ], "properties": { diff --git a/schema/X.Y.Z/query.response.schema.json b/schema/1.0.0/query.response.schema.json similarity index 83% rename from schema/X.Y.Z/query.response.schema.json rename to schema/1.0.0/query.response.schema.json index 2df52d1..af1e361 100644 --- a/schema/X.Y.Z/query.response.schema.json +++ b/schema/1.0.0/query.response.schema.json @@ -1,8 +1,8 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://o19s.github.io/ubi/schema/X.Y.Z/query.response.schema.json", + "$id": "https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json", "title": "Query Response When Using UBI", - "description": "Version X.Y.Z; last updated 2024-05-23. The response to a query made by a user should support this schema.", + "description": "Version 1.0.0; last updated 2024-06-14. The response to a query made by a user should support this schema.", "type": "object", "required": [ "query_id" ], "properties": {