See open-metadata/OpenMetadata@69342d4 from refs/heads/main

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/basic.md

@@ -9,11 +9,11 @@ slug: /main-concepts/metadata-standard/schemas/analytics/basic
 
 ## Definitions
 
-- **`webAnalyticEventType`** *(string)*: event type. Must be one of: `['PageView', 'CustomEvent']`.
+- **`webAnalyticEventType`** *(string)*: event type. Must be one of: `["PageView", "CustomEvent"]`.
 - **`fullUrl`** *(string)*: complete URL of the page.
 - **`url`** *(string)*: url part after the domain specification.
 - **`hostname`** *(string)*: domain name.
-- **`sessionId`**: Unique ID identifying a session. Refer to *../type/basic.json#/definitions/uuid*.
+- **`sessionId`**: Unique ID identifying a session. Refer to *[../type/basic.json#/definitions/uuid](#/type/basic.json#/definitions/uuid)*.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/index.md

@@ -5,4 +5,14 @@ slug: /main-concepts/metadata-standard/schemas/analytics
 
 # Analytics
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+This folder contains the following items:
+
+- [**ReportDataType**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype)
+- [**WebAnalyticEventType**](/main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype)
+- [**ReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdata)
+- [**WebAnalyticEventData**](/main-concepts/metadata-standard/schemas/analytics/webanalyticeventdata)
+- [**WebAnalyticEvent**](/main-concepts/metadata-standard/schemas/analytics/webanalyticevent)
+- [**Basic**](/main-concepts/metadata-standard/schemas/analytics/basic)
+
+
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportData.md

@@ -9,10 +9,16 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdata
 
 ## Properties
 
-- **`id`**: Unique identifier for a result. Refer to *../type/basic.json#/definitions/uuid*.
-- **`timestamp`**: timestamp for of a result ingestion. Refer to *../type/basic.json#/definitions/timestamp*.
-- **`reportDataType`** *(string)*: Type of data. Must be one of: `['entityReportData', 'webAnalyticUserActivityReportData', 'webAnalyticEntityViewReportData', 'rawCostAnalysisReportData', 'aggregatedCostAnalysisReportData']`.
+- **`id`**: Unique identifier for a result. Refer to *[../type/basic.json#/definitions/uuid](#/type/basic.json#/definitions/uuid)*.
+- **`timestamp`**: timestamp for of a result ingestion. Refer to *[../type/basic.json#/definitions/timestamp](#/type/basic.json#/definitions/timestamp)*.
+- **`reportDataType`** *(string)*: Type of data. Must be one of: `["entityReportData", "webAnalyticUserActivityReportData", "webAnalyticEntityViewReportData", "rawCostAnalysisReportData", "aggregatedCostAnalysisReportData"]`.
 - **`data`**: Data captured.
+  - **One of**
+    - : Refer to *[reportDataType/entityReportData.json](#portDataType/entityReportData.json)*.
+    - : Refer to *[reportDataType/webAnalyticUserActivityReportData.json](#portDataType/webAnalyticUserActivityReportData.json)*.
+    - : Refer to *[reportDataType/webAnalyticEntityViewReportData.json](#portDataType/webAnalyticEntityViewReportData.json)*.
+    - : Refer to *[reportDataType/rawCostAnalysisReportData.json](#portDataType/rawCostAnalysisReportData.json)*.
+    - : Refer to *[reportDataType/aggregatedCostAnalysisReportData.json](#portDataType/aggregatedCostAnalysisReportData.json)*.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/aggregatedCostAnalysisReportData.md

@@ -9,8 +9,8 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/aggregat
 
 ## Properties
 
-- **`unusedDataAssets`**: Count and Size of the unused Data Assets over a period of time. Refer to *#/definitions/dataAssetMetrics*.
-- **`frequentlyUsedDataAssets`**: Count and Size of the frequently used Data Assets over a period of time. Refer to *#/definitions/dataAssetMetrics*.
+- **`unusedDataAssets`**: Count and Size of the unused Data Assets over a period of time. Refer to *[#/definitions/dataAssetMetrics](#definitions/dataAssetMetrics)*.
+- **`frequentlyUsedDataAssets`**: Count and Size of the frequently used Data Assets over a period of time. Refer to *[#/definitions/dataAssetMetrics](#definitions/dataAssetMetrics)*.
 - **`totalSize`** *(number)*: Total Size based in Bytes.
 - **`totalCount`** *(number)*: Total Count.
 - **`serviceName`** *(string)*: Name of the service.
@@ -20,16 +20,31 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/aggregat
 ## Definitions
 
 - **`dataAssetValues`** *(object)*: Count or Size in bytes of Data Assets over a time period. Cannot contain additional properties.
-  - **`threeDays`** *(number)*: Data Asset Count or Size for 3 days.
-  - **`sevenDays`** *(number)*: Data Asset Count or Size for 7 days.
-  - **`fourteenDays`** *(number)*: Data Asset Count or Size for 14 days.
-  - **`thirtyDays`** *(number)*: Data Asset Count or Size for 30 days.
-  - **`sixtyDays`** *(number)*: Data Asset Count or Size for 60 days.
+  - **`threeDays`**: Data Asset Count or Size for 3 days.
+    - **Any of**
+      - *number*
+      - *null*
+  - **`sevenDays`**: Data Asset Count or Size for 7 days.
+    - **Any of**
+      - *number*
+      - *null*
+  - **`fourteenDays`**: Data Asset Count or Size for 14 days.
+    - **Any of**
+      - *number*
+      - *null*
+  - **`thirtyDays`**: Data Asset Count or Size for 30 days.
+    - **Any of**
+      - *number*
+      - *null*
+  - **`sixtyDays`**: Data Asset Count or Size for 60 days.
+    - **Any of**
+      - *number*
+      - *null*
 - **`dataAssetMetrics`** *(object)*: Store the Count and Size in bytes of the Data Assets over a time period.
-  - **`size`**: Size of the Data Assets over a period of time. Refer to *#/definitions/dataAssetValues*.
-  - **`count`**: Count of the Data Assets over a period of time. Refer to *#/definitions/dataAssetValues*.
+  - **`size`**: Size of the Data Assets over a period of time. Refer to *[#/definitions/dataAssetValues](#definitions/dataAssetValues)*.
+  - **`count`**: Count of the Data Assets over a period of time. Refer to *[#/definitions/dataAssetValues](#definitions/dataAssetValues)*.
   - **`totalSize`** *(number)*: Total Size based in Bytes.
   - **`totalCount`** *(number)*: Total Count.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/entityReportData.md

@@ -21,4 +21,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/entityre
 - **`entityCount`** *(integer)*: number of entities.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/index.md

@@ -5,4 +5,13 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype
 
 # ReportDataType
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+This folder contains the following items:
+
+- [**WebAnalyticEntityViewReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanalyticentityviewreportdata)
+- [**WebAnalyticUserActivityReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanalyticuseractivityreportdata)
+- [**EntityReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype/entityreportdata)
+- [**AggregatedCostAnalysisReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype/aggregatedcostanalysisreportdata)
+- [**RawCostAnalysisReportData**](/main-concepts/metadata-standard/schemas/analytics/reportdatatype/rawcostanalysisreportdata)
+
+
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/rawCostAnalysisReportData.md

@@ -9,9 +9,9 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/rawcosta
 
 ## Properties
 
-- **`entity`**: Entity of the life cycle data. Refer to *../../type/entityReference.json*.
-- **`lifeCycle`**: Life Cycle data related to the entity. Refer to *../../type/lifeCycle.json*.
+- **`entity`**: Entity of the life cycle data. Refer to *[../../type/entityReference.json](#/../type/entityReference.json)*.
+- **`lifeCycle`**: Life Cycle data related to the entity. Refer to *[../../type/lifeCycle.json](#/../type/lifeCycle.json)*.
 - **`sizeInByte`** *(number)*: Entity size in bytes.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/webAnalyticEntityViewReportData.md

@@ -11,13 +11,13 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanaly
 
 - **`entityType`** *(string)*: entity type.
 - **`entityTier`** *(string)*: entity tier.
-- **`entityFqn`**: entity fully qualified name. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
+- **`entityFqn`**: entity fully qualified name. Refer to *[../../type/basic.json#/definitions/fullyQualifiedEntityName](#/../type/basic.json#/definitions/fullyQualifiedEntityName)*.
 - **`entityHref`** *(string)*: entity href.
 - **`tagsFQN`** *(array)*: Tags FQN.
-  - **Items**: Refer to *../../type/tagLabel.json#/definitions/tagFQN*.
+  - **Items**: Refer to *[../../type/tagLabel.json#/definitions/tagFQN](#/../type/tagLabel.json#/definitions/tagFQN)*.
 - **`owner`** *(string)*: Name of the entity owner.
 - **`ownerId`** *(string)*: Name of the entity owner.
 - **`views`** *(integer)*: Number of time the entity was viewed.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/reportDataType/webAnalyticUserActivityReportData.md

@@ -10,12 +10,12 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanaly
 ## Properties
 
 - **`userName`** *(string)*: user name.
-- **`userId`**: user ID in OM. Refer to *../../type/basic.json#/definitions/uuid*.
+- **`userId`**: user ID in OM. Refer to *[../../type/basic.json#/definitions/uuid](#/../type/basic.json#/definitions/uuid)*.
 - **`team`** *(string)*: the team the user belongs to.
 - **`totalSessions`** *(integer)*: total number of sessions.
 - **`totalSessionDuration`** *(integer)*: total user count.
 - **`totalPageView`** *(integer)*: total user count.
-- **`lastSession`**: latest session. Refer to *../../type/basic.json#/definitions/timestamp*.
+- **`lastSession`**: latest session. Refer to *[../../type/basic.json#/definitions/timestamp](#/../type/basic.json#/definitions/timestamp)*.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/webAnalyticEvent.md

@@ -9,20 +9,21 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticevent
 
 ## Properties
 
-- **`id`**: Unique identifier of the report. Refer to *../type/basic.json#/definitions/uuid*.
-- **`name`**: Name that identifies this event. Refer to *../type/basic.json#/definitions/entityName*.
-- **`fullyQualifiedName`**: FullyQualifiedName same as `name`. Refer to *../type/basic.json#/definitions/fullyQualifiedEntityName*.
+- **`id`**: Unique identifier of the report. Refer to *[../type/basic.json#/definitions/uuid](#/type/basic.json#/definitions/uuid)*.
+- **`name`**: Name that identifies this event. Refer to *[../type/basic.json#/definitions/entityName](#/type/basic.json#/definitions/entityName)*.
+- **`fullyQualifiedName`**: FullyQualifiedName same as `name`. Refer to *[../type/basic.json#/definitions/fullyQualifiedEntityName](#/type/basic.json#/definitions/fullyQualifiedEntityName)*.
 - **`displayName`** *(string)*: Display Name that identifies this web analytics event.
-- **`description`**: Description of the event. Refer to *../type/basic.json#/definitions/markdown*.
-- **`eventType`**: event type. Refer to *./basic.json#/definitions/webAnalyticEventType*.
-- **`version`**: Metadata version of the entity. Refer to *../type/entityHistory.json#/definitions/entityVersion*.
-- **`owner`**: Owner of this report. Refer to *../type/entityReference.json*. Default: `None`.
-- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../type/basic.json#/definitions/timestamp*.
+- **`description`**: Description of the event. Refer to *[../type/basic.json#/definitions/markdown](#/type/basic.json#/definitions/markdown)*.
+- **`eventType`**: event type. Refer to *[./basic.json#/definitions/webAnalyticEventType](#basic.json#/definitions/webAnalyticEventType)*.
+- **`version`**: Metadata version of the entity. Refer to *[../type/entityHistory.json#/definitions/entityVersion](#/type/entityHistory.json#/definitions/entityVersion)*.
+- **`owners`**: Owners of this report. Refer to *[../type/entityReferenceList.json](#/type/entityReferenceList.json)*. Default: `null`.
+- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *[../type/basic.json#/definitions/timestamp](#/type/basic.json#/definitions/timestamp)*.
 - **`updatedBy`** *(string)*: User who performed the update.
-- **`href`**: Link to the resource corresponding to this entity. Refer to *../type/basic.json#/definitions/href*.
-- **`changeDescription`**: Change that lead to this version of the entity. Refer to *../type/entityHistory.json#/definitions/changeDescription*.
-- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `False`.
-- **`enabled`** *(boolean)*: Weather the event is enable (i.e. data is being collected). Default: `True`.
+- **`href`**: Link to the resource corresponding to this entity. Refer to *[../type/basic.json#/definitions/href](#/type/basic.json#/definitions/href)*.
+- **`changeDescription`**: Change that lead to this version of the entity. Refer to *[../type/entityHistory.json#/definitions/changeDescription](#/type/entityHistory.json#/definitions/changeDescription)*.
+- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `false`.
+- **`enabled`** *(boolean)*: Weather the event is enable (i.e. data is being collected). Default: `true`.
+- **`domain`**: Domain the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to. Refer to *[../type/entityReference.json](#/type/entityReference.json)*.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/webAnalyticEventData.md

@@ -9,10 +9,13 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventdata
 
 ## Properties
 
-- **`eventId`**: Unique identifier of the report. Refer to *../type/basic.json#/definitions/uuid*.
-- **`timestamp`**: event timestamp. Refer to *../type/basic.json#/definitions/timestamp*.
-- **`eventType`**: event type. Refer to *./basic.json#/definitions/webAnalyticEventType*.
+- **`eventId`**: Unique identifier of the report. Refer to *[../type/basic.json#/definitions/uuid](#/type/basic.json#/definitions/uuid)*.
+- **`timestamp`**: event timestamp. Refer to *[../type/basic.json#/definitions/timestamp](#/type/basic.json#/definitions/timestamp)*.
+- **`eventType`**: event type. Refer to *[./basic.json#/definitions/webAnalyticEventType](#basic.json#/definitions/webAnalyticEventType)*.
 - **`eventData`**: Web analytic data captured.
+  - **One of**
+    - : Refer to *[webAnalyticEventType/pageViewEvent.json](#bAnalyticEventType/pageViewEvent.json)*.
+    - : Refer to *[webAnalyticEventType/customEvent.json](#bAnalyticEventType/customEvent.json)*.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/webAnalyticEventType/customEvent.md

@@ -9,15 +9,15 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/cu
 
 ## Properties
 
-- **`fullUrl`**: complete URL of the page. Refer to *../basic.json#/definitions/fullUrl*.
-- **`url`**: url part after the domain specification. Refer to *../basic.json#/definitions/url*.
-- **`hostname`**: domain name. Refer to *../basic.json#/definitions/hostname*.
-- **`sessionId`**: Unique ID identifying a session. Refer to *../basic.json#/definitions/sessionId*.
-- **`eventType`**: Type of event that was performed. Refer to *#/definitions/customEventTypes*.
+- **`fullUrl`**: complete URL of the page. Refer to *[../basic.json#/definitions/fullUrl](#/basic.json#/definitions/fullUrl)*.
+- **`url`**: url part after the domain specification. Refer to *[../basic.json#/definitions/url](#/basic.json#/definitions/url)*.
+- **`hostname`**: domain name. Refer to *[../basic.json#/definitions/hostname](#/basic.json#/definitions/hostname)*.
+- **`sessionId`**: Unique ID identifying a session. Refer to *[../basic.json#/definitions/sessionId](#/basic.json#/definitions/sessionId)*.
+- **`eventType`**: Type of event that was performed. Refer to *[#/definitions/customEventTypes](#definitions/customEventTypes)*.
 - **`eventValue`** *(string)*: Value of the event.
 ## Definitions
 
-- **`customEventTypes`** *(string)*: Type of events that can be performed. Must be one of: `['CLICK']`.
+- **`customEventTypes`** *(string)*: Type of events that can be performed. Must be one of: `["CLICK"]`.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/webAnalyticEventType/index.md

@@ -5,4 +5,10 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype
 
 # WebAnalyticEventType
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+This folder contains the following items:
+
+- [**CustomEvent**](/main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/customevent)
+- [**PageViewEvent**](/main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/pageviewevent)
+
+
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.

content/v1.6.x/main-concepts/metadata-standard/schemas/analytics/webAnalyticEventType/pageViewEvent.md

@@ -9,15 +9,15 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/pa
 
 ## Properties
 
-- **`fullUrl`**: complete URL of the page. Refer to *../basic.json#/definitions/fullUrl*.
-- **`url`**: url part after the domain specification. Refer to *../basic.json#/definitions/url*.
-- **`hostname`**: domain name. Refer to *../basic.json#/definitions/hostname*.
+- **`fullUrl`**: complete URL of the page. Refer to *[../basic.json#/definitions/fullUrl](#/basic.json#/definitions/fullUrl)*.
+- **`url`**: url part after the domain specification. Refer to *[../basic.json#/definitions/url](#/basic.json#/definitions/url)*.
+- **`hostname`**: domain name. Refer to *[../basic.json#/definitions/hostname](#/basic.json#/definitions/hostname)*.
 - **`language`** *(string)*: language set on the page.
 - **`screenSize`** *(string)*: Size of the screen.
-- **`userId`**: OpenMetadata logged in user Id. Refer to *../../type/basic.json#/definitions/uuid*.
-- **`sessionId`**: Unique ID identifying a session. Refer to *../basic.json#/definitions/sessionId*.
+- **`userId`**: OpenMetadata logged in user Id. Refer to *[../../type/basic.json#/definitions/uuid](#/../type/basic.json#/definitions/uuid)*.
+- **`sessionId`**: Unique ID identifying a session. Refer to *[../basic.json#/definitions/sessionId](#/basic.json#/definitions/sessionId)*.
 - **`pageLoadTime`** *(number)*: time for the page to load in seconds.
 - **`referrer`** *(string)*: referrer URL.
 
 
-Documentation file automatically generated at 2023-10-27 13:55:46.343512.
+Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.