Doc cleanup - add back newly generated types.md files

2025-12-10 14:57:57 +00:00 · 2021-08-09 19:20:15 -07:00 · 2021-08-09 19:20:15 -07:00 · bd0aa58da0
commit bd0aa58da0
parent 80c331a389
13 changed files with 437 additions and 29 deletions
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@ -7,29 +7,28 @@

 * [Schemas](openmetadata-apis/schemas/README.md)
  * [Types](openmetadata-apis/schemas/types/README.md)
-    * [Basic Type](openmetadata-apis/schemas/types/basic.md)
-    * [Collection Descriptor Type](openmetadata-apis/schemas/types/collectiondescriptor.md)
-    * [Daily Count Type](openmetadata-apis/schemas/types/dailycount.md)
-    * [Entity Reference Type](openmetadata-apis/schemas/types/entityreference.md)
-    * [Entity Usage Type](openmetadata-apis/schemas/types/entity-usage-type.md)
-    * [Jdbc Connection Type](openmetadata-apis/schemas/types/jdbcconnection.md)
-    * [Profile Type](openmetadata-apis/schemas/types/profile.md)
-    * [Schedule Type](openmetadata-apis/schemas/types/schedule.md)
-    * [Tag Label Type](openmetadata-apis/schemas/types/taglabel.md)
-    * [Usage Details Type](openmetadata-apis/schemas/types/usagedetails.md)
+    * [Basic](openmetadata-apis/schemas/types/basic.md)
+    * [Daily Count](openmetadata-apis/schemas/types/dailyDount.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/taglabel.md)
+    * [Usage Details](openmetadata-apis/schemas/types/usagedetails.md)
  * [Entities](openmetadata-apis/schemas/entities/README.md)
-    * [Bot Entity](openmetadata-apis/schemas/entities/bots.md)
-    * [Dashboard Entity](openmetadata-apis/schemas/entities/dashboard.md)
-    * [Database Entity](openmetadata-apis/schemas/entities/database.md)
-    * [Database Service Entity](openmetadata-apis/schemas/entities/databaseservice.md)
-    * [Feed Entity](openmetadata-apis/schemas/entities/thread.md)
-    * [Metrics Entity](openmetadata-apis/schemas/entities/metrics.md)
-    * [Pipeline Entity](openmetadata-apis/schemas/entities/pipeline.md)
-    * [Report Entity](openmetadata-apis/schemas/entities/report.md)
-    * [Table Entity](openmetadata-apis/schemas/entities/table.md)
-    * [Team Entity](openmetadata-apis/schemas/entities/team.md)
-    * [Tag Categoty Entity](openmetadata-apis/schemas/entities/tagcategory.md)
-    * [User entity](openmetadata-apis/schemas/entities/user.md)
+    * [Bot](openmetadata-apis/schemas/entities/bots.md)
+    * [Dashboard](openmetadata-apis/schemas/entities/data/dashboard.md)
+    * [Database](openmetadata-apis/schemas/entities/data/database.md)
+    * [Database Service](openmetadata-apis/schemas/entities/services/databaseservice.md)
+    * [Feed](openmetadata-apis/schemas/entities/feed/thread.md)
+    * [Metrics](openmetadata-apis/schemas/entities/data/metrics.md)
+    * [Pipeline](openmetadata-apis/schemas/entities/data/pipeline.md)
+    * [Report](openmetadata-apis/schemas/entities/data/report.md)
+    * [Table](openmetadata-apis/schemas/entities/data/table.md)
+    * [Team](openmetadata-apis/schemas/entities/team/team.md)
+    * [Tag Categoty](openmetadata-apis/schemas/entities/tags/tagcategory.md)
+    * [User](openmetadata-apis/schemas/entities/team/user.md)
 * [APIs](openmetadata-apis/apis/README.md)
  * [Overview](openmetadata-apis/apis/overview.md)

