diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json
index c4b5f961d02..b60b3206c3b 100644
--- a/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json
@@ -309,7 +309,7 @@
"$ref": "../../type/entityReference.json"
},
"viewDefinition": {
- "description": "View Definition in SQL. Applies to TableType.View only",
+ "description": "View Definition in SQL. Applies to TableType.View only.",
"$ref": "../../type/basic.json#/definitions/sqlQuery"
},
"tags": {
diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json
index 81a540a94ba..f7160476b7c 100644
--- a/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json
@@ -2,7 +2,7 @@
"$id": "https://open-metadata.org/schema/entity/data/topic.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Topic",
- "description": "This schema defines the Topic entity. A topic is a feed into which message are published to by publishers and read from by consumers in a messaging service",
+ "description": "This schema defines the Topic entity. A topic is a feed into which message are published to by publishers and read from by consumers in a messaging service.",
"type": "object",
"definitions": {
"topicName": {
diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json
index 94fc1b299c2..de45530b99d 100644
--- a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json
@@ -78,7 +78,7 @@
"$ref": "../../type/basic.json#/definitions/href"
},
"jdbc": {
- "description": "JDBC connection information",
+ "description": "JDBC connection information.",
"$ref": "../../type/jdbcConnection.json#/definitions/jdbcInfo"
},
"ingestionSchedule": {
diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json
index 12f82d52db0..c606b0a40c7 100644
--- a/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json
@@ -6,7 +6,7 @@
"type": "object",
"definitions": {
"messagingServiceType": {
- "description": "Type of messaging service - Kafka or Pulsar",
+ "description": "Type of messaging service - Kafka or Pulsar.",
"type": "string",
"enum": [
"Kafka",
@@ -54,7 +54,7 @@
"$ref" : "#/definitions/brokers"
},
"schemaRegistry" : {
- "description": "Schema registry URL",
+ "description": "Schema registry URL.",
"type": "string",
"format": "uri"
},
diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json b/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json
index e4565d0392f..57c465a72aa 100644
--- a/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json
@@ -22,11 +22,11 @@
"javaEnums": [
{
"name": "Descriptive",
- "description": "Tag category used for describing an entity. Example - column is of of type User.Addres.s"
+ "description": "Tag category used for describing an entity. Example - column is of of type User.Address."
},
{
"name": "Classification",
- "description": "Tag category used for classifying an entity. Example - column is of of type PII.sensitiv.e"
+ "description": "Tag category used for classifying an entity. Example - column is of of type PII.sensitive."
}
]
},
@@ -34,7 +34,7 @@
"javaType": "org.openmetadata.catalog.type.Tag",
"properties": {
"name": {
- "description" : "Name of the tag",
+ "description" : "Name of the tag.",
"$ref": "#/definitions/tagName"
},
"fullyQualifiedName": {
diff --git a/catalog-rest-service/src/main/resources/json/schema/type/basic.json b/catalog-rest-service/src/main/resources/json/schema/type/basic.json
index 0daeaf6db8e..dbd030002a9 100644
--- a/catalog-rest-service/src/main/resources/json/schema/type/basic.json
+++ b/catalog-rest-service/src/main/resources/json/schema/type/basic.json
@@ -23,7 +23,7 @@
"pattern": "^<#E/\\S+/\\S+>$"
},
"timestamp": {
- "description": "Timestamp in unixTimeMillis",
+ "description": "Timestamp in unixTimeMillis.",
"type": "string",
"format": "utc-millisec"
},
diff --git a/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json b/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json
index ebf5a166ba7..b135150ee15 100644
--- a/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json
+++ b/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json
@@ -7,11 +7,11 @@
"definitions": {
"driverClass": {
- "description": "Type used for JDBC driver class",
+ "description": "Type used for JDBC driver class.",
"type": "string"
},
"connectionUrl": {
- "description": "Type used for JDBC connection URL",
+ "description": "Type used for JDBC connection URL.",
"type": "string",
"format": "uri"
},
@@ -19,7 +19,7 @@
"jdbcInfo": {
"type": "object",
"javaType": "org.openmetadata.catalog.type.JdbcInfo",
- "description": "Type for capturing JDBC connector information",
+ "description": "Type for capturing JDBC connector information.",
"properties": {
"driverClass": {
"$ref" : "#/definitions/driverClass"
@@ -37,11 +37,11 @@
"properties": {
"driverClass": {
- "description": "JDBC driver class",
+ "description": "JDBC driver class.",
"$ref" : "#/definitions/driverClass"
},
"connectionUrl": {
- "description": "JDBC connection URL",
+ "description": "JDBC connection URL.",
"$ref" : "#/definitions/connectionUrl"
},
"userName": {
diff --git a/catalog-rest-service/src/main/resources/json/schema/type/schedule.json b/catalog-rest-service/src/main/resources/json/schema/type/schedule.json
index b7dfef3fc35..a3b3606d361 100644
--- a/catalog-rest-service/src/main/resources/json/schema/type/schedule.json
+++ b/catalog-rest-service/src/main/resources/json/schema/type/schedule.json
@@ -11,7 +11,7 @@
"$ref": "basic.json#/definitions/dateTime"
},
"repeatFrequency": {
- "description": "Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'",
+ "description": "Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'.",
"$ref": "basic.json#/definitions/duration"
}
}
diff --git a/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json b/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json
index 4c4b24b6bfe..d8cda60291c 100644
--- a/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json
+++ b/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json
@@ -22,7 +22,7 @@
"default": "Manual"
},
"state": {
- "description" : "'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'",
+ "description" : "'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'.",
"type": "string",
"enum": [
"Suggested",
diff --git a/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json b/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json
index b16550ed871..b00fb806ae9 100644
--- a/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json
+++ b/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json
@@ -7,7 +7,7 @@
"javaType": "org.openmetadata.catalog.type.UsageDetails",
"definitions": {
"usageStats": {
- "description": "Type used to return usage statistics",
+ "description": "Type used to return usage statistics.",
"type": "object",
"javaType": "org.openmetadata.catalog.type.UsageStats",
"properties": {
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 438d68652d0..55a830f93a5 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -10,27 +10,29 @@
* [Schema Concepts](openmetadata-apis/schemas/overview.md)
* [OpenMetadata Types](openmetadata-apis/schemas/types/README.md)
* [Basic Types](openmetadata-apis/schemas/types/basic.md)
- * [Audit Log](openmetadata-apis/schemas/types/audit-log.md)
- * [Daily Count](openmetadata-apis/schemas/types/daily-count.md)
- * [Entity Reference](openmetadata-apis/schemas/types/entity-reference.md)
- * [Entity Usage](openmetadata-apis/schemas/types/entity-usage.md)
- * [Jdbc Connection](openmetadata-apis/schemas/types/jdbc-connection.md)
+ * [Audit Log](openmetadata-apis/schemas/types/auditlog.md)
+ * [Daily Count](openmetadata-apis/schemas/types/dailycount.md)
+ * [Entity Reference](openmetadata-apis/schemas/types/entityreference.md)
+ * [Entity Usage](openmetadata-apis/schemas/types/entityusage.md)
+ * [Jdbc Connection](openmetadata-apis/schemas/types/jdbcconnection.md)
* [Profile](openmetadata-apis/schemas/types/profile.md)
* [Schedule](openmetadata-apis/schemas/types/schedule.md)
- * [Tag Label](openmetadata-apis/schemas/types/tag-label.md)
- * [Usage Details](openmetadata-apis/schemas/types/usage-details.md)
+ * [Tag Label](openmetadata-apis/schemas/types/taglabel.md)
+ * [Usage Details](openmetadata-apis/schemas/types/usagedetails.md)
* [OpenMetadata Entities](openmetadata-apis/schemas/entities/README.md)
* [Bot](openmetadata-apis/schemas/entities/bot.md)
* [Dashboard](openmetadata-apis/schemas/entities/dashboard.md)
* [Database](openmetadata-apis/schemas/entities/database.md)
- * [Database Service](openmetadata-apis/schemas/entities/database-service.md)
+ * [Database Service](openmetadata-apis/schemas/entities/databaseservice.md)
+ * [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
* [Feed](openmetadata-apis/schemas/entities/thread.md)
* [Metrics](openmetadata-apis/schemas/entities/metrics.md)
* [Pipeline](openmetadata-apis/schemas/entities/pipeline.md)
* [Report](openmetadata-apis/schemas/entities/report.md)
* [Table](openmetadata-apis/schemas/entities/table.md)
* [Team](openmetadata-apis/schemas/entities/team.md)
- * [Tag Category](openmetadata-apis/schemas/entities/tag-category.md)
+ * [Topic](openmetadata-apis/schemas/entities/topic.md)
+ * [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md)
* [User](openmetadata-apis/schemas/entities/user.md)
* [APIs](openmetadata-apis/apis/README.md)
* [Overview](openmetadata-apis/apis/overview.md)
diff --git a/docs/openmetadata-apis/schemas/entities/README.md b/docs/openmetadata-apis/schemas/entities/README.md
index 9d4ec5a1633..82b27607877 100644
--- a/docs/openmetadata-apis/schemas/entities/README.md
+++ b/docs/openmetadata-apis/schemas/entities/README.md
@@ -18,7 +18,9 @@ OpenMetadata has the following high-level core entities and relationships:
{% page-ref page="database.md" %}
-{% page-ref page="database-service.md" %}
+{% page-ref page="databaseservice.md" %}
+
+{% page-ref page="messagingservice.md" %}
{% page-ref page="thread.md" %}
@@ -32,7 +34,9 @@ OpenMetadata has the following high-level core entities and relationships:
{% page-ref page="team.md" %}
+{% page-ref page="topic.md" %}
+
{% page-ref page="user.md" %}
-{% page-ref page="tag-category.md" %}
+{% page-ref page="tagcategory.md" %}
diff --git a/docs/openmetadata-apis/schemas/entities/bot.md b/docs/openmetadata-apis/schemas/entities/bot.md
index 0bc7a8f7ced..592740f4282 100644
--- a/docs/openmetadata-apis/schemas/entities/bot.md
+++ b/docs/openmetadata-apis/schemas/entities/bot.md
@@ -2,26 +2,27 @@
This schema defines Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It runs as a special user in the system.
-**$id:** [**https://open-metadata.org/schema/entity/bots.json**](https://open-metadata.org/schema/entity/bots.json)
+$id: https://open-metadata.org/schema/entity/bots.json
Type: `object`
## Properties
+ - **id**
+ - Unique identifier of a bot instance.
+ - $ref: [../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name**
+ - Name of the bot.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **displayName**
+ - Name used for display purposes. Example 'FirstName LastName'.
+ - Type: `string`
+ - **description**
+ - Description of the bot.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this bot.
+ - $ref: [../type/basic.json#/definitions/href](../types/basic.md#href)
-* **id**
- * Unique identifier of a bot instance.
- * $ref: [../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name**
- * Name of the bot.
- * Type: `string`
- * Length: between 1 and 64
-* **displayName**
- * Name used for display purposes. Example 'FirstName LastName'.
- * Type: `string`
-* **description**
- * Description of the bot.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this bot.
- * $ref: [../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md
index 0720ca948e2..55fc6211bb0 100644
--- a/docs/openmetadata-apis/schemas/entities/dashboard.md
+++ b/docs/openmetadata-apis/schemas/entities/dashboard.md
@@ -2,36 +2,37 @@
This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are updated in real-time and allow interactive data exploration.
-**$id:** [**https://open-metadata.org/schema/entity/data/dashboard.json**](https://open-metadata.org/schema/entity/data/dashboard.json)
+$id: https://open-metadata.org/schema/entity/data/dashboard.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier that identifies a dashboard instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this dashboard.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **fullyQualifiedName**
+ - A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **description**
+ - Description of the dashboard, what it is, and how to use it.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **owner**
+ - Owner of this dashboard.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **service** `required`
+ - Link to service where this dashboard is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **usageSummary**
+ - Latest usage information for this database.
+ - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
-* **id** `required`
- * Unique identifier that identifies a dashboard instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies this dashboard.
- * Type: `string`
- * Length: between 1 and 64
-* **fullyQualifiedName**
- * A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
- * Type: `string`
- * Length: between 1 and 64
-* **description**
- * Description of the dashboard, what it is, and how to use it.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **owner**
- * Owner of this dashboard.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **service** `required`
- * Link to service where this dashboard is hosted in.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **usageSummary**
- * Latest usage information for this database.
- * $ref: [../../type/usageDetails.json](../types/usage-details.md)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/database-service.md b/docs/openmetadata-apis/schemas/entities/database-service.md
deleted file mode 100644
index d5ddfee408c..00000000000
--- a/docs/openmetadata-apis/schemas/entities/database-service.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# Database Service
-
-This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.
-
-**$id:** [**https://open-metadata.org/schema/entity/services/databaseService.json**](https://open-metadata.org/schema/entity/services/databaseService.json)
-
-Type: `object`
-
-## Properties
-
-* **id** `required`
- * Unique identifier of this database service instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies this database service.
- * Type: `string`
- * Length: between 1 and 64
-* **serviceType** `required`
- * Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
- * $ref: [\#/definitions/databaseServiceType](database-service.md#types-definitions-in-this-schema)
-* **description**
- * Description of a database service instance.
- * Type: `string`
-* **href** `required`
- * Link to the resource corresponding to this database service.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **jdbc** `required`
- * JDBC connection information
- * $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo](../types/jdbc-connection.md#types-definitions-in-this-schema)
-* **ingestionSchedule**
- * Schedule for running metadata ingestion jobs.
- * $ref: [../../type/schedule.json](../types/schedule.md)
-
-## Types definitions in this schema
-
-**databaseServiceType**
-
-* Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
-* Type: `string`
-* The value is restricted to the following:
- 1. _"BigQuery"_
- 2. _"MySQL"_
- 3. _"Redshift"_
- 4. _"Snowflake"_
- 5. _"Postgres"_
- 6. _"MSSQL"_
- 7. _"Hive"_
-
diff --git a/docs/openmetadata-apis/schemas/entities/database.md b/docs/openmetadata-apis/schemas/entities/database.md
index 2a606a3012a..670da308d8b 100644
--- a/docs/openmetadata-apis/schemas/entities/database.md
+++ b/docs/openmetadata-apis/schemas/entities/database.md
@@ -2,46 +2,49 @@
This schema defines the Database entity. A database also referred to as Database Catalog is a collection of tables.
-**$id:** [**https://open-metadata.org/schema/entity/data/database.json**](https://open-metadata.org/schema/entity/data/database.json)
+$id: https://open-metadata.org/schema/entity/data/database.json
Type: `object`
## Properties
+ - **id**
+ - Unique identifier that identifies this database instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies the database.
+ - $ref: [#/definitions/databaseName](#databasename)
+ - **fullyQualifiedName**
+ - Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
+ - Type: `string`
+ - **description**
+ - Description of the database instance.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **owner**
+ - Owner of this database.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **service** `required`
+ - Link to the database cluster/service where this database is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **usageSummary**
+ - Latest usage information for this database.
+ - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
+ - **tables**
+ - References to tables in the database.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
-* **id**
- * Unique identifier that identifies this database instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies the database.
- * $ref: [\#/definitions/databaseName](database.md#types-definitions-in-this-schema)
-* **fullyQualifiedName**
- * Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- * Type: `string`
-* **description**
- * Description of the database instance.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **owner**
- * Owner of this database.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **service** `required`
- * Link to the database cluster/service where this database is hosted in.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **usageSummary**
- * Latest usage information for this database.
- * $ref: [../../type/usageDetails.json](../types/usage-details.md)
-* **tables**
- * References to tables in the database.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### databaseName
-**databaseName**
+ - Name that identifies the database.
+ - Type: `string`
+ - The value must match this pattern: `^[^.]*$`
+ - Length: between 1 and 64
-* Name that identifies the database.
-* Type: `string`
-* The value must match this pattern: `^[^.]*$`
-* Length: between 1 and 64
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/databaseservice.md b/docs/openmetadata-apis/schemas/entities/databaseservice.md
new file mode 100644
index 00000000000..b99d28e12c6
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/entities/databaseservice.md
@@ -0,0 +1,54 @@
+# Database Service
+
+This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.
+
+$id: https://open-metadata.org/schema/entity/services/databaseService.json
+
+Type: `object`
+
+## Properties
+ - **id** `required`
+ - Unique identifier of this database service instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this database service.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **serviceType** `required`
+ - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
+ - $ref: [#/definitions/databaseServiceType](#databaseservicetype)
+ - **description**
+ - Description of a database service instance.
+ - Type: `string`
+ - **href** `required`
+ - Link to the resource corresponding to this database service.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **jdbc** `required`
+ - JDBC connection information.
+ - $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](../types/jdbcconnection.md#jdbcinfo)
+ - **ingestionSchedule**
+ - Schedule for running metadata ingestion jobs.
+ - $ref: [../../type/schedule.json](../types/schedule.md)
+
+
+## Type definitions in this schema
+### databaseServiceType
+
+ - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"BigQuery"_
+ 2. _"MySQL"_
+ 3. _"Redshift"_
+ 4. _"Snowflake"_
+ 5. _"Postgres"_
+ 6. _"MSSQL"_
+ 7. _"Hive"_
+ 8. _"Oracle"_
+ 9. _"Athena"_
+ 10. _"Presto"_
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/messagingservice.md b/docs/openmetadata-apis/schemas/entities/messagingservice.md
new file mode 100644
index 00000000000..f42f7ff9dcd
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/entities/messagingservice.md
@@ -0,0 +1,58 @@
+# Messaging Service
+
+This schema defines the Messaging Service entity, such as Kafka and Pulsar.
+
+$id: https://open-metadata.org/schema/entity/services/messagingService.json
+
+Type: `object`
+
+## Properties
+ - **id** `required`
+ - Unique identifier of this messaging service instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this messaging service.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **serviceType** `required`
+ - Type of messaging service such as Kafka or Pulsar...
+ - $ref: [#/definitions/messagingServiceType](#messagingservicetype)
+ - **description**
+ - Description of a messaging service instance.
+ - Type: `string`
+ - **brokers** `required`
+ - Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
+ - $ref: [#/definitions/brokers](#brokers)
+ - **schemaRegistry**
+ - Schema registry URL.
+ - Type: `string`
+ - String format must be a "uri"
+ - **ingestionSchedule**
+ - Schedule for running metadata ingestion jobs.
+ - $ref: [../../type/schedule.json](../types/schedule.md)
+ - **href**
+ - Link to the resource corresponding to this messaging service.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+
+
+## Type definitions in this schema
+### messagingServiceType
+
+ - Type of messaging service - Kafka or Pulsar.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"Kafka"_
+ 2. _"Pulsar"_
+
+
+### brokers
+
+ - Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
+ - Type: `array`
+ - **Items**
+ - Type: `string`
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/metrics.md b/docs/openmetadata-apis/schemas/entities/metrics.md
index c519bd9bca5..0455333bde8 100644
--- a/docs/openmetadata-apis/schemas/entities/metrics.md
+++ b/docs/openmetadata-apis/schemas/entities/metrics.md
@@ -2,36 +2,37 @@
This schema defines the Metrics entity. Metrics are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`.
-**$id:** [**https://open-metadata.org/schema/entity/data/metrics.json**](https://open-metadata.org/schema/entity/data/metrics.json)
+$id: https://open-metadata.org/schema/entity/data/metrics.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier that identifies this metrics instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this metrics instance uniquely.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **fullyQualifiedName**
+ - A unique name that identifies a metric in the format 'ServiceName.MetricName'.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **description**
+ - Description of metrics instance, what it is, and how to use it.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **owner**
+ - Owner of this metrics.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **service** `required`
+ - Link to service where this metrics is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **usageSummary**
+ - Latest usage information for this database.
+ - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
-* **id** `required`
- * Unique identifier that identifies this metrics instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies this metrics instance uniquely.
- * Type: `string`
- * Length: between 1 and 64
-* **fullyQualifiedName**
- * A unique name that identifies a metric in the format 'ServiceName.MetricName'.
- * Type: `string`
- * Length: between 1 and 64
-* **description**
- * Description of metrics instance, what it is, and how to use it.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **owner**
- * Owner of this metrics.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **service** `required`
- * Link to service where this metrics is hosted in.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **usageSummary**
- * Latest usage information for this database.
- * $ref: [../../type/usageDetails.json](../types/usage-details.md)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md
index 0a9c8d4049a..52d1a8311ac 100644
--- a/docs/openmetadata-apis/schemas/entities/pipeline.md
+++ b/docs/openmetadata-apis/schemas/entities/pipeline.md
@@ -2,33 +2,34 @@
This schema defines the Pipeline entity. A pipeline enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Load the data.
-**$id:** [**https://open-metadata.org/schema/entity/data/pipeline.json**](https://open-metadata.org/schema/entity/data/pipeline.json)
+$id: https://open-metadata.org/schema/entity/data/pipeline.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier that identifies a pipeline instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this pipeline instance uniquely.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **fullyQualifiedName**
+ - A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **description**
+ - Description of this pipeline.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **owner**
+ - Owner of this pipeline.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **service** `required`
+ - Link to service where this pipeline is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
-* **id** `required`
- * Unique identifier that identifies a pipeline instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies this pipeline instance uniquely.
- * Type: `string`
- * Length: between 1 and 64
-* **fullyQualifiedName**
- * A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
- * Type: `string`
- * Length: between 1 and 64
-* **description**
- * Description of this pipeline.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **owner**
- * Owner of this pipeline.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **service** `required`
- * Link to service where this pipeline is hosted in.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md
index a39f5d3015e..d4f3e16bf1a 100644
--- a/docs/openmetadata-apis/schemas/entities/report.md
+++ b/docs/openmetadata-apis/schemas/entities/report.md
@@ -2,36 +2,37 @@
This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and visual form.
-**$id:** [**https://open-metadata.org/schema/entity/data/report.json**](https://open-metadata.org/schema/entity/data/report.json)
+$id: https://open-metadata.org/schema/entity/data/report.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier that identifies this report.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies this report instance uniquely.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **fullyQualifiedName**
+ - A unique name that identifies a report in the format 'ServiceName.ReportName'.
+ - Type: `string`
+ - Length: between 1 and 64
+ - **description**
+ - Description of this report instance.
+ - Type: `string`
+ - **href**
+ - Link to the resource corresponding to this report.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **owner**
+ - Owner of this pipeline.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **service** `required`
+ - Link to service where this report is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **usageSummary**
+ - Latest usage information for this database.
+ - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
-* **id** `required`
- * Unique identifier that identifies this report.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name that identifies this report instance uniquely.
- * Type: `string`
- * Length: between 1 and 64
-* **fullyQualifiedName**
- * A unique name that identifies a report in the format 'ServiceName.ReportName'.
- * Type: `string`
- * Length: between 1 and 64
-* **description**
- * Description of this report instance.
- * Type: `string`
-* **href**
- * Link to the resource corresponding to this report.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **owner**
- * Owner of this pipeline.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **service** `required`
- * Link to service where this report is hosted in.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **usageSummary**
- * Latest usage information for this database.
- * $ref: [../../type/usageDetails.json](../types/usage-details.md)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/table.md b/docs/openmetadata-apis/schemas/entities/table.md
index e2b70964f50..d30ad48d66f 100644
--- a/docs/openmetadata-apis/schemas/entities/table.md
+++ b/docs/openmetadata-apis/schemas/entities/table.md
@@ -2,241 +2,262 @@
This schema defines the Table entity. A Table organizes data in rows and columns and is defined by a Schema. OpenMetadata does not have a separate abstraction for Schema. Both Table and Schema are captured in this entity.
-**$id:** [**https://open-metadata.org/schema/entity/data/table.json**](https://open-metadata.org/schema/entity/data/table.json)
+$id: https://open-metadata.org/schema/entity/data/table.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier of this table instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name of a table. Expected to be unique within a database.
+ - $ref: [#/definitions/tableName](#tablename)
+ - **description**
+ - Description of a table.
+ - Type: `string`
+ - **href**
+ - Link to this table resource.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **tableType**
+ - $ref: [#/definitions/tableType](#tabletype)
+ - **fullyQualifiedName**
+ - Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
+ - Type: `string`
+ - **columns** `required`
+ - Columns in this table.
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/column](#column)
+ - **tableConstraints**
+ - Table constraints.
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/tableConstraint](#tableconstraint)
+ - **usageSummary**
+ - Latest usage information for this table.
+ - $ref: [../../type/usageDetails.json](../types/usagedetails.md)
+ - **owner**
+ - Owner of this table.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **followers**
+ - Followers of this table.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
+ - **database**
+ - Reference to Database that contains this table.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **viewDefinition**
+ - View Definition in SQL. Applies to TableType.View only.
+ - $ref: [../../type/basic.json#/definitions/sqlQuery](../types/basic.md#sqlquery)
+ - **tags**
+ - Tags for this table.
+ - Type: `array`
+ - **Items**
+ - $ref: [../../type/tagLabel.json](../types/taglabel.md)
+ - **joins**
+ - Details of other tables this table is frequently joined with.
+ - $ref: [#/definitions/tableJoins](#tablejoins)
+ - **sampleData**
+ - Sample data for a table.
+ - $ref: [#/definitions/tableData](#tabledata)
-* **id** `required`
- * Unique identifier of this table instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * Name of a table. Expected to be unique within a database.
- * $ref: [\#/definitions/tableName](table.md#types-definitions-in-this-schema)
-* **description**
- * Description of a table.
- * Type: `string`
-* **href**
- * Link to this table resource.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **tableType**
- * $ref: [\#/definitions/tableType](table.md#/definitions/tableType)
-* **fullyQualifiedName**
- * Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
- * Type: `string`
-* **columns** `required`
- * Columns in this table.
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/column](table.md#types-definitions-in-this-schema)
-* **tableConstraints**
- * Table constraints.
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/tableConstraint](table.md#types-definitions-in-this-schema)
-* **usageSummary**
- * Latest usage information for this table.
- * $ref: [../../type/usageDetails.json](../types/usage-details.md)
-* **owner**
- * Owner of this table.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **followers**
- * Followers of this table.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-* **database**
- * Reference to Database that contains this table.
- * $ref: [../../type/entityReference.json](../types/entity-reference.md)
-* **tags**
- * Tags for this table.
- * Type: `array`
- * **Items**
- * $ref: [../../type/tagLabel.json](../types/tag-label.md)
-* **joins**
- * Details of other tables this table is frequently joined with.
- * $ref: [\#/definitions/tableJoins](table.md#types-definitions-in-this-schema)
-* **sampleData**
- * Sample data for a table.
- * $ref: [\#/definitions/tableData](table.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### tableType
-**tableType**
+ - This schema defines the type used for describing different types of tables.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"Regular"_
+ 2. _"External"_
+ 3. _"View"_
+ 4. _"SecureView"_
+ 5. _"MaterializedView"_
-* This schema defines the type used for describing different types of tables.
-* Type: `string`
-* The value is restricted to the following:
- 1. _"Regular"_
- 2. _"External"_
- 3. _"View"_
- 4. _"SecureView"_
- 5. _"MaterializedView"_
-**columnDataType**
+### columnDataType
-* This enum defines the type of data stored in a column.
-* Type: `string`
-* The value is restricted to the following:
- 1. _"NUMBER"_
- 2. _"TINYINT"_
- 3. _"SMALLINT"_
- 4. _"INT"_
- 5. _"BIGINT"_
- 6. _"FLOAT"_
- 7. _"DOUBLE"_
- 8. _"DECIMAL"_
- 9. _"NUMERIC"_
- 10. _"TIMESTAMP"_
- 11. _"TIME"_
- 12. _"DATE"_
- 13. _"DATETIME"_
- 14. _"INTERVAL"_
- 15. _"STRING"_
- 16. _"MEDIUMTEXT"_
- 17. _"TEXT"_
- 18. _"CHAR"_
- 19. _"VARCHAR"_
- 20. _"BOOLEAN"_
- 21. _"BINARY"_
- 22. _"VARBINARY"_
- 23. _"ARRAY"_
- 24. _"BLOB"_
- 25. _"LONGBLOB"_
- 26. _"MEDIUMBLOB"_
- 27. _"MAP"_
- 28. _"STRUCT"_
- 29. _"UNION"_
- 30. _"SET"_
- 31. _"GEOGRAPHY"_
- 32. _"ENUM"_
- 33. _"JSON"_
+ - This enum defines the type of data stored in a column.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"NUMBER"_
+ 2. _"TINYINT"_
+ 3. _"SMALLINT"_
+ 4. _"INT"_
+ 5. _"BIGINT"_
+ 6. _"FLOAT"_
+ 7. _"DOUBLE"_
+ 8. _"DECIMAL"_
+ 9. _"NUMERIC"_
+ 10. _"TIMESTAMP"_
+ 11. _"TIME"_
+ 12. _"DATE"_
+ 13. _"DATETIME"_
+ 14. _"INTERVAL"_
+ 15. _"STRING"_
+ 16. _"MEDIUMTEXT"_
+ 17. _"TEXT"_
+ 18. _"CHAR"_
+ 19. _"VARCHAR"_
+ 20. _"BOOLEAN"_
+ 21. _"BINARY"_
+ 22. _"VARBINARY"_
+ 23. _"ARRAY"_
+ 24. _"BLOB"_
+ 25. _"LONGBLOB"_
+ 26. _"MEDIUMBLOB"_
+ 27. _"MAP"_
+ 28. _"STRUCT"_
+ 29. _"UNION"_
+ 30. _"SET"_
+ 31. _"GEOGRAPHY"_
+ 32. _"ENUM"_
+ 33. _"JSON"_
-**columnConstraint**
-* This enum defines the type for column constraint.
-* Type: `string`
-* The value is restricted to the following:
- 1. _"NULL"_
- 2. _"NOT\_NULL"_
- 3. _"UNIQUE"_
- 4. _"PRIMARY\_KEY"_
-* Default: _"NULL"_
+### columnConstraint
-**tableConstraint**
+ - This enum defines the type for column constraint.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"NULL"_
+ 2. _"NOT_NULL"_
+ 3. _"UNIQUE"_
+ 4. _"PRIMARY_KEY"_
+ - Default: _"NULL"_
-* This enum defines the type for table constraint.
-* Type: `object`
-* **Properties**
- * **constraintType**
- * Type: `string`
- * The value is restricted to the following:
- 1. _"UNIQUE"_
- 2. _"PRIMARY\_KEY"_
- 3. _"FOREIGN\_KEY"_
- * **columns**
- * List of column names corresponding to the constraint.
- * Type: `array`
- * **Items**
- * Type: `string`
-**columnName**
+### tableConstraint
-* Local name \(not fully qualified name\) of the column.
-* Type: `string`
-* The value must match this pattern: `^[^.]*$`
-* Length: between 1 and 64
+ - This enum defines the type for table constraint.
+ - Type: `object`
+ - **Properties**
+ - **constraintType**
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"UNIQUE"_
+ 2. _"PRIMARY_KEY"_
+ 3. _"FOREIGN_KEY"_
+ - **columns**
+ - List of column names corresponding to the constraint.
+ - Type: `array`
+ - **Items**
+ - Type: `string`
-**tableName**
-* Local name \(not fully qualified name\) of a table.
-* Type: `string`
-* The value must match this pattern: `^[^.]*$`
-* Length: between 1 and 64
+### columnName
-**fullyQualifiedColumnName**
+ - Local name (not fully qualified name) of the column.
+ - Type: `string`
+ - The value must match this pattern: `^[^.]*$`
+ - Length: between 1 and 64
-* Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`.
-* Type: `string`
-* Length: between 1 and 256
-**column**
+### tableName
-* This schema defines the type for a column in a table.
-* Type: `object`
-* **Properties**
- * **name** `required`
- * $ref: [\#/definitions/columnName](table.md#/definitions/columnName)
- * **columnDataType** `required`
- * Data type of the column \(int, date etc.\).
- * $ref: [\#/definitions/columnDataType](table.md#/definitions/columnDataType)
- * **description**
- * Description of the column.
- * Type: `string`
- * **fullyQualifiedName**
- * $ref: [\#/definitions/fullyQualifiedColumnName](table.md#/definitions/fullyQualifiedColumnName)
- * **tags**
- * Tags associated with the column.
- * Type: `array`
- * **Items**
- * $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json)
- * **columnConstraint**
- * Column level constraint.
- * $ref: [\#/definitions/columnConstraint](table.md#/definitions/columnConstraint)
- * **ordinalPosition**
- * Ordinal position of the column.
- * Type: `integer`
+ - Local name (not fully qualified name) of a table.
+ - Type: `string`
+ - The value must match this pattern: `^[^.]*$`
+ - Length: between 1 and 64
-**columnJoins**
-* This schema defines the type to capture how frequently a column is joined with columns in the other tables.
-* Type: `object`
-* This schema does not accept additional properties.
-* **Properties**
- * **columnName**
- * $ref: [\#/definitions/columnName](table.md#/definitions/columnName)
- * **joinedWith**
- * Fully qualified names of the columns that this column is joined with.
- * Type: `array`
- * **Items**
- * Type: `object`
- * **Properties**
- * **fullyQualifiedName**
- * $ref: [\#/definitions/fullyQualifiedColumnName](table.md#/definitions/fullyQualifiedColumnName)
- * **joinCount**
- * Type: `integer`
+### fullyQualifiedColumnName
-**tableJoins**
+ - Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`.
+ - Type: `string`
+ - Length: between 1 and 256
-* This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.
-* Type: `object`
-* This schema does not accept additional properties.
-* **Properties**
- * **startDate**
- * Date can be only from today going back to last 29 days.
- * $ref: [../../type/basic.json\#/definitions/date](table.md#....typebasic.jsondefinitionsdate)
- * **dayCount**
- * Type: `integer`
- * Default: `1`
- * **columnJoins**
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/columnJoins](table.md#/definitions/columnJoins)
-**tableData**
+### column
-* This schema defines the type to capture rows of sample data for a table.
-* Type: `object`
-* This schema does not accept additional properties.
-* **Properties**
- * **columns**
- * List of local column names \(not fully qualified column names\) of the table.
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/columnName](table.md#/definitions/columnName)
- * **rows**
- * Data for multiple rows of the table.
- * Type: `array`
- * **Items**
- * Data for a single row of the table within the same order as columns fields.
- * Type: `array`
+ - This schema defines the type for a column in a table.
+ - Type: `object`
+ - **Properties**
+ - **name** `required`
+ - $ref: [#/definitions/columnName](#columnname)
+ - **columnDataType** `required`
+ - Data type of the column (int, date etc.).
+ - $ref: [#/definitions/columnDataType](#columndatatype)
+ - **description**
+ - Description of the column.
+ - Type: `string`
+ - **fullyQualifiedName**
+ - $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname)
+ - **tags**
+ - Tags associated with the column.
+ - Type: `array`
+ - **Items**
+ - $ref: [../../type/tagLabel.json](../types/taglabel.md)
+ - **columnConstraint**
+ - Column level constraint.
+ - $ref: [#/definitions/columnConstraint](#columnconstraint)
+ - **ordinalPosition**
+ - Ordinal position of the column.
+ - Type: `integer`
+
+### columnJoins
+
+ - This schema defines the type to capture how frequently a column is joined with columns in the other tables.
+ - Type: `object`
+ - This schema does not accept additional properties.
+ - **Properties**
+ - **columnName**
+ - $ref: [#/definitions/columnName](#columnname)
+ - **joinedWith**
+ - Fully qualified names of the columns that this column is joined with.
+ - Type: `array`
+ - **Items**
+ - Type: `object`
+ - **Properties**
+ - **fullyQualifiedName**
+ - $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname)
+ - **joinCount**
+ - Type: `integer`
+
+
+### tableJoins
+
+ - This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.
+ - Type: `object`
+ - This schema does not accept additional properties.
+ - **Properties**
+ - **startDate**
+ - Date can be only from today going back to last 29 days.
+ - $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
+ - **dayCount**
+ - Type: `integer`
+ - Default: `1`
+ - **columnJoins**
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/columnJoins](#columnjoins)
+
+
+### tableData
+
+ - This schema defines the type to capture rows of sample data for a table.
+ - Type: `object`
+ - This schema does not accept additional properties.
+ - **Properties**
+ - **columns**
+ - List of local column names (not fully qualified column names) of the table.
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/columnName](#columnname)
+ - **rows**
+ - Data for multiple rows of the table.
+ - Type: `array`
+ - **Items**
+ - Data for a single row of the table in the same order as `columns` fields.
+ - Type: `array`
+ - **Items**
+ - Type: `string`
+ -
+ - Type: `number`
+ -
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/tag-category.md b/docs/openmetadata-apis/schemas/entities/tag-category.md
deleted file mode 100644
index 0850d951a53..00000000000
--- a/docs/openmetadata-apis/schemas/entities/tag-category.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Tag Category
-
-This schema defines the Tag Category entity. A Tag Category contains tags called Primary Tags. Primary Tags can further have children called Secondary Tags. Only two levels of tags are supported currently.
-
-**$id:** [**https://open-metadata.org/schema/entity/tags/tagCategory.json**](https://open-metadata.org/schema/entity/tags/tagCategory.json)
-
-Type: `object`
-
-This schema does not accept additional properties.
-
-## Properties
-
-* **name** `required`
- * $ref: [\#/definitions/tagName](tag-category.md#types-definitions-in-this-schema)
-* **description** `required`
- * Description of the tag category.
- * Type: `string`
-* **categoryType** `required`
- * $ref: [\#/definitions/tagCategoryType](tag-category.md#types-definitions-in-this-schema)
-* **href**
- * Link to the resource corresponding to the tag category.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **usageCount**
- * Count of how many times the tags from this tag category are used.
- * Type: `integer`
-* **children**
- * Tags under this category.
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/tag](tag-category.md#types-definitions-in-this-schema)
-
-## Types definitions in this schema
-
-**tagName**
-
-* Name of the tag.
-* Type: `string`
-* Length: between 2 and 25
-
-**tagCategoryType**
-
-* Type of tag category.
-* Type: `string`
-* The value is restricted to the following:
- 1. _"Descriptive"_
- 2. _"Classification"_
-
-**tag**
-
diff --git a/docs/openmetadata-apis/schemas/entities/tagcategory.md b/docs/openmetadata-apis/schemas/entities/tagcategory.md
new file mode 100644
index 00000000000..a4e1b10aaf5
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/entities/tagcategory.md
@@ -0,0 +1,55 @@
+# Tag Category
+
+This schema defines the Tag Category entity. A Tag Category contains tags called Primary Tags. Primary Tags can further have children Tags called Secondary Tags. Only two levels of tags are supported currently.
+
+$id: https://open-metadata.org/schema/entity/tags/tagCategory.json
+
+Type: `object`
+
+This schema does not accept additional properties.
+
+## Properties
+ - **name** `required`
+ - $ref: [#/definitions/tagName](#tagname)
+ - **description** `required`
+ - Description of the tag category.
+ - Type: `string`
+ - **categoryType** `required`
+ - $ref: [#/definitions/tagCategoryType](#tagcategorytype)
+ - **href**
+ - Link to the resource corresponding to the tag category.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **usageCount**
+ - Count of how many times the tags from this tag category are used.
+ - Type: `integer`
+ - **children**
+ - Tags under this category.
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/tag](#tag)
+
+
+## Type definitions in this schema
+### tagName
+
+ - Name of the tag.
+ - Type: `string`
+ - Length: between 2 and 25
+
+
+### tagCategoryType
+
+ - Type of tag category.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"Descriptive"_
+ 2. _"Classification"_
+
+
+### tag
+
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/team.md b/docs/openmetadata-apis/schemas/entities/team.md
index fdd35133d69..7f517090ee8 100644
--- a/docs/openmetadata-apis/schemas/entities/team.md
+++ b/docs/openmetadata-apis/schemas/entities/team.md
@@ -2,43 +2,46 @@
This schema defines the Team entity. A Team is a group of zero or more users. Teams can own zero or more data assets.
-**$id:** [**https://open-metadata.org/schema/entity/teams/team.json**](https://open-metadata.org/schema/entity/teams/team.json)
+$id: https://open-metadata.org/schema/entity/teams/team.json
Type: `object`
## Properties
+ - **id** `required`
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - $ref: [#/definitions/teamName](#teamname)
+ - **displayName**
+ - Name used for display purposes. Example 'Data Science team'.
+ - Type: `string`
+ - **description**
+ - Description of the team.
+ - Type: `string`
+ - **href** `required`
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **profile**
+ - Team profile information.
+ - $ref: [../../type/profile.json](../types/profile.md)
+ - **deleted**
+ - When true the team has been deleted.
+ - Type: `boolean`
+ - **users**
+ - Users that are part of the team.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
+ - **owns**
+ - List of entities owned by the team.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
-* **id** `required`
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * $ref: [\#/definitions/teamName](team.md#/definitions/teamName)
-* **displayName**
- * Name used for display purposes. Example 'Data Science team'.
- * Type: `string`
-* **description**
- * Description of the team.
- * Type: `string`
-* **href** `required`
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **profile**
- * Team profile information.
- * $ref: [../../type/profile.json](../types/profile.md)
-* **deleted**
- * When true the team has been deleted.
- * Type: `boolean`
-* **users**
- * Users that are part of the team.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-* **owns**
- * List of entities owned by the team.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### teamName
-**teamName**
+ - A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.
+ - Type: `string`
+ - Length: between 1 and 64
-* A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.
-* Type: `string`
-* Length: between 1 and 64
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/thread.md b/docs/openmetadata-apis/schemas/entities/thread.md
index 8a34fde5cbe..e09cdb3a8c3 100644
--- a/docs/openmetadata-apis/schemas/entities/thread.md
+++ b/docs/openmetadata-apis/schemas/entities/thread.md
@@ -1,47 +1,51 @@
-# Feed
+# Thread
This schema defines the Thread entity. A Thread is a collection of posts made by the users. The first post that starts a thread is **about** a data asset **from** a user. Other users can respond to this post by creating new posts in the thread. Note that bot users can also interact with a thread. A post can contains links that mention Users or other Data Assets.
-**$id:** [**https://open-metadata.org/schema/entity/feed/thread.json**](https://open-metadata.org/schema/entity/feed/thread.json)
+$id: https://open-metadata.org/schema/entity/feed/thread.json
Type: `object`
## Properties
+ - **id** `required`
+ - Unique identifier that identifies an entity instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **threadTs**
+ - Timestamp of the when the first post created the thread.
+ - $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
+ - **about** `required`
+ - Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}.
+ - $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
+ - **addressedTo**
+ - User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}.
+ - $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
+ - **posts** `required`
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/post](#post)
-* **id** `required`
- * Unique identifier that identifies an entity instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **href**
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **threadTs**
- * Timestamp of the when the first post created the thread.
-* **about** `required`
- * Data asset about which this thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
- * $ref: [../../type/basic.json\#/definitions/entityLink](../types/basic.md#types-definitions-in-this-schema)
-* **addressedTo**
- * User or team this thread is addressed to in format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
- * $ref: [../../type/basic.json\#/definitions/entityLink](../types/basic.md#types-definitions-in-this-schema)
-* **posts** `required`
- * Type: `array`
- * **Items**
- * $ref: [\#/definitions/post](thread.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### post
-**post**
+ - Post within a feed.
+ - Type: `object`
+ - **Properties**
+ - **message** `required`
+ - Message in markdown format. See markdown support for more details.
+ - Type: `string`
+ - **postTs**
+ - Timestamp of the post.
+ - Type: `string`
+ - String format must be a "date-time"
+ - **from** `required`
+ - ID of User (regular user or a bot) posting the message.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
-* Post within a feed.
-* Type: `object`
-* **Properties**
- * **message** `required`
- * Message in markdown format. See markdown support for more details.
- * Type: `string`
- * **postTs**
- * Timestamp of the post.
- * Type: `string`
- * String format must be a "date-time"
- * **from** `required`
- * ID of User \(regular user or a bot\) posting the message.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/topic.md b/docs/openmetadata-apis/schemas/entities/topic.md
new file mode 100644
index 00000000000..c29f740b5cb
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/entities/topic.md
@@ -0,0 +1,98 @@
+# Topic
+
+This schema defines the Topic entity. A topic is a feed into which message are published to by publishers and read from by consumers in a messaging service.
+
+$id: https://open-metadata.org/schema/entity/data/topic.json
+
+Type: `object`
+
+## Properties
+ - **id** `required`
+ - Unique identifier that identifies this topic instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - Name that identifies the topic.
+ - $ref: [#/definitions/topicName](#topicname)
+ - **fullyQualifiedName**
+ - Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'.
+ - Type: `string`
+ - **description**
+ - Description of the topic instance.
+ - Type: `string`
+ - **service** `required`
+ - Link to the messaging cluster/service where this topic is hosted in.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **partitions** `required`
+ - Number of partitions into which the topic is divided.
+ - Type: `integer`
+ - Range: ≥ 1
+ - **schemaText**
+ - Schema used for message serialization. Optional as some topics may not have associated schemas.
+ - Type: `string`
+ - **schemaType**
+ - Schema used for message serialization.
+ - $ref: [#/definitions/schemaType](#schematype)
+ - **cleanupPolicies**
+ - Topic clean up policies. For Kafka - `cleanup.policy` configuration.
+ - Type: `array`
+ - **Items**
+ - $ref: [#/definitions/cleanupPolicy](#cleanuppolicy)
+ - **retentionTime**
+ - Retention time in milliseconds. For Kafka - `retention.ms` configuration.
+ - Type: `number`
+ - **maximumMessageSize**
+ - Maximum message size in bytes. For Kafka - `max.message.bytes` configuration.
+ - Type: `integer`
+ - **minimumInSyncReplicas**
+ - Minimum number replicas in sync to control durability. For Kafka - `min.insync.replicas` configuration.
+ - Type: `integer`
+ - **retentionSize**
+ - Maximum size of a partition in bytes before old data is discarded. For Kafka - `retention.bytes` configuration.
+ - Type: `number`
+ - Default: _"-1"_
+ - **owner**
+ - Owner of this topic.
+ - $ref: [../../type/entityReference.json](../types/entityreference.md)
+ - **followers**
+ - Followers of this table.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
+ - **tags**
+ - Tags for this table.
+ - Type: `array`
+ - **Items**
+ - $ref: [../../type/tagLabel.json](../types/taglabel.md)
+ - **href**
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+
+
+## Type definitions in this schema
+### topicName
+
+ - Name that identifies a topic.
+ - Type: `string`
+ - The value must match this pattern: `^[^.]*$`
+ - Length: between 1 and 64
+
+
+### schemaType
+
+ - Schema type used for the message.
+ - The value is restricted to the following:
+ 1. _"Avro"_
+ 2. _"Protobuf"_
+ 3. _"JSON"_
+ 4. _"Other"_
+
+
+### cleanupPolicy
+
+ - Topic clean up policy. For Kafka - `cleanup.policy` configuration.
+ - The value is restricted to the following:
+ 1. _"delete"_
+ 2. _"compact"_
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/entities/user.md b/docs/openmetadata-apis/schemas/entities/user.md
index 654fb7ddcb8..5ea5cbf3fc7 100644
--- a/docs/openmetadata-apis/schemas/entities/user.md
+++ b/docs/openmetadata-apis/schemas/entities/user.md
@@ -2,59 +2,62 @@
This schema defines the User entity. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.
-**$id:** [**https://open-metadata.org/schema/entity/teams/user.json**](https://open-metadata.org/schema/entity/teams/user.json)
+$id: https://open-metadata.org/schema/entity/teams/user.json
Type: `object`
-This schema does not accept additional properties.
+This schema does not accept additional properties.
## Properties
+ - **id** `required`
+ - Unique identifier that identifies a user entity instance.
+ - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
+ - **name** `required`
+ - $ref: [#/definitions/userName](#username)
+ - **displayName**
+ - Name used for display purposes. Example 'FirstName LastName'.
+ - Type: `string`
+ - **email** `required`
+ - Email address of the user.
+ - $ref: [../../type/basic.json#/definitions/email](../types/basic.md#email)
+ - **href** `required`
+ - Link to the resource corresponding to this entity.
+ - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
+ - **timezone**
+ - Timezone of the user.
+ - Type: `string`
+ - String format must be a "timezone"
+ - **deactivated**
+ - When true indicates the user has been deactivated. Users are deactivated instead of deleted.
+ - Type: `boolean`
+ - **isBot**
+ - When true indicates a special type of user called Bot.
+ - Type: `boolean`
+ - **isAdmin**
+ - When true indicates user is an administrator for the system with superuser privileges.
+ - Type: `boolean`
+ - **profile**
+ - Profile of the user.
+ - $ref: [../../type/profile.json](../types/profile.md)
+ - **teams**
+ - Teams that the user belongs to.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
+ - **owns**
+ - List of entities owned by the user.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
+ - **follows**
+ - List of entities followed by the user.
+ - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
-* **id** `required`
- * Unique identifier that identifies a user entity instance.
- * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema)
-* **name** `required`
- * $ref: [\#/definitions/userName](user.md#/definitions/userName)
-* **displayName**
- * Name used for display purposes. Example 'FirstName LastName'.
- * Type: `string`
-* **email** `required`
- * Email address of the user.
- * $ref: [../../type/basic.json\#/definitions/email](../types/basic.md#types-definitions-in-this-schema)
-* **href** `required`
- * Link to the resource corresponding to this entity.
- * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#types-definitions-in-this-schema)
-* **timezone**
- * Timezone of the user.
- * Type: `string`
- * String format must be a "timezone"
-* **deactivated**
- * When true indicates the user has been deactivated. Users are deactivated instead of deleted.
- * Type: `boolean`
-* **isBot**
- * When true indicates a special type of user called Bot.
- * Type: `boolean`
-* **isAdmin**
- * When true indicates user is an administrator for the system with superuser privileges.
- * Type: `boolean`
-* **profile**
- * Profile of the user.
- * $ref: [../../type/profile.json](../types/profile.md)
-* **teams**
- * Teams that the user belongs to.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-* **owns**
- * List of entities owned by the user.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-* **follows**
- * List of entities followed by the user.
- * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](../types/entity-reference.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### userName
-**userName**
+ - A unique name of the user, typically the user ID from an identity provider. Example - uid from LDAP.
+ - Type: `string`
+ - Length: between 1 and 64
-* A unique name of the user, typically the user ID from an identity provider. Example - uid from LDAP.
-* Type: `string`
-* Length: between 1 and 64
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/README.md b/docs/openmetadata-apis/schemas/types/README.md
index 4f75b91dea5..fbb757d9070 100644
--- a/docs/openmetadata-apis/schemas/types/README.md
+++ b/docs/openmetadata-apis/schemas/types/README.md
@@ -4,15 +4,15 @@ OpenMetadata supports many common types reused across different schemas. Definin
{% page-ref page="basic.md" %}
-{% page-ref page="audit-log.md" %}
+{% page-ref page="auditlog.md" %}
-{% page-ref page="daily-count.md" %}
+{% page-ref page="dailycount.md" %}
-{% page-ref page="entity-reference.md" %}
+{% page-ref page="entityreference.md" %}
-{% page-ref page="entity-usage.md" %}
+{% page-ref page="entityusage.md" %}
-{% page-ref page="jdbc-connection.md" %}
+{% page-ref page="jdbcconnection.md" %}
{% page-ref page="profile.md" %}
@@ -20,5 +20,5 @@ OpenMetadata supports many common types reused across different schemas. Definin
{% page-ref page="tag-label.md" %}
-{% page-ref page="usage-details.md" %}
+{% page-ref page="usagedetails.md" %}
diff --git a/docs/openmetadata-apis/schemas/types/audit-log.md b/docs/openmetadata-apis/schemas/types/audit-log.md
deleted file mode 100644
index ca17c2a7af1..00000000000
--- a/docs/openmetadata-apis/schemas/types/audit-log.md
+++ /dev/null
@@ -1,37 +0,0 @@
-# Audit Log
-
-This schema defines the Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations.
-
-**$id:** [**https://open-metadata.org/schema/type/auditLog.json**](https://open-metadata.org/schema/type/auditLog.json)
-
-Type: `object`
-
-## Properties
-
-* **method** `required`
- * HTTP Method used in a call
- * Type: `string`
- * The value is restricted to the following:
- 1. _"POST"_
- 2. _"PUT"_
- 3. _"PATCH"_
- 4. _"DELETE"_
-* **responseCode** `required`
- * HTTP response code for the api requested
- * Type: `integer`
-* **path** `required`
- * Requested API path
- * Type: `string`
-* **userName** `required`
- * Name of the user who made the API request
- * Type: `string`
-* **dateTime**
- * Date when the API call is made
- * $ref: [basic.json\#/definitions/dateTime](basic.md#types-definitions-in-this-schema)
-* **entityId** `required`
- * Identifier of Entity that was modified by the operation
- * $ref: [basic.json\#/definitions/uuid](basic.md#types-definitions-in-this-schema)
-* **entityType** `required`
- * Type of Entity that is modified by the operation
- * Type: `string`
-
diff --git a/docs/openmetadata-apis/schemas/types/auditlog.md b/docs/openmetadata-apis/schemas/types/auditlog.md
new file mode 100644
index 00000000000..f1401197344
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/auditlog.md
@@ -0,0 +1,38 @@
+# Audit Log
+
+This schema defines the Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations.
+
+$id: https://open-metadata.org/schema/type/auditLog.json
+
+Type: `object`
+
+## Properties
+ - **method** `required`
+ - HTTP Method used in a call.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"POST"_
+ 2. _"PUT"_
+ 3. _"PATCH"_
+ 4. _"DELETE"_
+ - **responseCode** `required`
+ - HTTP response code for the api requested.
+ - Type: `integer`
+ - **path** `required`
+ - Requested API Path.
+ - Type: `string`
+ - **userName** `required`
+ - Name of the user who made the API request.
+ - Type: `string`
+ - **dateTime**
+ - Date when the API call is made.
+ - $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
+ - **entityId** `required`
+ - Identifier of entity that was modified by the operation.
+ - $ref: [basic.json#/definitions/uuid](basic.md#uuid)
+ - **entityType** `required`
+ - Type of Entity that is modified by the operation.
+ - Type: `string`
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md
index b5d8c3b26e7..b78d41b951e 100644
--- a/docs/openmetadata-apis/schemas/types/basic.md
+++ b/docs/openmetadata-apis/schemas/types/basic.md
@@ -1,68 +1,87 @@
-# Basic Types
+# Basic
This schema defines basic common types that are used by other schemas.
-**$id:** [**https://open-metadata.org/schema/type/basic.json**](https://open-metadata.org/schema/type/basic.json)
+$id: https://open-metadata.org/schema/type/basic.json
+
+
## Type definitions in this schema
+### uuid
-**uuid**
+ - Unique id used to identify an entity.
+ - Type: `string`
+ - String format must be a "uuid"
-* Unique id used to identify an entity
-* Type: `string`
-* String format must be a "uuid"
-**email**
+### email
-* Email address of a user or other entities
-* Type: `string`
-* String format must be a "email"
-* The value must match this pattern: `^\S+@\S+\.\S+$`
-* Length: between 6 and 127
+ - Email address of a user or other entities.
+ - Type: `string`
+ - String format must be a "email"
+ - The value must match this pattern: `^\S+@\S+\.\S+$`
+ - Length: between 6 and 127
-**entityLink**
-* Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`
-* Type: `string`
-* The value must match this pattern: `^<#E/\S+/\S+>$`
+### entityLink
-**timestamp**
+ - Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
+ - Type: `string`
+ - The value must match this pattern: `^<#E/\S+/\S+>$`
-* Timestamp in unixTimeMillis
-* Type: `string`
-* String format must be a "utc-millisec"
-**href**
+### timestamp
-* URI that points to a resource
-* Type: `string`
-* String format must be a "uri"
+ - Timestamp in unixTimeMillis.
+ - Type: `string`
+ - String format must be a "utc-millisec"
-**timeInterval**
-* Type: `object`
-* **Properties**
- * **start**
- * Start time in unixTimeMillis
- * Type: `integer`
- * **end**
- * End time in unixTimeMillis.
- * Type: `integer`
+### href
-**duration**
+ - URI that points to a resource.
+ - Type: `string`
+ - String format must be a "uri"
-* Duration in ISO 8601 format in UTC. Example - 'P23DT23H'
-* Type: `string`
-**date**
+### timeInterval
-* Date in ISO 8601 format in UTC. Example - '2018-11-13'
-* Type: `string`
-* String format must be a "date"
+ - Type: `object`
+ - **Properties**
+ - **start**
+ - Start time in unixTimeMillis.
+ - Type: `integer`
+ - **end**
+ - End time in unixTimeMillis.
+ - Type: `integer`
-**dateTime**
-* Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'
-* Type: `string`
-* String format must be a "date-Time"
+### duration
+ - Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.
+ - Type: `string`
+
+
+### date
+
+ - Date in ISO 8601 format in UTC. Example - '2018-11-13'.
+ - Type: `string`
+ - String format must be a "date"
+
+
+### dateTime
+
+ - Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
+ - Type: `string`
+ - String format must be a "date-time"
+
+
+### sqlQuery
+
+ - SQL query statement. Example - 'select * from orders'.
+ - Type: `string`
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/daily-count.md b/docs/openmetadata-apis/schemas/types/daily-count.md
deleted file mode 100644
index 829880d3233..00000000000
--- a/docs/openmetadata-apis/schemas/types/daily-count.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Daily Count
-
-This schema defines the type for reporting the daily count of some measurement. For example, you might use this schema for the number of times a table is queried each day.
-
-**$id:** [**https://open-metadata.org/schema/type/dailyCount.json**](https://open-metadata.org/schema/type/dailyCount.json)
-
-Type: `object`
-
-This schema does not accept additional properties.
-
-## Properties
-
-* **count** `required`
- * Daily count of a measurement on the given date
- * Type: `integer`
- * Range: ≥ 0
-* **date** `required`
- * $ref: [basic.json\#/definitions/date](basic.md#types-definitions-in-this-schema)
-
diff --git a/docs/openmetadata-apis/schemas/types/dailycount.md b/docs/openmetadata-apis/schemas/types/dailycount.md
new file mode 100644
index 00000000000..c9bf079205b
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/dailycount.md
@@ -0,0 +1,20 @@
+# Daily count of some measurement
+
+This schema defines the type for reporting the daily count of some measurement. For example, you might use this schema for the number of times a table is queried each day.
+
+$id: https://open-metadata.org/schema/type/dailyCount.json
+
+Type: `object`
+
+This schema does not accept additional properties.
+
+## Properties
+ - **count** `required`
+ - Daily count of a measurement on the given date.
+ - Type: `integer`
+ - Range: ≥ 0
+ - **date** `required`
+ - $ref: [basic.json#/definitions/date](basic.md#date)
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/entity-reference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md
deleted file mode 100644
index 92d79745fa3..00000000000
--- a/docs/openmetadata-apis/schemas/types/entity-reference.md
+++ /dev/null
@@ -1,34 +0,0 @@
-# Entity Reference
-
-This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
-
-**$id:** [**https://open-metadata.org/schema/type/entityReference.json**](https://open-metadata.org/schema/type/entityReference.json)
-
-Type: `object`
-
-## Properties
-
-* **id** `required`
- * Unique identifier that identifies an entity instance.
- * $ref: [basic.json\#/definitions/uuid](basic.md#types-definitions-in-this-schema)
-* **type** `required`
- * Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
- * Type: `string`
-* **name**
- * Name of the entity instance. For entities such as tables, databases where the name is not unique, fullyQualifiedName is returned in this field.
- * Type: `string`
-* **description**
- * Optional description of entity.
- * Type: `string`
-* **href**
- * Link to the entity resource.
- * $ref: [basic.json\#/definitions/href](basic.md#types-definitions-in-this-schema)
-
-## Types definitions in this schema
-
-**entityReferenceList**
-
-* Type: `array`
- * **Items**
- * $ref: [entityReference.json](entity-reference.md)
-
diff --git a/docs/openmetadata-apis/schemas/types/entity-usage.md b/docs/openmetadata-apis/schemas/types/entity-usage.md
deleted file mode 100644
index 07c3c77cb10..00000000000
--- a/docs/openmetadata-apis/schemas/types/entity-usage.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Entity Usage
-
-This schema defines the type used for capturing usage details of an entity.
-
-**$id:** [**https://open-metadata.org/schema/type/entityUsage.json**](https://open-metadata.org/schema/type/entityUsage.json)
-
-Type: `object`
-
-## Properties
-
-* **entity** `required`
- * Entity for which usage is returned.
- * $ref: [entityReference.json](entity-reference.md)
-* **usage** `required`
- * List usage details per day.
- * Type: `array`
- * **Items**
- * $ref: [usageDetails.json](usage-details.md)
-
diff --git a/docs/openmetadata-apis/schemas/types/entityreference.md b/docs/openmetadata-apis/schemas/types/entityreference.md
new file mode 100644
index 00000000000..0c3167478c2
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/entityreference.md
@@ -0,0 +1,37 @@
+# Entity Reference
+
+This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
+
+$id: https://open-metadata.org/schema/type/entityReference.json
+
+Type: `object`
+
+## Properties
+ - **id** `required`
+ - Unique identifier that identifies an entity instance.
+ - $ref: [basic.json#/definitions/uuid](basic.md#uuid)
+ - **type** `required`
+ - Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
+ - Type: `string`
+ - **name**
+ - Name of the entity instance. For entities such as tables, databases where the name is not unique, fullyQualifiedName is returned in this field.
+ - Type: `string`
+ - **description**
+ - Optional description of entity.
+ - Type: `string`
+ - **href**
+ - Link to the entity resource.
+ - $ref: [basic.json#/definitions/href](basic.md#href)
+
+
+## Type definitions in this schema
+### entityReferenceList
+
+ - Type: `array`
+ - **Items**
+ - $ref: [entityReference.json](entityreference.md)
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/entityusage.md b/docs/openmetadata-apis/schemas/types/entityusage.md
new file mode 100644
index 00000000000..de2498969df
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/entityusage.md
@@ -0,0 +1,20 @@
+# Usage details of an entity
+
+This schema defines the type used for capturing usage details of an entity.
+
+$id: https://open-metadata.org/schema/type/entityUsage.json
+
+Type: `object`
+
+## Properties
+ - **entity** `required`
+ - Entity for which usage is returned.
+ - $ref: [entityReference.json](entityreference.md)
+ - **usage** `required`
+ - List usage details per day.
+ - Type: `array`
+ - **Items**
+ - $ref: [usageDetails.json](usagedetails.md)
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/jdbc-connection.md b/docs/openmetadata-apis/schemas/types/jdbc-connection.md
deleted file mode 100644
index 00092413e19..00000000000
--- a/docs/openmetadata-apis/schemas/types/jdbc-connection.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# Jdbc Connection
-
-JDBC connection information
-
-**$id:** [**https://open-metadata.org/schema/type/jdbcConnection.json**](https://open-metadata.org/schema/type/jdbcConnection.json)
-
-Type: `object`
-
-## Properties
-
-* **driverClass** `required`
- * JDBC driver class
- * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema)
-* **connectionUrl** `required`
- * JDBC connection URL
- * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema)
-* **userName** `required`
- * Login user name.
- * Type: `string`
-* **password** `required`
- * Login password.
- * Type: `string`
-
-## Types definitions in this schema
-
-**driverClass**
-
-* Type used for JDBC driver class
-* Type: `string`
-
-**connectionUrl**
-
-* Type used for JDBC connection URL
-* Type: `string`
-* String format must be a "uri"
-
-**jdbcInfo**
-
-* Type for capturing JDBC connector information
-* Type: `object`
-* **Properties**
- * **driverClass** `required`
- * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema)
- * **connectionUrl** `required`
- * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema)
-
diff --git a/docs/openmetadata-apis/schemas/types/jdbcconnection.md b/docs/openmetadata-apis/schemas/types/jdbcconnection.md
new file mode 100644
index 00000000000..d4cd9529c21
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/jdbcconnection.md
@@ -0,0 +1,51 @@
+# JDBC connection
+
+This schema defines the type used for JDBC connection information.
+
+$id: https://open-metadata.org/schema/type/jdbcConnection.json
+
+Type: `object`
+
+## Properties
+ - **driverClass** `required`
+ - JDBC driver class.
+ - $ref: [#/definitions/driverClass](#driverclass)
+ - **connectionUrl** `required`
+ - JDBC connection URL.
+ - $ref: [#/definitions/connectionUrl](#connectionurl)
+ - **userName** `required`
+ - Login user name.
+ - Type: `string`
+ - **password** `required`
+ - Login password.
+ - Type: `string`
+
+
+## Type definitions in this schema
+### driverClass
+
+ - Type used for JDBC driver class.
+ - Type: `string`
+
+
+### connectionUrl
+
+ - Type used for JDBC connection URL.
+ - Type: `string`
+ - String format must be a "uri"
+
+
+### jdbcInfo
+
+ - Type for capturing JDBC connector information.
+ - Type: `object`
+ - **Properties**
+ - **driverClass** `required`
+ - $ref: [#/definitions/driverClass](#driverclass)
+ - **connectionUrl** `required`
+ - $ref: [#/definitions/connectionUrl](#connectionurl)
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md
index b0201e0cb02..22f5b9b8c14 100644
--- a/docs/openmetadata-apis/schemas/types/profile.md
+++ b/docs/openmetadata-apis/schemas/types/profile.md
@@ -2,41 +2,44 @@
This schema defines the type for a profile of a user, team, or organization.
-**$id:** [**https://open-metadata.org/schema/type/profile.json**](https://open-metadata.org/schema/type/profile.json)
+$id: https://open-metadata.org/schema/type/profile.json
Type: `object`
## Properties
+ - **images**
+ - $ref: [#/definitions/imageList](#imagelist)
-* **images**
- * $ref: [\#/definitions/imageList](profile.md#types-definitions-in-this-schema)
-## Types definitions in this schema
+## Type definitions in this schema
+### imageList
-**imageList**
+ - Links to a list of images of varying resolutions/sizes.
+ - Type: `object`
+ - **Properties**
+ - **image**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image24**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image32**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image48**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image72**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image192**
+ - Type: `string`
+ - String format must be a "uri"
+ - **image512**
+ - Type: `string`
+ - String format must be a "uri"
-* Links to a list of images of varying resolutions/sizes.
-* Type: `object`
-* **Properties**
- * **image**
- * Type: `string`
- * String format must be a "uri"
- * **image24**
- * Type: `string`
- * String format must be a "uri"
- * **image32**
- * Type: `string`
- * String format must be a "uri"
- * **image48**
- * Type: `string`
- * String format must be a "uri"
- * **image72**
- * Type: `string`
- * String format must be a "uri"
- * **image192**
- * Type: `string`
- * String format must be a "uri"
- * **image512**
- * Type: `string`
- * String format must be a "uri"
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md
index 4ad2cb6405b..45cc66be7e9 100644
--- a/docs/openmetadata-apis/schemas/types/schedule.md
+++ b/docs/openmetadata-apis/schemas/types/schedule.md
@@ -2,18 +2,17 @@
This schema defines the type used for the schedule. The schedule has a start time and repeat frequency.
-**$id:** [**https://open-metadata.org/schema/type/schedule.json**](https://open-metadata.org/schema/type/schedule.json)
+$id: https://open-metadata.org/schema/type/schedule.json
Type: `object`
## Properties
-
-* **startDate**
- * Start date and time of the schedule.
- * $ref: [basic.json\#/definitions/dateTime](basic.md#types-definitions-in-this-schema)
-* **repeatFrequency**
- * Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'
- * $ref: [basic.json\#/definitions/duration](basic.md#types-definitions-in-this-schema)
-
+ - **startDate**
+ - Start date and time of the schedule.
+ - $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
+ - **repeatFrequency**
+ - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'.
+ - $ref: [basic.json#/definitions/duration](basic.md#duration)
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/tag-label.md b/docs/openmetadata-apis/schemas/types/tag-label.md
deleted file mode 100644
index 9bb72ed6b10..00000000000
--- a/docs/openmetadata-apis/schemas/types/tag-label.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# Tag Label
-
-This schema defines the type for labeling an entity with a Tag.
-
-**$id:** [**https://open-metadata.org/schema/type/tagLabel.json**](https://open-metadata.org/schema/type/tagLabel.json)
-
-Type: `object`
-
-## Properties
-
-* **tagFQN**
- * Type: `string`
- * Length: ≤ 45
-* **labelType**
- * Label type describes how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using the associated tag relationship \(see TagCategory.json for more details\). 'Propagated\` indicates a tag label was propagated from upstream based on lineage. 'Automated' is used when a tool was used to determine the tag label.
- * Type: `string`
- * The value is restricted to the following:
- 1. _"Manual"_
- 2. _"Propagated"_
- 3. _"Automated"_
- 4. _"Derived"_
- * Default: _"Manual"_
-* **state**
- * 'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'
- * Type: `string`
- * The value is restricted to the following:
- 1. _"Suggested"_
- 2. _"Confirmed"_
- * Default: _"Confirmed"_
-* **href**
- * Link to the tag resource.
- * $ref: [basic.json\#/definitions/href](basic.md#types-definitions-in-this-schema)
-
diff --git a/docs/openmetadata-apis/schemas/types/taglabel.md b/docs/openmetadata-apis/schemas/types/taglabel.md
new file mode 100644
index 00000000000..c07d223d6d0
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/taglabel.md
@@ -0,0 +1,34 @@
+# Tag Label
+
+This schema defines the type for labeling an entity with a Tag.
+
+$id: https://open-metadata.org/schema/type/tagLabel.json
+
+Type: `object`
+
+## Properties
+ - **tagFQN**
+ - Type: `string`
+ - Length: ≤ 45
+ - **labelType**
+ - Label type describes how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using the associated tag relationship (see TagCategory.json for more details). 'Propagated` indicates a tag label was propagated from upstream based on lineage. 'Automated' is used when a tool was used to determine the tag label.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"Manual"_
+ 2. _"Propagated"_
+ 3. _"Automated"_
+ 4. _"Derived"_
+ - Default: _"Manual"_
+ - **state**
+ - 'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'.
+ - Type: `string`
+ - The value is restricted to the following:
+ 1. _"Suggested"_
+ 2. _"Confirmed"_
+ - Default: _"Confirmed"_
+ - **href**
+ - Link to the tag resource.
+ - $ref: [basic.json#/definitions/href](basic.md#href)
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file
diff --git a/docs/openmetadata-apis/schemas/types/usage-details.md b/docs/openmetadata-apis/schemas/types/usage-details.md
deleted file mode 100644
index 63f493846c8..00000000000
--- a/docs/openmetadata-apis/schemas/types/usage-details.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# Usage Details
-
-This schema defines the type for usage details. Daily, weekly, and monthly aggregation of usage is computed along with the percentile rank based on the usage for a given day.
-
-**$id:** [**https://open-metadata.org/schema/type/usageDetails.json**](https://open-metadata.org/schema/type/usageDetails.json)
-
-Type: `object`
-
-## Properties
-
-* **dailyStats** `required`
- * Daily usage stats of a data asset on the start date.
- * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
-* **weeklyStats**
- * Weekly \(last 7 days\) rolling usage stats of a data asset on the start date.
- * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
-* **monthlyStats**
- * Monthly \(last 30 days\) rolling usage stats of a data asset on the start date.
- * $ref: [\#/definitions/usageStats](usage-details.md#types-definitions-in-this-schema)
-* **date** `required`
- * Date in UTC.
- * $ref: [basic.json\#/definitions/date](basic.md#types-definitions-in-this-schema)
-
-## Types definitions in this schema
-
-**usageStats**
-
-* Type used to return usage statistics
-* Type: `object`
-* This schema does not accept additional properties.
-* **Properties**
- * **count** `required`
- * Usage count of a data asset on the start date.
- * Type: `integer`
- * Range: ≥ 0
- * **percentileRank**
- * Optional daily percentile rank data asset use when relevant.
- * Type: `number`
- * Range: between 0 and 100
-
diff --git a/docs/openmetadata-apis/schemas/types/usagedetails.md b/docs/openmetadata-apis/schemas/types/usagedetails.md
new file mode 100644
index 00000000000..fe72f23389a
--- /dev/null
+++ b/docs/openmetadata-apis/schemas/types/usagedetails.md
@@ -0,0 +1,43 @@
+# Type used to return usage details of an entity
+
+This schema defines the type for usage details. Daily, weekly, and monthly aggregation of usage is computed along with the percentile rank based on the usage for a given day.
+
+$id: https://open-metadata.org/schema/type/usageDetails.json
+
+Type: `object`
+
+## Properties
+ - **dailyStats** `required`
+ - Daily usage stats of a data asset on the start date.
+ - $ref: [#/definitions/usageStats](#usagestats)
+ - **weeklyStats**
+ - Weekly (last 7 days) rolling usage stats of a data asset on the start date.
+ - $ref: [#/definitions/usageStats](#usagestats)
+ - **monthlyStats**
+ - Monthly (last 30 days) rolling usage stats of a data asset on the start date.
+ - $ref: [#/definitions/usageStats](#usagestats)
+ - **date** `required`
+ - Date in UTC.
+ - $ref: [basic.json#/definitions/date](basic.md#date)
+
+
+## Type definitions in this schema
+### usageStats
+
+ - Type used to return usage statistics.
+ - Type: `object`
+ - This schema does not accept additional properties.
+ - **Properties**
+ - **count** `required`
+ - Usage count of a data asset on the start date.
+ - Type: `integer`
+ - Range: ≥ 0
+ - **percentileRank**
+ - Optional daily percentile rank data asset use when relevant.
+ - Type: `number`
+ - Range: between 0 and 100
+
+
+
+
+_This document was updated on: Thursday, August 26, 2021_
\ No newline at end of file