From e50678351c573cb19ec7069dc505b122737ec48b Mon Sep 17 00:00:00 2001 From: sureshms Date: Wed, 11 Aug 2021 09:42:34 -0700 Subject: [PATCH] Doc cleanup - fixing gitbook rendering issues - part8 --- .../json/schema/entity/data/dashboard.json | 2 +- .../json/schema/entity/data/database.json | 2 +- .../json/schema/entity/data/metrics.json | 2 +- .../json/schema/entity/data/pipeline.json | 2 +- .../json/schema/entity/data/report.json | 2 +- .../json/schema/entity/data/table.json | 20 +- .../json/schema/entity/feed/thread.json | 2 +- .../json/schema/entity/tags/tagCategory.json | 7 +- .../json/schema/entity/teams/team.json | 2 +- .../json/schema/entity/teams/user.json | 2 +- .../resources/json/schema/type/auditLog.json | 2 +- .../json/schema/type/dailyCount.json | 2 +- .../json/schema/type/entityReference.json | 2 +- .../resources/json/schema/type/profile.json | 2 +- .../resources/json/schema/type/schedule.json | 2 +- .../resources/json/schema/type/tagLabel.json | 4 +- .../json/schema/type/usageDetails.json | 2 +- docs/SUMMARY.md | 23 +- .../schemas/entities/README.md | 22 +- .../schemas/entities/bots.md | 27 -- .../schemas/entities/dashboard.md | 37 --- .../schemas/entities/data/dashboard.md | 35 +++ .../schemas/entities/data/database.md | 47 ++++ .../schemas/entities/data/metrics.md | 35 +++ .../schemas/entities/data/pipeline.md | 32 +++ .../schemas/entities/data/report.md | 35 +++ .../schemas/entities/data/table.md | 252 ++++++++++++++++++ .../schemas/entities/database-service.md | 48 ---- .../schemas/entities/database.md | 47 ---- .../schemas/entities/feed/thread.md | 47 ++++ .../schemas/entities/metrics.md | 37 --- .../schemas/entities/pipeline.md | 34 --- .../schemas/entities/report.md | 37 --- .../entities/services/database-service.md | 48 ++++ .../schemas/entities/table.md | 242 ----------------- .../schemas/entities/tag-category.md | 49 ---- .../schemas/entities/tags/tag-category.md | 52 ++++ .../schemas/entities/team.md | 44 --- .../schemas/entities/teams/team.md | 44 +++ .../schemas/entities/teams/user.md | 60 +++++ .../schemas/entities/thread.md | 47 ---- .../schemas/entities/user.md | 60 ----- .../schemas/types/audit-log.md | 58 ++-- docs/openmetadata-apis/schemas/types/basic.md | 80 +++--- .../schemas/types/daily-count.md | 20 +- .../schemas/types/entity-reference.md | 44 +-- .../schemas/types/entity-usage.md | 22 +- .../schemas/types/jdbc-connection.md | 60 +++-- .../schemas/types/profile.md | 60 ++--- .../schemas/types/schedule.md | 20 +- .../schemas/types/tag-label.md | 48 ++-- .../schemas/types/usage-details.md | 58 ++-- 52 files changed, 979 insertions(+), 991 deletions(-) delete mode 100644 docs/openmetadata-apis/schemas/entities/bots.md delete mode 100644 docs/openmetadata-apis/schemas/entities/dashboard.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/dashboard.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/database.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/metrics.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/pipeline.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/report.md create mode 100644 docs/openmetadata-apis/schemas/entities/data/table.md delete mode 100644 docs/openmetadata-apis/schemas/entities/database-service.md delete mode 100644 docs/openmetadata-apis/schemas/entities/database.md create mode 100644 docs/openmetadata-apis/schemas/entities/feed/thread.md delete mode 100644 docs/openmetadata-apis/schemas/entities/metrics.md delete mode 100644 docs/openmetadata-apis/schemas/entities/pipeline.md delete mode 100644 docs/openmetadata-apis/schemas/entities/report.md create mode 100644 docs/openmetadata-apis/schemas/entities/services/database-service.md delete mode 100644 docs/openmetadata-apis/schemas/entities/table.md delete mode 100644 docs/openmetadata-apis/schemas/entities/tag-category.md create mode 100644 docs/openmetadata-apis/schemas/entities/tags/tag-category.md delete mode 100644 docs/openmetadata-apis/schemas/entities/team.md create mode 100644 docs/openmetadata-apis/schemas/entities/teams/team.md create mode 100644 docs/openmetadata-apis/schemas/entities/teams/user.md delete mode 100644 docs/openmetadata-apis/schemas/entities/thread.md delete mode 100644 docs/openmetadata-apis/schemas/entities/user.md diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json index dabf5e3a573..2cb88ab3412 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Dashboard", - "description": "This schema defines the Dashboard entity.", + "description": "This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KIPs. They are updated in real-time and allow interactive data exploration.", "type": "object", "properties" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json index 949c416840a..23838906448 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Database", - "description": "This schema defines the Database entity. A database is a collection of schemas. They are also referred to as Database Catalog.", + "description": "This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables.", "type": "object", "definitions": { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json index 60ec8de50a3..769a83509c1 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Metrics", - "description": "This schema defines the Metrics entity.", + "description": "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`.", "type": "object", "properties" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json index c28af5cd22a..659890d9e81 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Pipeline", - "description": "This schema defines the Pipeline entity.", + "description": "This schema defines the Pipeline entity. A pipeline enables 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.", "type": "object", "properties" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json index 5871c880135..491c6f82fed 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Report", - "description": "This schema defines the Report entity.", + "description": "This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and in visual form.", "type": "object", "properties" : { 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 65f81868ff3..a3edae50b50 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 @@ -2,13 +2,13 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Table", - "description": "This schema defines the Table entity. A database contains a collection of schemas. Schemas contain Tables, Views, etc. OpenMetadata does not have a separate hierarchy for Schema. Both Table and Schema are captured in this entity.", + "description": "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.", "type": "object", "javaType": "org.openmetadata.catalog.entity.data.Table", "definitions": { "tableType": { "javaType": "org.openmetadata.catalog.type.TableType", - "description": "This schema defines the type for a column in a table.", + "description": "This schema defines the type used for describing different types of tables.", "type": "string", "enum": [ "Regular", @@ -117,7 +117,7 @@ "pattern": "^[^.]*$" }, "tableName": { - "description": "Local name (not fully qualified name) of the table.", + "description": "Local name (not fully qualified name) of a table.", "type": "string", "minLength": 1, "maxLength": 64, @@ -173,7 +173,7 @@ "columnJoins": { "type": "object", "javaType": "org.openmetadata.catalog.type.ColumnJoin", - "description": "This schema defines the type to capture how frequently a column are joined with columns in the other tables.", + "description": "This schema defines the type to capture how frequently a column is joined with columns in the other tables.", "properties": { "columnName": { "$ref": "#/definitions/columnName" @@ -199,7 +199,7 @@ "tableJoins": { "type": "object", "javaType": "org.openmetadata.catalog.type.TableJoins", - "description": "This schema defines the type to capture how columns in this table are joined with columns in the other tables.", + "description": "This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.", "properties": { "startDate": { "description": "Date can be only from today going back to last 29 days.", @@ -221,7 +221,7 @@ "tableData": { "type": "object", "javaType": "org.openmetadata.catalog.type.TableData", - "description": "This schema defines the type to capture rows of sample data for the table.", + "description": "This schema defines the type to capture rows of sample data for a table.", "properties": { "columns": { "description": "List of local column names (not fully qualified column names) of the table.", @@ -248,11 +248,11 @@ "$ref": "../../type/basic.json#/definitions/uuid" }, "name": { - "description": "Name of the table. Expected to be unique within a database.", + "description": "Name of a table. Expected to be unique within a database.", "$ref": "#/definitions/tableName" }, "description": { - "description": "Description of the table.", + "description": "Description of a table.", "type": "string" }, "href": { @@ -263,7 +263,7 @@ "$ref": "#/definitions/tableType" }, "fullyQualifiedName": { - "description": "Fully qualified name of the table in the form `serviceName.databaseName.tableName`.", + "description": "Fully qualified name of a table in the form `serviceName.databaseName.tableName`.", "type": "string" }, "columns": { @@ -314,7 +314,7 @@ "default": null }, "sampleData": { - "description": "Sample data for the table.", + "description": "Sample data for a table.", "$ref": "#/definitions/tableData", "default": null } diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json b/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json index e471f38fd4a..8502df23236 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Thread", - "description": "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** created by 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.", + "description": "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.", "type": "object", "definitions": { 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 dacba34b6a9..dda71d36663 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 @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Tag Category", - "description": "This schema defines the Tag Category entity. A Tag Category has one more children tags called Primary Tags. Primary Tags can have children Tags called Secondary Tags. Only two levels of tags are supported currently.", + "description": "This schema defines the Tag Category entity. A Tag Category has one more children tags called Primary Tags. Primary Tags can further have children Tags called Secondary Tags. Only two levels of tags are supported currently.", "type": "object", "javaType": "org.openmetadata.catalog.type.TagCategory", "definitions": { @@ -33,6 +33,7 @@ "tag": { "javaType": "org.openmetadata.catalog.type.Tag", "properties": { + "description" : "Name of the tag", "name": { "$ref": "#/definitions/tagName" }, @@ -58,14 +59,14 @@ "default": false }, "associatedTags": { - "description": "Fully qualified names of tags associated with this tag.", + "description": "Fully qualified names of tags associated with this tag. Associated tags captures relationship of one tag to another automatically. As an example a tag 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship.", "type": "array", "items": { "type": "string" } }, "children": { - "description": "Tags under this tag group or empty for tags at leaf level.", + "description": "Tags under this tag group or empty for tags at the leaf level.", "type": "array", "items": { "$ref": "#/definitions/tag" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json b/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json index 497b95cb82a..d9e49abbf4e 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Team", - "description": "This schema defines the Team entity. A Team is a group of zero or more users and can have ownership of data assets.", + "description": "This schema defines the Team entity. A Team is a group of zero or more users. Teams can own zero or more data assets.", "type": "object", "definitions" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json b/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json index 50514e79cbb..3c69d6d7b92 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "User", - "description": "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 and own zero or more data asset entities. A user can also follow zero or more data asset entities.", + "description": "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.", "type": "object", "definitions": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json b/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json index fc69b206cfc..f7686ec2245 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Audit Log", - "description": "This schema defines the type for Audit Log to capture the audit trail of POST, PUT, and PATCH API operations.", + "description": "This schema defines Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations.", "type": "object", "properties" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json b/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json index 3c4b0b8955a..e4e2d0719e7 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Daily count of some measurement", - "description": "This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins.", + "description": "This schema defines the type for reporting the daily count of some measurement. Example - number of times a table was used in queries per day.", "type" : "object", "properties": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json b/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json index 9be1444d310..85b6594df04 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Entity Reference", - "description": "This schema defines the type EntityReference used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.", + "description": "This schema defines EntityReference type used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.", "type": "object", "javaType": "org.openmetadata.catalog.type.EntityReference", "definitions": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/profile.json b/catalog-rest-service/src/main/resources/json/schema/type/profile.json index 8f80c6552c4..ce848317d5c 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/profile.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/profile.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Profile", - "description": "This schema defines the type used to capture profile of a user, team, or an organization.", + "description": "This schema defines the type for profile of a user, team, or an organization.", "type": "object", "javaType": "org.openmetadata.catalog.type.Profile", "definitions": { 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 78e5fab51be..5b1ffdafc6d 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 @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Type used for schedule with start time and repeat frequency", - "description": "This schema defines the type used for schedule with start time and repeat frequency.", + "description": "This schema defines the type used for schedule. Schedule has a start time and repeat frequency.", "type": "object", "javaType": "org.openmetadata.catalog.type.Schedule", "properties": { 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 15e459c027a..86fc2565842 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 @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Tag Label", - "description": "This schema defines the type used for labeling an entity with a Tag.", + "description": "This schema defines the type for labeling an entity with a Tag.", "type": "object", "javaType": "org.openmetadata.catalog.type.TagLabel", "properties": { @@ -11,6 +11,7 @@ "maxLength": 45 }, "labelType": { + "description" : "Label type describe how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using 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", "enum": [ "Manual", @@ -21,6 +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'", "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 10678b93318..2c71e4bd092 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 @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Type used to return usage details of an entity", - "description": "This schema defines the type used for capturing usage details. Based on usage, daily, weekly, and monthly aggregation of usage is provided along with the percentile rank based on the usage.", + "description": "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.", "type": "object", "javaType": "org.openmetadata.catalog.type.UsageDetails", "definitions": { diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index c524fe78ab9..badbd0ced2f 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -4,7 +4,6 @@ * [Take it for a spin](take-it-for-a-spin.md) ## OpenMetadata APIs - * [Schemas](openmetadata-apis/schemas/README.md) * [Types](openmetadata-apis/schemas/types/README.md) * [Basic](openmetadata-apis/schemas/types/basic.md) @@ -19,17 +18,17 @@ * [Usage Details](openmetadata-apis/schemas/types/usage-details.md) * [Entities](openmetadata-apis/schemas/entities/README.md) * [Bot](openmetadata-apis/schemas/entities/bots.md) - * [Dashboard](openmetadata-apis/schemas/entities/dashboard.md) - * [Database](openmetadata-apis/schemas/entities/database.md) - * [Database Service](openmetadata-apis/schemas/entities/database-service.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) - * [User](openmetadata-apis/schemas/entities/user.md) + * [Dashboard](openmetadata-apis/schemas/entities/data/dashboard.md) + * [Database](openmetadata-apis/schemas/entities/data/database.md) + * [Database Service](openmetadata-apis/schemas/entities/services/database-service.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/teams/team.md) + * [Tag Category](openmetadata-apis/schemas/entities/tags/tag-category.md) + * [User](openmetadata-apis/schemas/entities/teams/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 b61ef7dae7b..099332bd4f0 100644 --- a/docs/openmetadata-apis/schemas/entities/README.md +++ b/docs/openmetadata-apis/schemas/entities/README.md @@ -71,21 +71,25 @@ Metadata system has the following core entities: {% page-ref page="bots.md" %} -{% page-ref page="dashboard.md" %} +{% page-ref page="data/dashboard.md" %} -{% page-ref page="database.md" %} +{% page-ref page="data/database.md" %} -{% page-ref page="thread.md" %} +{% page-ref page="services/database-service.md" %} -{% page-ref page="metrics.md" %} +{% page-ref page="feed/thread.md" %} -{% page-ref page="pipeline.md" %} +{% page-ref page="data/metrics.md" %} -{% page-ref page="report.md" %} +{% page-ref page="data/pipeline.md" %} -{% page-ref page="table.md" %} +{% page-ref page="data/report.md" %} -{% page-ref page="team.md" %} +{% page-ref page="data/table.md" %} -{% page-ref page="user.md" %} +{% page-ref page="teams/team.md" %} + +{% page-ref page="teams/user.md" %} + +{% page-ref page="tags/tag-category.md" %} diff --git a/docs/openmetadata-apis/schemas/entities/bots.md b/docs/openmetadata-apis/schemas/entities/bots.md deleted file mode 100644 index 283b968da57..00000000000 --- a/docs/openmetadata-apis/schemas/entities/bots.md +++ /dev/null @@ -1,27 +0,0 @@ -# Bot - -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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json) - -Type: `object` - -## Properties - -* **id** - * Unique identifier of a bot instance. - * $ref: [../type/basic.json\#/definitions/uuid](bots.md#..typebasic.jsondefinitionsuuid) -* **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](bots.md#..typebasic.jsondefinitionshref) - diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md deleted file mode 100644 index 6c69d44d1d6..00000000000 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ /dev/null @@ -1,37 +0,0 @@ -# Dashboard - -This schema defines the Dashboard entity. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier that identifies a dashboard instance. - * $ref: [../../type/basic.json\#/definitions/uuid](dashboard.md#....typebasic.jsondefinitionsuuid) -* **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](dashboard.md#....typebasic.jsondefinitionshref) -* **owner** - * Owner of this dashboard. - * $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json) -* **service** `required` - * Link to service where this dashboard is hosted in. - * $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json) -* **usageSummary** - * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](dashboard.md#....typeusagedetails.json) - diff --git a/docs/openmetadata-apis/schemas/entities/data/dashboard.md b/docs/openmetadata-apis/schemas/entities/data/dashboard.md new file mode 100644 index 00000000000..1749dc90d5a --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/dashboard.md @@ -0,0 +1,35 @@ +# Dashboard + +This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KIPs. They are updated in real-time and allow interactive data exploration. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies a dashboard instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - 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](#....typebasic.jsondefinitionshref) + - owner + - Owner of this dashboard. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - service `required` + - Link to service where this dashboard is hosted in. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - usageSummary + - Latest usage information for this database. + - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) diff --git a/docs/openmetadata-apis/schemas/entities/data/database.md b/docs/openmetadata-apis/schemas/entities/data/database.md new file mode 100644 index 00000000000..37bb814ccbf --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/database.md @@ -0,0 +1,47 @@ +# Database + +This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json + +Type: `object` + +## Properties + - id + - Unique identifier that identifies this database instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - name `required` + - Name that identifies the database. + - $ref: [#/definitions/databaseName](#/definitions/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](#....typebasic.jsondefinitionshref) + - owner + - Owner of this database. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - service `required` + - Link to the database cluster/service where this database is hosted in. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - usageSummary + - Latest usage information for this database. + - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) + - tables + - References to tables in the database. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + + +## Types definitions in this schema +**databaseName** + + - Name that identifies the database. + - Type: `string` + - The value must match this pattern: `^[^.]*$` + - Length: between 1 and 64 + + diff --git a/docs/openmetadata-apis/schemas/entities/data/metrics.md b/docs/openmetadata-apis/schemas/entities/data/metrics.md new file mode 100644 index 00000000000..fa735ce7591 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/metrics.md @@ -0,0 +1,35 @@ +# Metrics + +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies this metrics instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - 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](#....typebasic.jsondefinitionshref) + - owner + - Owner of this metrics. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - service `required` + - Link to service where this metrics is hosted in. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - usageSummary + - Latest usage information for this database. + - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) diff --git a/docs/openmetadata-apis/schemas/entities/data/pipeline.md b/docs/openmetadata-apis/schemas/entities/data/pipeline.md new file mode 100644 index 00000000000..05e6c762dd0 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/pipeline.md @@ -0,0 +1,32 @@ +# Pipeline + +This schema defines the Pipeline entity. A pipeline enables 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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies a pipeline instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - 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](#....typebasic.jsondefinitionshref) + - owner + - Owner of this pipeline. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - service `required` + - Link to service where this pipeline is hosted in. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) diff --git a/docs/openmetadata-apis/schemas/entities/data/report.md b/docs/openmetadata-apis/schemas/entities/data/report.md new file mode 100644 index 00000000000..b05b444e676 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/report.md @@ -0,0 +1,35 @@ +# Report + +This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and in visual form. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies this report. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - name `required` + - Name that identifies the 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](#....typebasic.jsondefinitionshref) + - owner + - Owner of this pipeline. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - service `required` + - Link to service where this report is hosted in. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - usageSummary + - Latest usage information for this database. + - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) diff --git a/docs/openmetadata-apis/schemas/entities/data/table.md b/docs/openmetadata-apis/schemas/entities/data/table.md new file mode 100644 index 00000000000..0541e808591 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/data/table.md @@ -0,0 +1,252 @@ +# Table + +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier of this table instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - name `required` + - Name of a table. Expected to be unique within a database. + - $ref: [#/definitions/tableName](#/definitions/tableName) + - description + - Description of a table. + - Type: `string` + - href + - Link to this table resource. + - $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref) + - tableType + - $ref: [#/definitions/tableType](#/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](#/definitions/column) + - tableConstraints + - Table constraints. + - Type: `array` + - **Items** + - $ref: [#/definitions/tableConstraint](#/definitions/tableConstraint) + - usageSummary + - Latest usage information for this table. + - $ref: [../../type/usageDetails.json](#....typeusagedetails.json) + - owner + - Owner of this table. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - followers + - Followers of this table. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + - database + - Reference to Database that contains this table. + - $ref: [../../type/entityReference.json](#....typeentityreference.json) + - tags + - Tags for this table. + - Type: `array` + - **Items** + - $ref: [../../type/tagLabel.json](#....typetaglabel.json) + - joins + - Details of other tables this table is frequently joined with. + - $ref: [#/definitions/tableJoins](#/definitions/tableJoins) + - sampleData + - Sample data for a table. + - $ref: [#/definitions/tableData](#/definitions/tableData) + + +## Types definitions in this schema +**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"_ + + +**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"_ + + +**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"_ + + +**tableConstraint** + + - 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** + + - Local name (not fully qualified name) of the column. + - Type: `string` + - The value must match this pattern: `^[^.]*$` + - Length: between 1 and 64 + + +**tableName** + + - Local name (not fully qualified name) of a table. + - Type: `string` + - The value must match this pattern: `^[^.]*$` + - Length: between 1 and 64 + + +**fullyQualifiedColumnName** + + - Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`. + - Type: `string` + - Length: between 1 and 256 + + +**column** + + - This schema defines the type for a column in a table. + - Type: `object` + - **Properties** + - name `required` + - $ref: [#/definitions/columnName](#/definitions/columnName) + - columnDataType `required` + - Data type of the column (int, date etc.). + - $ref: [#/definitions/columnDataType](#/definitions/columnDataType) + - description + - Description of the column. + - Type: `string` + - fullyQualifiedName + - $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName) + - tags + - Tags associated with the column. + - Type: `array` + - **Items** + - $ref: [../../type/tagLabel.json](#....typetaglabel.json) + - columnConstraint + - Column level constraint. + - $ref: [#/definitions/columnConstraint](#/definitions/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](#/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](#/definitions/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](#....typebasic.jsondefinitionsdate) + - dayCount + - Type: `integer` + - Default: `1` + - columnJoins + - Type: `array` + - **Items** + - $ref: [#/definitions/columnJoins](#/definitions/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](#/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` + + 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 95a32999dcd..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. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier of this database service instance. - * $ref: [../../type/basic.json\#/definitions/uuid](database-service.md#....typebasic.jsondefinitionsuuid) -* **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#/definitions/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](database-service.md#....typebasic.jsondefinitionshref) -* **jdbc** `required` - * JDBC connection information - * $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo](database-service.md#....typejdbcconnection.jsondefinitionsjdbcinfo) -* **ingestionSchedule** - * Schedule for running metadata ingestion jobs. - * $ref: [../../type/schedule.json](database-service.md#....typeschedule.json) - -## Types defined 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 deleted file mode 100644 index 858ca2bb60c..00000000000 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ /dev/null @@ -1,47 +0,0 @@ -# Database - -This schema defines the Database entity. A database is a collection of schemas. They are also referred to as Database Catalog. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json) - -Type: `object` - -## Properties - -* **id** - * Unique identifier that identifies this database instance. - * $ref: [../../type/basic.json\#/definitions/uuid](database.md#....typebasic.jsondefinitionsuuid) -* **name** `required` - * Name that identifies the database. - * $ref: [\#/definitions/databaseName](database.md#/definitions/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](database.md#....typebasic.jsondefinitionshref) -* **owner** - * Owner of this database. - * $ref: [../../type/entityReference.json](database.md#....typeentityreference.json) -* **service** `required` - * Link to the database cluster/service where this database is hosted in. - * $ref: [../../type/entityReference.json](database.md#....typeentityreference.json) -* **usageSummary** - * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](database.md#....typeusagedetails.json) -* **tables** - * References to tables in the database. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](database.md#....typeentityreference.jsondefinitionsentityreferencelist) - -## Types defined in this schema - -**databaseName** - -* Name that identifies the database. -* Type: `string` -* The value must match this pattern: `^[^.]*$` -* Length: between 1 and 64 - diff --git a/docs/openmetadata-apis/schemas/entities/feed/thread.md b/docs/openmetadata-apis/schemas/entities/feed/thread.md new file mode 100644 index 00000000000..4e6e7b6629a --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/feed/thread.md @@ -0,0 +1,47 @@ +# 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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier that identifies an entity instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - href + - Link to the resource corresponding to this entity. + - $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref) + - 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](#....typebasic.jsondefinitionsentitylink) + - addressedTo + - User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}. + - $ref: [../../type/basic.json#/definitions/entityLink](#....typebasic.jsondefinitionsentitylink) + - posts `required` + - Type: `array` + - **Items** + - $ref: [#/definitions/post](#/definitions/post) + + +## Types definitions in this schema +**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](#....typebasic.jsondefinitionsuuid) + + diff --git a/docs/openmetadata-apis/schemas/entities/metrics.md b/docs/openmetadata-apis/schemas/entities/metrics.md deleted file mode 100644 index f6b5dc70ec4..00000000000 --- a/docs/openmetadata-apis/schemas/entities/metrics.md +++ /dev/null @@ -1,37 +0,0 @@ -# Metrics - -This schema defines the Metrics entity. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier that identifies this metrics instance. - * $ref: [../../type/basic.json\#/definitions/uuid](metrics.md#....typebasic.jsondefinitionsuuid) -* **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](metrics.md#....typebasic.jsondefinitionshref) -* **owner** - * Owner of this metrics. - * $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json) -* **service** `required` - * Link to service where this metrics is hosted in. - * $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json) -* **usageSummary** - * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](metrics.md#....typeusagedetails.json) - diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md deleted file mode 100644 index 58b411076d1..00000000000 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ /dev/null @@ -1,34 +0,0 @@ -# Pipeline - -This schema defines the Pipeline entity. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier that identifies a pipeline instance. - * $ref: [../../type/basic.json\#/definitions/uuid](pipeline.md#....typebasic.jsondefinitionsuuid) -* **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](pipeline.md#....typebasic.jsondefinitionshref) -* **owner** - * Owner of this pipeline. - * $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json) -* **service** `required` - * Link to service where this pipeline is hosted in. - * $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json) - diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md deleted file mode 100644 index 79120cdd31d..00000000000 --- a/docs/openmetadata-apis/schemas/entities/report.md +++ /dev/null @@ -1,37 +0,0 @@ -# Report - -This schema defines the Report entity. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier that identifies this report. - * $ref: [../../type/basic.json\#/definitions/uuid](report.md#....typebasic.jsondefinitionsuuid) -* **name** `required` - * Name that identifies the 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](report.md#....typebasic.jsondefinitionshref) -* **owner** - * Owner of this pipeline. - * $ref: [../../type/entityReference.json](report.md#....typeentityreference.json) -* **service** `required` - * Link to service where this report is hosted in. - * $ref: [../../type/entityReference.json](report.md#....typeentityreference.json) -* **usageSummary** - * Latest usage information for this database. - * $ref: [../../type/usageDetails.json](report.md#....typeusagedetails.json) - diff --git a/docs/openmetadata-apis/schemas/entities/services/database-service.md b/docs/openmetadata-apis/schemas/entities/services/database-service.md new file mode 100644 index 00000000000..7db6d676527 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/services/database-service.md @@ -0,0 +1,48 @@ +# 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. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json + +Type: `object` + +## Properties + - id `required` + - Unique identifier of this database service instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - 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](#/definitions/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](#....typebasic.jsondefinitionshref) + - jdbc `required` + - JDBC connection information + - $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](#....typejdbcconnection.jsondefinitionsjdbcinfo) + - ingestionSchedule + - Schedule for running metadata ingestion jobs. + - $ref: [../../type/schedule.json](#....typeschedule.json) + + +## 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/table.md b/docs/openmetadata-apis/schemas/entities/table.md deleted file mode 100644 index 39ae879cb48..00000000000 --- a/docs/openmetadata-apis/schemas/entities/table.md +++ /dev/null @@ -1,242 +0,0 @@ -# Table - -This schema defines the Table entity. A database contains a collection of schemas. Schemas contain Tables, Views, etc. OpenMetadata does not have a separate hierarchy for Schema. Both Table and Schema are captured in this entity. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier of this table instance. - * $ref: [../../type/basic.json\#/definitions/uuid](table.md#....typebasic.jsondefinitionsuuid) -* **name** `required` - * Name of the table. Expected to be unique within a database. - * $ref: [\#/definitions/tableName](table.md#/definitions/tableName) -* **description** - * Description of the table. - * Type: `string` -* **href** - * Link to this table resource. - * $ref: [../../type/basic.json\#/definitions/href](table.md#....typebasic.jsondefinitionshref) -* **tableType** - * $ref: [\#/definitions/tableType](table.md#/definitions/tableType) -* **fullyQualifiedName** - * Fully qualified name of the table in the form `serviceName.databaseName.tableName`. - * Type: `string` -* **columns** `required` - * Columns in this table. - * Type: `array` - * **Items** - * $ref: [\#/definitions/column](table.md#/definitions/column) -* **tableConstraints** - * Table constraints. - * Type: `array` - * **Items** - * $ref: [\#/definitions/tableConstraint](table.md#/definitions/tableConstraint) -* **usageSummary** - * Latest usage information for this table. - * $ref: [../../type/usageDetails.json](table.md#....typeusagedetails.json) -* **owner** - * Owner of this table. - * $ref: [../../type/entityReference.json](table.md#....typeentityreference.json) -* **followers** - * Followers of this table. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](table.md#....typeentityreference.jsondefinitionsentityreferencelist) -* **database** - * Reference to Database that contains this table. - * $ref: [../../type/entityReference.json](table.md#....typeentityreference.json) -* **tags** - * Tags for this table. - * Type: `array` - * **Items** - * $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json) -* **joins** - * Details of other tables this table is frequently joined with. - * $ref: [\#/definitions/tableJoins](table.md#/definitions/tableJoins) -* **sampleData** - * Sample data for the table. - * $ref: [\#/definitions/tableData](table.md#/definitions/tableData) - -## Types defined in this schema - -**tableType** - -* This schema defines the type for a column in a table. -* Type: `string` -* The value is restricted to the following: - 1. _"Regular"_ - 2. _"External"_ - 3. _"View"_ - 4. _"SecureView"_ - 5. _"MaterializedView"_ - -**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"_ - -**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"_ - -**tableConstraint** - -* 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** - -* Local name \(not fully qualified name\) of the column. -* Type: `string` -* The value must match this pattern: `^[^.]*$` -* Length: between 1 and 64 - -**tableName** - -* Local name \(not fully qualified name\) of the table. -* Type: `string` -* The value must match this pattern: `^[^.]*$` -* Length: between 1 and 64 - -**fullyQualifiedColumnName** - -* Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`. -* Type: `string` -* Length: between 1 and 256 - -**column** - -* 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` - -**columnJoins** - -* This schema defines the type to capture how frequently a column are 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` - -**tableJoins** - -* This schema defines the type to capture 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** - -* This schema defines the type to capture rows of sample data for the 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` - 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 2a5dfdcbb2f..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 has one more children tags called Primary Tags. Primary Tags can have children Tags called Secondary Tags. Only two levels of tags are supported currently. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json) - -Type: `object` - -This schema does not accept additional properties. - -## Properties - -* **name** `required` - * $ref: [\#/definitions/tagName](tag-category.md#/definitions/tagName) -* **description** `required` - * Description of the tag category. - * Type: `string` -* **categoryType** `required` - * $ref: [\#/definitions/tagCategoryType](tag-category.md#/definitions/tagCategoryType) -* **href** - * Link to the resource corresponding to the tag category. - * $ref: [../../type/basic.json\#/definitions/href](tag-category.md#....typebasic.jsondefinitionshref) -* **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#/definitions/tag) - -## Types defined 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/tags/tag-category.md b/docs/openmetadata-apis/schemas/entities/tags/tag-category.md new file mode 100644 index 00000000000..90deaea744d --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/tags/tag-category.md @@ -0,0 +1,52 @@ +# Tag Category + +This schema defines the Tag Category entity. A Tag Category has one more children tags called Primary Tags. Primary Tags can further have children Tags called Secondary Tags. Only two levels of tags are supported currently. + +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json + +Type: `object` + +This schema does not accept additional properties. + +## Properties + - name `required` + - $ref: [#/definitions/tagName](#/definitions/tagName) + - description `required` + - Description of the tag category. + - Type: `string` + - categoryType `required` + - $ref: [#/definitions/tagCategoryType](#/definitions/tagCategoryType) + - href + - Link to the resource corresponding to the tag category. + - $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref) + - 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](#/definitions/tag) + + +## 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/team.md b/docs/openmetadata-apis/schemas/entities/team.md deleted file mode 100644 index a28ef40af40..00000000000 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ /dev/null @@ -1,44 +0,0 @@ -# Team - -This schema defines the Team entity. A Team is a group of zero or more users and can have ownership of data assets. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json) - -Type: `object` - -## Properties - -* **id** `required` - * $ref: [../../type/basic.json\#/definitions/uuid](team.md#....typebasic.jsondefinitionsuuid) -* **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](team.md#....typebasic.jsondefinitionshref) -* **profile** - * Team profile information. - * $ref: [../../type/profile.json](team.md#....typeprofile.json) -* **deleted** - * When true the team has been deleted. - * Type: `boolean` -* **users** - * Users that are part of the team. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist) -* **owns** - * List of entities owned by the team. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist) - -## Types defined in this schema - -**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 - diff --git a/docs/openmetadata-apis/schemas/entities/teams/team.md b/docs/openmetadata-apis/schemas/entities/teams/team.md new file mode 100644 index 00000000000..0724793d180 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/teams/team.md @@ -0,0 +1,44 @@ +# Team + +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json + +Type: `object` + +## Properties + - id `required` + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - name `required` + - $ref: [#/definitions/teamName](#/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](#....typebasic.jsondefinitionshref) + - profile + - Team profile information. + - $ref: [../../type/profile.json](#....typeprofile.json) + - deleted + - When true the team has been deleted. + - Type: `boolean` + - users + - Users that are part of the team. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + - owns + - List of entities owned by the team. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + + +## Types definitions in this schema +**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 + + diff --git a/docs/openmetadata-apis/schemas/entities/teams/user.md b/docs/openmetadata-apis/schemas/entities/teams/user.md new file mode 100644 index 00000000000..00a7e07e2a8 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/teams/user.md @@ -0,0 +1,60 @@ +# User + +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json + +Type: `object` + +This schema does not accept additional properties. + +## Properties + - id `required` + - Unique identifier that identifies a user entity instance. + - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) + - name `required` + - $ref: [#/definitions/userName](#/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](#....typebasic.jsondefinitionsemail) + - href `required` + - Link to the resource corresponding to this entity. + - $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref) + - 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](#....typeprofile.json) + - teams + - Teams that the user belongs to. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + - owns + - List of entities owned by the user. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + - follows + - List of entities followed by the user. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) + + +## Types definitions in this schema +**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 + + diff --git a/docs/openmetadata-apis/schemas/entities/thread.md b/docs/openmetadata-apis/schemas/entities/thread.md deleted file mode 100644 index 9eae3a43ae1..00000000000 --- a/docs/openmetadata-apis/schemas/entities/thread.md +++ /dev/null @@ -1,47 +0,0 @@ -# Feed - -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** created by 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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json) - -Type: `object` - -## Properties - -* **id** `required` - * Unique identifier that identifies an entity instance. - * $ref: [../../type/basic.json\#/definitions/uuid](thread.md#....typebasic.jsondefinitionsuuid) -* **href** - * Link to the resource corresponding to this entity. - * $ref: [../../type/basic.json\#/definitions/href](thread.md#....typebasic.jsondefinitionshref) -* **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](thread.md#....typebasic.jsondefinitionsentitylink) -* **addressedTo** - * User or team this thread is addressed to in format <\#E/{enties}/{entityName}/{field}/{fieldValue}. - * $ref: [../../type/basic.json\#/definitions/entityLink](thread.md#....typebasic.jsondefinitionsentitylink) -* **posts** `required` - * Type: `array` - * **Items** - * $ref: [\#/definitions/post](thread.md#/definitions/post) - -## Types defined in this schema - -**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](thread.md#....typebasic.jsondefinitionsuuid) - diff --git a/docs/openmetadata-apis/schemas/entities/user.md b/docs/openmetadata-apis/schemas/entities/user.md deleted file mode 100644 index 3bd852813b4..00000000000 --- a/docs/openmetadata-apis/schemas/entities/user.md +++ /dev/null @@ -1,60 +0,0 @@ -# User - -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 and own zero or more data asset entities. A user can also follow zero or more data asset entities. - -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json) - -Type: `object` - -This schema does not accept additional properties. - -## Properties - -* **id** `required` - * Unique identifier that identifies a user entity instance. - * $ref: [../../type/basic.json\#/definitions/uuid](user.md#....typebasic.jsondefinitionsuuid) -* **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](user.md#....typebasic.jsondefinitionsemail) -* **href** `required` - * Link to the resource corresponding to this entity. - * $ref: [../../type/basic.json\#/definitions/href](user.md#....typebasic.jsondefinitionshref) -* **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](user.md#....typeprofile.json) -* **teams** - * Teams that the user belongs to. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) -* **owns** - * List of entities owned by the user. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) -* **follows** - * List of entities followed by the user. - * $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist) - -## Types defined in this schema - -**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 - diff --git a/docs/openmetadata-apis/schemas/types/audit-log.md b/docs/openmetadata-apis/schemas/types/audit-log.md index 597d95a021d..707d8d041a6 100644 --- a/docs/openmetadata-apis/schemas/types/audit-log.md +++ b/docs/openmetadata-apis/schemas/types/audit-log.md @@ -1,37 +1,35 @@ # Audit Log -This schema defines the type for Audit Log to capture the audit trail of POST, PUT, and PATCH API operations. +This schema defines Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/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 requested for the API. - * Type: `string` -* **dateTime** - * Date which the api call is made. - * $ref: [basic.json\#/definitions/dateTime](audit-log.md#basic.jsondefinitionsdatetime) -* **entityId** `required` - * Entity Id that was modified by the operation. - * $ref: [basic.json\#/definitions/uuid](audit-log.md#basic.jsondefinitionsuuid) -* **entityType** `required` - * Entity Type that modified by the operation. - * Type: `string` - + - 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 requested for the API. + - Type: `string` + - dateTime + - Date which the api call is made. + - $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime) + - entityId `required` + - Entity Id that was modified by the operation. + - $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid) + - entityType `required` + - Entity Type that modified by the operation. + - Type: `string` diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index 07ba466afe9..ce67c591180 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -2,67 +2,77 @@ This schema defines basic common types that are used by other schemas. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json -## Types defined in this schema + +## Types definitions in this schema **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 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 of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`. -* Type: `string` -* The value must match this pattern: `^<#E/\S+/\S+>$` + - 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** -* Timestamp in unixTimeMillis -* Type: `string` -* String format must be a "utc-millisec" + - Timestamp 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" + - href that points to a resource. + - Type: `string` + - String format must be a "uri" + **timeInterval** -* Type: `object` -* **Properties** - * **start** - * Start time in unixTimeMillis. - * Type: `integer` - * **end** - * End time in unixTimeMillis. - * Type: `integer` + - Type: `object` + - **Properties** + - start + - Start time in unixTimeMillis. + - Type: `integer` + - end + - End time in unixTimeMillis. + - Type: `integer` + **duration** -* Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'. -* Type: `string` + - Duration in ISO 8601 format in UTC. 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" + - 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" + - Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'. + - Type: `string` + - String format must be a "date-Time" + diff --git a/docs/openmetadata-apis/schemas/types/daily-count.md b/docs/openmetadata-apis/schemas/types/daily-count.md index 6a0e7998942..e13af847903 100644 --- a/docs/openmetadata-apis/schemas/types/daily-count.md +++ b/docs/openmetadata-apis/schemas/types/daily-count.md @@ -1,17 +1,15 @@ -# Daily Count +# Daily count of some measurement -This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins. +This schema defines the type for reporting the daily count of some measurement. Example - number of times a table was used in queries per day. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json Type: `object` ## Properties - -* **count** `required` - * Daily count of a measurement on the given date. - * Type: `integer` - * Range: ≥ 0 -* **date** `required` - * $ref: [basic.json\#/definitions/date](daily-count.md#basic.jsondefinitionsdate) - + - count `required` + - Daily count of a measurement on the given date. + - Type: `integer` + - Range: ≥ 0 + - date `required` + - $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate) diff --git a/docs/openmetadata-apis/schemas/types/entity-reference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md index ae852cfa176..7b5a812f451 100644 --- a/docs/openmetadata-apis/schemas/types/entity-reference.md +++ b/docs/openmetadata-apis/schemas/types/entity-reference.md @@ -1,34 +1,34 @@ # Entity Reference -This schema defines the type EntityReference used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database. +This schema defines EntityReference type used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json Type: `object` ## Properties + - id `required` + - Unique identifier that identifies an entity instance. + - $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid) + - type `required` + - Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... + - Type: `string` + - name + - Name of the entity instance. + - Type: `string` + - description + - Optional description of entity. + - Type: `string` + - href + - Link to the entity resource. + - $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref) -* **id** `required` - * Unique identifier that identifies an entity instance. - * $ref: [basic.json\#/definitions/uuid](entity-reference.md#basic.jsondefinitionsuuid) -* **type** `required` - * Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... - * Type: `string` -* **name** - * Name of the entity instance. - * Type: `string` -* **description** - * Optional description of entity. - * Type: `string` -* **href** - * Link to the entity resource. - * $ref: [basic.json\#/definitions/href](entity-reference.md#basic.jsondefinitionshref) - -## Types defined in this schema +## Types definitions in this schema **entityReferenceList** -* Type: `array` - * **Items** - * $ref: [entityReference.json](entity-reference.md#entityreference.json) + - Type: `array` + - **Items** + - $ref: [entityReference.json](#entityreference.json) + diff --git a/docs/openmetadata-apis/schemas/types/entity-usage.md b/docs/openmetadata-apis/schemas/types/entity-usage.md index 39c724c238f..1987121eb90 100644 --- a/docs/openmetadata-apis/schemas/types/entity-usage.md +++ b/docs/openmetadata-apis/schemas/types/entity-usage.md @@ -1,19 +1,17 @@ -# Entity Usage +# Usage details of an entity This schema defines the type used for capturing usage details of an entity. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json Type: `object` ## Properties - -* **entity** `required` - * Entity for which usage is returned. - * $ref: [entityReference.json](entity-usage.md#entityreference.json) -* **usage** `required` - * List usage details per day. - * Type: `array` - * **Items** - * $ref: [usageDetails.json](entity-usage.md#usagedetails.json) - + - entity `required` + - Entity for which usage is returned. + - $ref: [entityReference.json](#entityreference.json) + - usage `required` + - List usage details per day. + - Type: `array` + - **Items** + - $ref: [usageDetails.json](#usagedetails.json) diff --git a/docs/openmetadata-apis/schemas/types/jdbc-connection.md b/docs/openmetadata-apis/schemas/types/jdbc-connection.md index d07c9a087d7..3ab3848d17b 100644 --- a/docs/openmetadata-apis/schemas/types/jdbc-connection.md +++ b/docs/openmetadata-apis/schemas/types/jdbc-connection.md @@ -1,47 +1,49 @@ -# Jdbc Connection +# JDBC connection JDBC connection information -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json Type: `object` ## Properties + - driverClass `required` + - JDBC driver class + - $ref: [#/definitions/driverClass](#/definitions/driverClass) + - connectionUrl `required` + - JDBC connection URL + - $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl) + - userName `required` + - Login user name. + - Type: `string` + - password `required` + - Login password. + - Type: `string` -* **driverClass** `required` - * JDBC driver class - * $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass) -* **connectionUrl** `required` - * JDBC connection URL - * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) -* **userName** `required` - * Login user name. - * Type: `string` -* **password** `required` - * Login password. - * Type: `string` - -## Types defined in this schema +## Types definitions in this schema **driverClass** -* Type used for JDBC driver class -* Type: `string` + - Type used for JDBC driver class + - Type: `string` + **connectionUrl** -* Type used for JDBC connection URL -* Type: `string` -* String format must be a "uri" + - 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#/definitions/driverClass) - * Default: _"com.amazon.redshift.jdbc42.Driver"_ - * **connectionUrl** `required` - * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl) + - Type for capturing JDBC connector information + - Type: `object` + - **Properties** + - driverClass `required` + - $ref: [#/definitions/driverClass](#/definitions/driverClass) + - Default: _"com.amazon.redshift.jdbc42.Driver"_ + - connectionUrl `required` + - $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl) + diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 3a4c3b97fb2..f3570e359cc 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -1,42 +1,42 @@ # Profile -This schema defines the type used to capture profile of a user, team, or an organization. +This schema defines the type for profile of a user, team, or an organization. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json Type: `object` ## Properties + - images + - $ref: [#/definitions/imageList](#/definitions/imageList) -* **images** - * $ref: [\#/definitions/imageList](profile.md#/definitions/imageList) - -## Types defined in this schema +## Types definitions in this schema **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" + diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index 08d0fbd1ca7..22870746873 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -1,17 +1,15 @@ -# Schedule +# Type used for schedule with start time and repeat frequency -This schema defines the type used for schedule with start time and repeat frequency. +This schema defines the type used for schedule. Schedule has a start time and repeat frequency. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json Type: `object` ## Properties - -* **startDate** - * Start date and time of the schedule. - * $ref: [basic.json\#/definitions/dateTime](schedule.md#basic.jsondefinitionsdatetime) -* **repeatFrequency** - * Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H' - * $ref: [basic.json\#/definitions/duration](schedule.md#basic.jsondefinitionsduration) - + - startDate + - Start date and time of the schedule. + - $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime) + - repeatFrequency + - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H' + - $ref: [basic.json#/definitions/duration](#basic.jsondefinitionsduration) diff --git a/docs/openmetadata-apis/schemas/types/tag-label.md b/docs/openmetadata-apis/schemas/types/tag-label.md index 47cd8ba8135..a1f5ccadc6a 100644 --- a/docs/openmetadata-apis/schemas/types/tag-label.md +++ b/docs/openmetadata-apis/schemas/types/tag-label.md @@ -1,31 +1,31 @@ # Tag Label -This schema defines the type used for labeling an entity with a Tag. +This schema defines the type for labeling an entity with a Tag. -**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json Type: `object` ## Properties - -* **tagFQN** - * Type: `string` - * Length: ≤ 45 -* **labelType** - * Type: `string` - * The value is restricted to the following: - 1. _"Manual"_ - 2. _"Propagated"_ - 3. _"Automated"_ - 4. _"Derived"_ - * Default: _"Manual"_ -* **state** - * 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](tag-label.md#basic.jsondefinitionshref) - + - tagFQN + - Type: `string` + - Length: ≤ 45 + - labelType + - Label type describe how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using 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.jsondefinitionshref) diff --git a/docs/openmetadata-apis/schemas/types/usage-details.md b/docs/openmetadata-apis/schemas/types/usage-details.md index aaf1e361ae5..dd6685626fd 100644 --- a/docs/openmetadata-apis/schemas/types/usage-details.md +++ b/docs/openmetadata-apis/schemas/types/usage-details.md @@ -1,40 +1,40 @@ -# Usage Details +# Type used to return usage details of an entity -This schema defines the type used for capturing usage details. Based on usage, daily, weekly, and monthly aggregation of usage is provided along with the percentile rank based on the usage. +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json) +$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json Type: `object` ## Properties + - dailyStats `required` + - Daily usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - weeklyStats + - Weekly (last 7 days) rolling usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - monthlyStats + - Monthly (last 30 days) rolling usage stats of a data asset on the start date. + - $ref: [#/definitions/usageStats](#/definitions/usageStats) + - date `required` + - Date in UTC. + - $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate) -* **dailyStats** `required` - * Daily usage stats of a data asset on the start date. - * $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) -* **weeklyStats** - * Weekly \(last 7 days\) rolling usage stats of a data asset on the start date. - * $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) -* **monthlyStats** - * Monthly \(last 30 days\) rolling usage stats of a data asset on the start date. - * $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats) -* **date** `required` - * Date in UTC time. - * $ref: [basic.json\#/definitions/date](usage-details.md#basic.jsondefinitionsdate) - -## Types defined 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 + - 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 +