--- a/docs/openmetadata-apis/schemas/types/README.md
+++ b/docs/openmetadata-apis/schemas/types/README.md
@ -5,20 +5,20 @@ JSON schema supports many native types - `null`, `boolean`, `object`, `array`, `
 ## List of Schema Types
 {% page-ref page="basic.md" %}

-{% page-ref page="collectiondescriptor.md" %}
+{% page-ref page="collectionDescriptor.md" %}

-{% page-ref page="dailycount.md" %}
+{% page-ref page="dailyDount.md" %}

-{% page-ref page="entityreference.md" %}
+{% page-ref page="entityReference.md" %}

-{% page-ref page="entityusage.md" %}
+{% page-ref page="entityUsage.md" %}

-{% page-ref page="jdbcconnection.md" %}
+{% page-ref page="jdbcConnection.md" %}

 {% page-ref page="profile.md" %}

 {% page-ref page="schedule.md" %}

-{% page-ref page="taglabel.md" %}
+{% page-ref page="tagLabel.md" %}

-{% page-ref page="usagedetails.md" %}
+{% page-ref page="usageDetails.md" %}
--- a/docs/openmetadata-apis/schemas/types/auditLog.md
+++ b/docs/openmetadata-apis/schemas/types/auditLog.md
@ -0,0 +1,37 @@
+# Audit Log
+
+This schema defines type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeauditlog.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/method">method</b> `required`
+	 - HTTP Method used in a call.
+	 - Type: `string`
+	 - The value is restricted to the following: 
+		 1. _"POST"_
+		 2. _"PUT"_
+		 3. _"PATCH"_
+		 4. _"DELETE"_
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/responseCode">responseCode</b> `required`
+	 - HTTP response code for the api requested.
+	 - Type: `integer`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/path">path</b> `required`
+	 - Requested API Path.
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/userName">userName</b> `required`
+	 - Name of the user who requested for the API.
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/dateTime">dateTime</b>
+	 - Date which the api call is made.
+	 - &#36;ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/entityId">entityId</b> `required`
+	 - Entity Id that was modified by the operation.
+	 - &#36;ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json/properties/entityType">entityType</b> `required`
+	 - Entity Type that modified by the operation.
+	 - Type: `string`
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/basic.md
+++ b/docs/openmetadata-apis/schemas/types/basic.md
@ -0,0 +1,80 @@
+# Basic
+
+This schema defines basic common types that are used by other schemas.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypebasic.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json</b>
+
+
+
+## Definitions
+**_uuid_**
+
+ - Unique id used to identify an entity.
+ - Type: `string`
+ - String format must be a "uuid"
+
+
+**_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
+
+
+**_entityLink_**
+
+ - Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
+ - Type: `string`
+ - The value must match this pattern: `^<#E/\S+/\S+>$`
+
+
+**_timestamp_**
+
+ - Time stamp in unixTimeMillis
+ - Type: `string`
+ - String format must be a "utc-millisec"
+
+
+**_href_**
+
+ - href that points to a resource.
+ - Type: `string`
+ - String format must be a "uri"
+
+
+**_timeInterval_**
+
+ - Type: `object`
+ - **_Properties_**
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json/definitions/timeInterval/properties/start">start</b>
+		 - Start time in unixTimeMillis.
+		 - Type: `integer`
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json/definitions/timeInterval/properties/end">end</b>
+		 - End time in unixTimeMillis.
+		 - Type: `integer`
+
+
+**_duration_**
+
+ - Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'.
+ - Type: `string`
+
+
+**_date_**
+
+ - Date in ISO 8601 format in UTC time. 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"
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/collectionDescriptor.md
+++ b/docs/openmetadata-apis/schemas/types/collectionDescriptor.md
@ -0,0 +1,35 @@
+# Schema for collection descriptor
+
+Type used for capturing the details of a collection.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypecollectiondescriptor.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/properties/collection">collection</b>
+	 - &#36;ref: [#/definitions/collectionInfo](#/definitions/collectionInfo)
+
+
+## Definitions
+**_collectionInfo_**
+
+ - Collection Info.
+ - Type: `object`
+ - **_Properties_**
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/name">name</b>
+		 - Unique name that identifies a collection.
+		 - Type: `string`
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/documentation">documentation</b>
+		 - Description of collection.
+		 - Type: `string`
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/href">href</b>
+		 - URL of the API endpoint where given collections are available.
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json/definitions/collectionInfo/properties/images">images</b>
+		 - &#36;ref: [profile.json#/definitions/imageList](#profile.jsondefinitionsimagelist)
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/dailyCount.md
+++ b/docs/openmetadata-apis/schemas/types/dailyCount.md
@ -0,0 +1,17 @@
+# Daily count of some measurement
+
+This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypedailycount.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json/properties/count">count</b> `required`
+	 - Daily count of a measurement on the given date.
+	 - Type: `integer`
+	 - Range:  &ge; 0
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json/properties/date">date</b> `required`
+	 - &#36;ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate)
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/entityReference.md
+++ b/docs/openmetadata-apis/schemas/types/entityReference.md
@ -0,0 +1,36 @@
+# Entity Reference
+
+This schema defines the type Entity Reference used for referencing an entity.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeentityreference.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json/properties/id">id</b> `required`
+	 - Unique identifier that identifies an entity instance.
+	 - &#36;ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json/properties/type">type</b> `required`
+	 - Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json/properties/name">name</b>
+	 - Name of the entity instance.
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json/properties/description">description</b>
+	 - Optional description of entity.
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json/properties/href">href</b>
+	 - Link to the entity resource.
+	 - &#36;ref: [basic.json#/definitions/href](#basic.jsondefinitionshref)
+
+
+## Definitions
+**_entityReferenceList_**
+
+ - Type: `array`
+	 - **_Items_**
+	 - &#36;ref: [entityReference.json](#entityreference.json)
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/entityUsage.md
+++ b/docs/openmetadata-apis/schemas/types/entityUsage.md
@ -0,0 +1,19 @@
+# Usage details of an entity
+
+This schema defines type used for capturing usage details of an entity.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeentityusage.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json/properties/entity">entity</b> `required`
+	 - Entity for which usage is returned.
+	 - &#36;ref: [entityReference.json](#entityreference.json)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json/properties/usage">usage</b> `required`
+	 - List usage details per day.
+	 - Type: `array`
+		 - **_Items_**
+		 - &#36;ref: [usageDetails.json](#usagedetails.json)
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/jdbcConnection.md
+++ b/docs/openmetadata-apis/schemas/types/jdbcConnection.md
@ -0,0 +1,51 @@
+# JDBC connection
+
+JDBC connection information
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypejdbcconnection.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/properties/driverClass">driverClass</b> `required`
+	 - JDBC driver class
+	 - &#36;ref: [#/definitions/driverClass](#/definitions/driverClass)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/properties/connectionUrl">connectionUrl</b> `required`
+	 - JDBC connection URL
+	 - &#36;ref: [#/definitions/connectionUrl](#/definitions/connectionUrl)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/properties/userName">userName</b> `required`
+	 - Login user name.
+	 - Type: `string`
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/properties/password">password</b> `required`
+	 - Login password.
+	 - Type: `string`
+
+
+## Definitions
+**_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_**
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/definitions/jdbcInfo/properties/driverClass">driverClass</b> `required`
+		 - &#36;ref: [#/definitions/driverClass](#/definitions/driverClass)
+		 - Default: _"com.amazon.redshift.jdbc42.Driver"_
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/definitions/jdbcInfo/properties/connectionUrl">connectionUrl</b> `required`
+		 - &#36;ref: [#/definitions/connectionUrl](#/definitions/connectionUrl)
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/profile.md
+++ b/docs/openmetadata-apis/schemas/types/profile.md
@ -0,0 +1,44 @@
+# Profile
+
+This schema defines type used to capture profile of a user, team, or an organization.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeprofile.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/properties/images">images</b>
+	 - &#36;ref: [#/definitions/imageList](#/definitions/imageList)
+
+
+## Definitions
+**_imageList_**
+
+ - Links to list of images of varying resolutions/sizes.
+ - Type: `object`
+ - **_Properties_**
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image">image</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image24">image24</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image32">image32</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image48">image48</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image72">image72</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image192">image192</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image512">image512</b>
+		 - Type: `string`
+		 - String format must be a "uri"
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/schedule.md
+++ b/docs/openmetadata-apis/schemas/types/schedule.md
@ -0,0 +1,17 @@
+# Type used for schedule with start time and repeat frequency
+
+This schema defines type used for Schedule with start time and repeat frequency.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeschedule.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json/properties/startDate">startDate</b>
+	 - Start date and time of the schedule.
+	 - &#36;ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json/properties/repeatFrequency">repeatFrequency</b>
+	 - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'
+	 - &#36;ref: [basic.json#/definitions/duration](#basic.jsondefinitionsduration)
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/tagLabel.md
+++ b/docs/openmetadata-apis/schemas/types/tagLabel.md
@ -0,0 +1,31 @@
+# Tag Label
+
+This schema defines type used for labeling an entity or an entity field with a Tag.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypetaglabel.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json/properties/tagFQN">tagFQN</b>
+	 - Type: `string`
+	 - Length:  &le; 45
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json/properties/labelType">labelType</b>
+	 - Type: `string`
+	 - The value is restricted to the following: 
+		 1. _"Manual"_
+		 2. _"Propagated"_
+		 3. _"Automated"_
+		 4. _"Derived"_
+	 - Default: _"Manual"_
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json/properties/state">state</b>
+	 - Type: `string`
+	 - The value is restricted to the following: 
+		 1. _"Suggested"_
+		 2. _"Confirmed"_
+	 - Default: _"Confirmed"_
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json/properties/href">href</b>
+	 - Link to the tag resource.
+	 - &#36;ref: [basic.json#/definitions/href](#basic.jsondefinitionshref)
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_
--- a/docs/openmetadata-apis/schemas/types/usageDetails.md
+++ b/docs/openmetadata-apis/schemas/types/usageDetails.md
@ -0,0 +1,42 @@
+# Type used to return usage details of an entity
+
+This schema defines type used for capturing usage details of an entity.
+
+<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeusagedetails.json">&#36;id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json</b>
+
+Type: `object`
+
+## Properties
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/properties/dailyStats">dailyStats</b> `required`
+	 - Daily usage stats of a data asset on the start date.
+	 - &#36;ref: [#/definitions/usageStats](#/definitions/usageStats)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/properties/weeklyStats">weeklyStats</b>
+	 - Weekly (last 7 days) rolling usage stats of a data asset on the start date.
+	 - &#36;ref: [#/definitions/usageStats](#/definitions/usageStats)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/properties/monthlyStats">monthlyStats</b>
+	 - Monthly (last 30 days) rolling usage stats of a data asset on the start date.
+	 - &#36;ref: [#/definitions/usageStats](#/definitions/usageStats)
+ - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/properties/date">date</b> `required`
+	 - Date in UTC time.
+	 - &#36;ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate)
+
+
+## Definitions
+**_usageStats_**
+
+ - Type used to return usage statistics
+ - Type: `object`
+ - This schema <u>does not</u> accept additional properties.
+ - **_Properties_**
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/definitions/usageStats/properties/count">count</b> `required`
+		 - Usage count of a data asset on the start date.
+		 - Type: `integer`
+		 - Range:  &ge; 0
+	 - <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/definitions/usageStats/properties/percentileRank">percentileRank</b>
+		 - Optional daily percentile rank data asset use when relevant.
+		 - Type: `number`
+		 - Range: between 0 and 100
+
+
+
+_Generated with [json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_ _Mon Aug 09 2021 19:12:30 GMT-0700 (Pacific Daylight Time)_