Skip to content

Commit

Permalink
chore(docs): updated the metadata standard schemas and menu.md for …
Browse files Browse the repository at this point in the history
…documentation (#13745)

* updated the metadata standard schemas and menu.md

* updated the schema docs with better parsing
  • Loading branch information
aniketkatkar97 authored Oct 27, 2023
1 parent ec5a35c commit 9e773ff
Show file tree
Hide file tree
Showing 460 changed files with 2,092 additions and 548 deletions.
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,9 @@ build-ingestion-base-local: ## Builds the ingestion DEV docker operator with th
.PHONY: generate-schema-docs
generate-schema-docs: ## Generates markdown files for documenting the JSON Schemas
@echo "Generating Schema docs"
python -m pip install "jsonschema2md"
python scripts/generate_docs_schemas.py
# Installing "0.4.0" version for simpler formatting
python3 -m pip install "jsonschema2md==0.4.0"
python3 scripts/generate_docs_schemas.py

#Upgrade release automation scripts below
.PHONY: update_all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/basic
- **`sessionId`**: Unique ID identifying a session. Refer to *../type/basic.json#/definitions/uuid*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics

# Analytics

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdata

- **`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']`.
- **`reportDataType`** *(string)*: Type of data. Must be one of: `['entityReportData', 'webAnalyticUserActivityReportData', 'webAnalyticEntityViewReportData', 'rawCostAnalysisReportData', 'aggregatedCostAnalysisReportData']`.
- **`data`**: Data captured.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: aggregatedCostAnalysisReportData
slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/aggregatedcostanalysisreportdata
---

# aggregatedCostAnalysisReportData

*Aggregated data for Cost Analysis Report.*

## 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*.
- **`totalSize`** *(number)*: Total Size based in Bytes.
- **`totalCount`** *(number)*: Total Count.
- **`serviceName`** *(string)*: Name of the service.
- **`serviceType`** *(string)*: Type of the service.
- **`entityType`** *(string)*: Type of the entity.
- **`serviceOwner`** *(string)*: Name of the service owner.
## 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.
- **`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*.
- **`totalSize`** *(number)*: Total Size based in Bytes.
- **`totalCount`** *(number)*: Total Count.


Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/entityre

## Properties

- **`serviceName`** *(string)*: Name of the service.
- **`entityType`** *(string)*: type of the entity.
- **`entityTier`** *(string)*: Tier for the entity.
- **`team`** *(string)*: Team associated with the entity (i.e. owner).
Expand All @@ -20,4 +21,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/entityre
- **`entityCount`** *(integer)*: number of entities.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype

# ReportDataType

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: rawCostAnalysisReportData
slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/rawcostanalysisreportdata
---

# rawCostAnalysisReportData

*Raw data for Cost Analysis Report.*

## 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*.
- **`sizeInByte`** *(number)*: Entity size in bytes.


Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanaly
- **`views`** *(integer)*: Number of time the entity was viewed.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/reportdatatype/webanaly
- **`lastSession`**: latest session. Refer to *../../type/basic.json#/definitions/timestamp*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticevent
- **`enabled`** *(boolean)*: Weather the event is enable (i.e. data is being collected). Default: `True`.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventdata
- **`eventData`**: Web analytic data captured.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/cu
- **`customEventTypes`** *(string)*: Type of events that can be performed. Must be one of: `['CLICK']`.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype

# WebAnalyticEventType

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ slug: /main-concepts/metadata-standard/schemas/analytics/webanalyticeventtype/pa
- **`referrer`** *(string)*: referrer URL.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ slug: /main-concepts/metadata-standard/schemas/api/analytics/createwebanalyticev
- **`owner`**: Owner of this report definition. Refer to *../../type/entityReference.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/api/analytics

# Analytics

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ slug: /main-concepts/metadata-standard/schemas/api/automations/createworkflow
- **`owner`**: Owner of this workflow. Refer to *../../type/entityReference.json*. Default: `None`.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/api/automations

# Automations

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ slug: /main-concepts/metadata-standard/schemas/api/classification/createclassifi
- **`mutuallyExclusive`** *(boolean)*: Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity can be in multiple categories simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously. Default: `false`.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ slug: /main-concepts/metadata-standard/schemas/api/classification/createtag

## Properties

- **`classification`**: Name of the classification that this tag is part of. Refer to *../../entity/classification/tag.json#/definitions/tagName*.
- **`classification`**: Name of the classification that this tag is part of. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`parent`**: Fully qualified name of the parent tag. When null, the term is at the root of the classification. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`name`**: Refer to *../../entity/classification/tag.json#/definitions/tagName*.
- **`displayName`** *(string)*: Display Name that identifies this tag.
- **`description`**: Unique name of the classification. Refer to *../../type/basic.json#/definitions/markdown*.
- **`style`**: Refer to *../../type/basic.json#/definitions/style*.
- **`associatedTags`** *(array)*: Fully qualified names of tags associated with this tag.
- **Items** *(string)*
- **`provider`**: Refer to *../../type/basic.json#/definitions/providerType*.
- **`mutuallyExclusive`** *(boolean)*: Children tags under this group are mutually exclusive. When mutually exclusive is `true` the tags from this group are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this group are used to **categorize** an entity. An entity can be in multiple categories simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously. Default: `false`.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ slug: /main-concepts/metadata-standard/schemas/api/classification

# Classification

Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ slug: /main-concepts/metadata-standard/schemas/api/classification/loadtags
- **Items**: Refer to *createTag.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ slug: /main-concepts/metadata-standard/schemas/api/createbot
- **`provider`**: Refer to *../type/basic.json#/definitions/providerType*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ slug: /main-concepts/metadata-standard/schemas/api/createeventpublisherjob
- **`afterCursor`** *(string)*: Provide After in case of failure to start reindexing after the issue is solved.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ slug: /main-concepts/metadata-standard/schemas/api/createtype
- **`schema`**: JSON schema encoded as string. This will be used to validate the type values. Refer to *../type/basic.json#/definitions/jsonSchema*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createchart
- **`domain`**: Fully qualified name of the domain the Chart belongs to. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`dataProducts`** *(array)*: List of fully qualified names of data products this entity is part of.
- **Items**: Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createcontainer
- **`tags`** *(array)*: Tags for this Container Model. Default: `None`.
- **Items**: Refer to *../../type/tagLabel.json*.
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
- **`sourceUrl`**: Source URL of container. Refer to *../../type/basic.json#/definitions/sourceUrl*.
- **`domain`** *(string)*: Fully qualified name of the domain the Container belongs to.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createdashboard
- **`domain`**: Fully qualified name of the domain the Dashboard belongs to. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`dataProducts`** *(array)*: List of fully qualified names of data products this entity is part of.
- **Items**: Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createdashboarddatamodel
- **Items**: Refer to *../../entity/data/table.json#/definitions/column*.
- **`project`** *(string)*: Name of the project / workspace / collection in which the dataModel is contained.
- **`domain`** *(string)*: Fully qualified name of the domain the Dashboard Data Model belongs to.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createdatabase
- **`default`** *(boolean)*: Some databases don't support a database/catalog in the hierarchy and use default database. For example, `MySql`. For such databases, set this flag to true to indicate that this is a default database. Default: `False`.
- **`retentionPeriod`**: Retention period of the data in the database. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`. Refer to *../../type/basic.json#/definitions/duration*.
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
- **`sourceUrl`**: Source URL of database. Refer to *../../type/basic.json#/definitions/sourceUrl*.
- **`domain`** *(string)*: Fully qualified name of the domain the Database belongs to.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createdatabaseschema
- **Items**: Refer to *../../type/tagLabel.json*.
- **`retentionPeriod`**: Retention period of the data in the database. Period is expressed as duration in ISO 8601 format in UTC. Example - `P23DT23H`. Refer to *../../type/basic.json#/definitions/duration*.
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
- **`sourceUrl`**: Source URL of database schema. Refer to *../../type/basic.json#/definitions/sourceUrl*.
- **`domain`** *(string)*: Fully qualified name of the domain the Database Schema belongs to.
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createglossary
- **`provider`**: Refer to *../../type/basic.json#/definitions/providerType*.
- **`mutuallyExclusive`** *(boolean)*: Glossary terms that are direct children in this glossary are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity. Default: `false`.
- **`domain`** *(string)*: Fully qualified name of the domain the Glossary belongs to.
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createglossaryterm
- **`name`**: Preferred name for the glossary term. Refer to *../../type/basic.json#/definitions/entityName*.
- **`displayName`** *(string)*: Display Name that identifies this glossary term.
- **`description`**: Description of the glossary term. Refer to *../../type/basic.json#/definitions/markdown*.
- **`style`**: Refer to *../../type/basic.json#/definitions/style*.
- **`synonyms`** *(array)*: Alternate names that are synonyms or near-synonyms for the glossary term.
- **Items**: Refer to *../../type/basic.json#/definitions/entityName*.
- **`relatedTerms`** *(array)*: Other array of glossary term fully qualified names that are related to this glossary term.
Expand All @@ -27,6 +28,7 @@ slug: /main-concepts/metadata-standard/schemas/api/data/createglossaryterm
- **Items**: Refer to *../../type/tagLabel.json*.
- **`provider`**: Refer to *../../type/basic.json#/definitions/providerType*.
- **`mutuallyExclusive`** *(boolean)*: Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is `true` only one term can be used to label an entity from this group. When mutually exclusive is `false`, multiple terms from this group can be used to label an entity. Default: `false`.
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.


Documentation file automatically generated at 2023-07-07 05:50:35.981927.
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
Loading

0 comments on commit 9e773ff

Please sign in to comment.