diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/bots.json b/catalog-rest-service/src/main/resources/json/schema/entity/bots.json index a13d269500e..7b898d0cacf 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/bots.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/bots.json @@ -2,17 +2,16 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Bot", - "description": "Bot entity to capture the details of a bot.", - "description": "This schema defines Bot entity. A bot automates tasks, such as adding description, identifying importance of data. It runs as a special user in the system.", + "description": "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.", "type": "object", "properties" : { "id": { - "description": "Unique identifier that identifies an entity instance.", + "description": "Unique identifier of a bot instance.", "$ref": "../type/basic.json#/definitions/uuid" }, "name": { - "description": "Optional name that identifies this entity. Same as id if name is not available.", + "description": "Name of the bot.", "type": "string", "minLength": 1, "maxLength": 64 @@ -22,11 +21,11 @@ "type": "string" }, "description": { - "description": "Description of entity instance.", + "description": "Description of the bot.", "type": "string" }, "href": { - "description": "Link to the resource corresponding to this entity.", + "description": "Link to the resource corresponding to this bot.", "$ref": "../type/basic.json#/definitions/href" } } 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 9e3446e9cae..dabf5e3a573 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 Dashboard entity.", + "description": "This schema defines the Dashboard entity.", "type": "object", "properties" : { @@ -17,13 +17,13 @@ "maxLength": 64 }, "fullyQualifiedName": { - "description": "Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.", + "description": "A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.", "type": "string", "minLength": 1, "maxLength": 64 }, "description": { - "description": "Description of dashboard, what it is and how to use it.", + "description": "Description of the dashboard, what it is, and how to use it.", "type": "string" }, "href": { 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 6372dbaa369..949c416840a 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 Database entity. Database is a collection of schemas. They are also referred to as Database Catalog.", + "description": "This schema defines the Database entity. A database is a collection of schemas. They are also referred to as Database Catalog.", "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 9df43206557..60ec8de50a3 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 Metrics entity.", + "description": "This schema defines the Metrics entity.", "type": "object", "properties" : { @@ -11,19 +11,19 @@ "$ref": "../../type/basic.json#/definitions/uuid" }, "name": { - "description": "Name that identifies the this metrics instance uniquely.", + "description": "Name that identifies this metrics instance uniquely.", "type": "string", "minLength": 1, "maxLength": 64 }, "fullyQualifiedName": { - "description": "Unique name that identifies a metric in the format 'ServiceName.MetricName'.", + "description": "A unique name that identifies a metric in the format 'ServiceName.MetricName'.", "type": "string", "minLength": 1, "maxLength": 64 }, "description": { - "description": "Description of metrics instance. What is has and how to use it.", + "description": "Description of metrics instance, what it is, and how to use it.", "type": "string" }, "href": { 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 2bcf1776dd1..c28af5cd22a 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 Pipeline entity.", + "description": "This schema defines the Pipeline entity.", "type": "object", "properties" : { @@ -11,13 +11,13 @@ "$ref": "../../type/basic.json#/definitions/uuid" }, "name": { - "description": "Name that identifies the this pipeline instance uniquely.", + "description": "Name that identifies this pipeline instance uniquely.", "type": "string", "minLength": 1, "maxLength": 64 }, "fullyQualifiedName": { - "description": "Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.", + "description": "A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.", "type": "string", "minLength": 1, "maxLength": 64 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 c37222e353b..5871c880135 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 Report entity.", + "description": "This schema defines the Report entity.", "type": "object", "properties" : { @@ -17,7 +17,7 @@ "maxLength": 64 }, "fullyQualifiedName": { - "description": "Unique name that identifies a report in the format 'ServiceName.ReportName'.", + "description": "A unique name that identifies a report in the format 'ServiceName.ReportName'.", "type": "string", "minLength": 1, "maxLength": 64 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 54eb7c6ddc0..65f81868ff3 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,7 +2,7 @@ "$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 Table entity. 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 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.", "type": "object", "javaType": "org.openmetadata.catalog.entity.data.Table", "definitions": { @@ -37,7 +37,7 @@ }, "columnDataType": { "javaType": "org.openmetadata.catalog.type.ColumnDataType", - "description": "This enum defines the type for column data type.", + "description": "This enum defines the type of data stored in a column.", "type": "string", "enum": [ "NUMBER", @@ -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 in this table is joined with columns in the other tables.", + "description": "This schema defines the type to capture how frequently a column are 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 is joined with columns in the other tables.", + "description": "This schema defines the type to capture 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.", @@ -231,10 +231,10 @@ } }, "rows": { - "description": "Data for a multiple rows of the table.", + "description": "Data for multiple rows of the table.", "type": "array", "items": { - "description": "Data for a single row of the table with in the same order as columns fields.", + "description": "Data for a single row of the table within the same order as columns fields.", "type": "array" } } @@ -248,7 +248,7 @@ "$ref": "../../type/basic.json#/definitions/uuid" }, "name": { - "description": "Name of the table. Expected to be unique with in a database.", + "description": "Name of the table. Expected to be unique within a database.", "$ref": "#/definitions/tableName" }, "description": { 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 065c5491044..e471f38fd4a 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 Thread entity. A Thread is a collection of posts made the users. 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 mentions 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** 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.", "type": "object", "definitions": { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json index 3bccf416937..b0e5ce9b56a 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Database Service", - "description": "This schema defines Database Service entity, such as MySQL, BigQuery, Redshift, Postgres or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used.", + "description": "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.", "type": "object", "definitions": { "databaseServiceType": { @@ -58,7 +58,7 @@ "$ref": "#/definitions/databaseServiceType" }, "description": { - "description": "Description of database service instance.", + "description": "Description of a database service instance.", "type": "string" }, "href": { 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 0c008aa37e2..dacba34b6a9 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 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 level of 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 have children Tags called Secondary Tags. Only two levels of tags are supported currently.", "type": "object", "javaType": "org.openmetadata.catalog.type.TagCategory", "definitions": { 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 cee88b4c958..497b95cb82a 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,12 +2,12 @@ "$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 Team entity. A Team is a group of zero or more users. Team can have ownership of data assets.", + "description": "This schema defines the Team entity. A Team is a group of zero or more users and can have ownership of data assets.", "type": "object", "definitions" : { "teamName" : { - "description": "Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.", + "description": "A unique name of the team typically the team ID from an identity provider. Example - group Id from ldap.", "type": "string", "minLength": 1, "maxLength": 64 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 c958935964e..50514e79cbb 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,12 +2,12 @@ "$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 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 and own zero or more data asset entities. A user can also follow zero or more data asset entities.", "type": "object", "definitions": { "userName" : { - "description": "Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.", + "description": "A unique name of the user typically the user ID from an identity provider. Example - uid from ldap.", "type": "string", "minLength": 1, "maxLength": 64 @@ -40,7 +40,7 @@ "format": "timezone" }, "deactivated" : { - "description": "When true indicates user has been deactivated. Users are deactivated instead of deleted.", + "description": "When true indicates the user has been deactivated. Users are deactivated instead of deleted.", "type": "boolean" }, "isBot" : { 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 c77970b4eb0..fc69b206cfc 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 type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations.", + "description": "This schema defines the type for Audit Log 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/basic.json b/catalog-rest-service/src/main/resources/json/schema/type/basic.json index 782be2b5cb0..5d919cace36 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/basic.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/basic.json @@ -23,7 +23,7 @@ "pattern": "^<#E/\\S+/\\S+>$" }, "timestamp": { - "description": "Time stamp in unixTimeMillis", + "description": "Timestamp in unixTimeMillis", "type": "string", "format": "utc-millisec" }, @@ -47,11 +47,11 @@ } }, "duration": { - "description": "Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'.", + "description": "Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.", "type": "string" }, "date": { - "description": "Date in ISO 8601 format in UTC time. Example - '2018-11-13'.", + "description": "Date in ISO 8601 format in UTC. Example - '2018-11-13'.", "type": "string", "format": "date" }, 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 5355de0cf8d..3c4b0b8955a 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 type used for capturing and reporting daily count of some measurement, such as usage, joins.", + "description": "This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins.", "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 530425d119e..9be1444d310 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 Entity Reference used for referencing an entity.", + "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.", "type": "object", "javaType": "org.openmetadata.catalog.type.EntityReference", "definitions": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json b/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json index a47b3797aca..7b9ec8252eb 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Usage details of an entity", - "description": "This schema defines type used for capturing usage details of an entity.", + "description": "This schema defines the type used for capturing usage details of an entity.", "type" : "object", "properties": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json b/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json index b4e87a0fd1e..9ae93b84a56 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "JDBC connection", - "description": "This schema defines type used for capturing JDBC connection information used for connecting to a database services.", + "description": "This schema defines the type used for JDBC connection information.", "type": "object", "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 fc51f2024d4..8f80c6552c4 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,12 +2,12 @@ "$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 type used to capture profile of a user, team, or an organization.", + "description": "This schema defines the type used to capture profile of a user, team, or an organization.", "type": "object", "javaType": "org.openmetadata.catalog.type.Profile", "definitions": { "imageList": { - "description": "Links to list of images of varying resolutions/sizes.", + "description": "Links to a list of images of varying resolutions/sizes.", "type": "object", "javaType": "org.openmetadata.catalog.type.ImageList", "properties": { 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 f6969242606..78e5fab51be 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 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.", "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 cabe6ed3ea1..15e459c027a 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 type used for labeling an entity or an entity field with a Tag.", + "description": "This schema defines the type used for labeling an entity with a Tag.", "type": "object", "javaType": "org.openmetadata.catalog.type.TagLabel", "properties": { 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 064961f6bd7..10678b93318 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 type used for capturing 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.", "type": "object", "javaType": "org.openmetadata.catalog.type.UsageDetails", "definitions": { @@ -43,7 +43,7 @@ "$ref": "#/definitions/usageStats" }, "date": { - "description": "Date in UTC time.", + "description": "Date in UTC.", "$ref": "basic.json#/definitions/date" } }, diff --git a/docs/openmetadata-apis/apis/overview.md b/docs/openmetadata-apis/apis/overview.md index 124137c1826..e72c85fb559 100644 --- a/docs/openmetadata-apis/apis/overview.md +++ b/docs/openmetadata-apis/apis/overview.md @@ -129,7 +129,7 @@ GET /v1/tables/name/service.database.dim_user ### Getting entities with only necessary fields -To GET an entity with only necessary fields, pass `fields` query parameter while listing or getting an entity. This help clients control the amount of data returned in the response. Some fields may be included by default whether `fields` specifies them or not \(example - id and name fields below\): +To GET an entity with only necessary fields, pass `fields` query parameter while listing or getting an entity. This helps clients control the amount of data returned in the response. Some fields may be included by default whether `fields` specifies them or not \(example - id and name fields below\): ```text GET /v1/tables/123e4567-e89b-42d3-a456-556642440000?fields=columns,tableConstraints,usage diff --git a/docs/openmetadata-apis/schemas/entities/bots.md b/docs/openmetadata-apis/schemas/entities/bots.md index 66aa2d5ddad..c29977846fc 100644 --- a/docs/openmetadata-apis/schemas/entities/bots.md +++ b/docs/openmetadata-apis/schemas/entities/bots.md @@ -1,6 +1,6 @@ # Bot -This schema defines Bot entity. A bot automates tasks, such as adding description, identifying importance of data. It runs as a special user in the system. +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 @@ -8,18 +8,18 @@ Type: `object` ## Properties - id - - Unique identifier that identifies an entity instance. + - Unique identifier of a bot instance. - $ref: [../type/basic.json#/definitions/uuid](#..typebasic.jsondefinitionsuuid) - name - - Optional name that identifies this entity. Same as id if name is not available. + - 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 entity instance. + - Description of the bot. - Type: `string` - href - - Link to the resource corresponding to this entity. + - Link to the resource corresponding to this bot. - $ref: [../type/basic.json#/definitions/href](#..typebasic.jsondefinitionshref) diff --git a/docs/openmetadata-apis/schemas/entities/data/dashboard.md b/docs/openmetadata-apis/schemas/entities/data/dashboard.md index f7e11a633d1..bc4b9088514 100644 --- a/docs/openmetadata-apis/schemas/entities/data/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/data/dashboard.md @@ -1,6 +1,6 @@ # Dashboard -This schema defines Dashboard entity. +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 @@ -15,11 +15,11 @@ Type: `object` - Type: `string` - Length: between 1 and 64 - fullyQualifiedName - - Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'. + - A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'. - Type: `string` - Length: between 1 and 64 - description - - Description of dashboard, what it is and how to use it. + - Description of the dashboard, what it is, and how to use it. - Type: `string` - href - Link to the resource corresponding to this entity. diff --git a/docs/openmetadata-apis/schemas/entities/data/database.md b/docs/openmetadata-apis/schemas/entities/data/database.md index 122e07797f4..eb24b705774 100644 --- a/docs/openmetadata-apis/schemas/entities/data/database.md +++ b/docs/openmetadata-apis/schemas/entities/data/database.md @@ -1,6 +1,6 @@ # Database -This schema defines Database entity. Database is a collection of schemas. They are also referred to as Database Catalog. +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 @@ -36,8 +36,8 @@ Type: `object` - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) -## Definitions -**_databaseName_** +## Types defined in this schema +**databaseName** - Name that identifies the database. - Type: `string` diff --git a/docs/openmetadata-apis/schemas/entities/data/metrics.md b/docs/openmetadata-apis/schemas/entities/data/metrics.md index 04de99ab5fb..291f4e6ba01 100644 --- a/docs/openmetadata-apis/schemas/entities/data/metrics.md +++ b/docs/openmetadata-apis/schemas/entities/data/metrics.md @@ -1,6 +1,6 @@ # Metrics -This schema defines Metrics entity. +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 @@ -11,15 +11,15 @@ Type: `object` - Unique identifier that identifies this metrics instance. - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) - name `required` - - Name that identifies the this metrics instance uniquely. + - Name that identifies this metrics instance uniquely. - Type: `string` - Length: between 1 and 64 - fullyQualifiedName - - Unique name that identifies a metric in the format 'ServiceName.MetricName'. + - 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 is has and how to use it. + - Description of metrics instance, what it is, and how to use it. - Type: `string` - href - Link to the resource corresponding to this entity. diff --git a/docs/openmetadata-apis/schemas/entities/data/pipeline.md b/docs/openmetadata-apis/schemas/entities/data/pipeline.md index 68a802bd862..535d0f9eedb 100644 --- a/docs/openmetadata-apis/schemas/entities/data/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/data/pipeline.md @@ -1,6 +1,6 @@ # Pipeline -This schema defines Pipeline entity. +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 @@ -11,11 +11,11 @@ Type: `object` - Unique identifier that identifies a pipeline instance. - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) - name `required` - - Name that identifies the this pipeline instance uniquely. + - Name that identifies this pipeline instance uniquely. - Type: `string` - Length: between 1 and 64 - fullyQualifiedName - - Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'. + - A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'. - Type: `string` - Length: between 1 and 64 - description diff --git a/docs/openmetadata-apis/schemas/entities/data/report.md b/docs/openmetadata-apis/schemas/entities/data/report.md index be7f70327ce..90265c15239 100644 --- a/docs/openmetadata-apis/schemas/entities/data/report.md +++ b/docs/openmetadata-apis/schemas/entities/data/report.md @@ -1,6 +1,6 @@ # Report -This schema defines Report entity. +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 @@ -15,7 +15,7 @@ Type: `object` - Type: `string` - Length: between 1 and 64 - fullyQualifiedName - - Unique name that identifies a report in the format 'ServiceName.ReportName'. + - A unique name that identifies a report in the format 'ServiceName.ReportName'. - Type: `string` - Length: between 1 and 64 - description diff --git a/docs/openmetadata-apis/schemas/entities/data/table.md b/docs/openmetadata-apis/schemas/entities/data/table.md index bff132e10a0..cb4d1c24841 100644 --- a/docs/openmetadata-apis/schemas/entities/data/table.md +++ b/docs/openmetadata-apis/schemas/entities/data/table.md @@ -1,6 +1,6 @@ # Table -This schema defines Table entity. 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. +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 @@ -11,7 +11,7 @@ Type: `object` - Unique identifier of this table instance. - $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid) - name `required` - - Name of the table. Expected to be unique with in a database. + - Name of the table. Expected to be unique within a database. - $ref: [#/definitions/tableName](#/definitions/tableName) - description - Description of the table. @@ -27,12 +27,12 @@ Type: `object` - columns `required` - Columns in this table. - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/column](#/definitions/column) - tableConstraints - Table constraints. - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/tableConstraint](#/definitions/tableConstraint) - usageSummary - Latest usage information for this table. @@ -49,7 +49,7 @@ Type: `object` - tags - Tags for this table. - Type: `array` - - **_Items_** + - **Items** - $ref: [../../type/tagLabel.json](#....typetaglabel.json) - joins - Details of other tables this table is frequently joined with. @@ -59,8 +59,8 @@ Type: `object` - $ref: [#/definitions/tableData](#/definitions/tableData) -## Definitions -**_tableType_** +## Types defined in this schema +**tableType** - This schema defines the type for a column in a table. - Type: `string` @@ -72,9 +72,9 @@ Type: `object` 5. _"MaterializedView"_ -**_columnDataType_** +**columnDataType** - - This enum defines the type for column data type. + - This enum defines the type of data stored in a column. - Type: `string` - The value is restricted to the following: 1. _"NUMBER"_ @@ -112,7 +112,7 @@ Type: `object` 33. _"JSON"_ -**_columnConstraint_** +**columnConstraint** - This enum defines the type for column constraint. - Type: `string` @@ -124,11 +124,11 @@ Type: `object` - Default: _"NULL"_ -**_tableConstraint_** +**tableConstraint** - This enum defines the type for table constraint. - Type: `object` - - **_Properties_** + - **Properties** - constraintType - Type: `string` - The value is restricted to the following: @@ -138,11 +138,11 @@ Type: `object` - columns - List of column names corresponding to the constraint. - Type: `array` - - **_Items_** + - **Items** - Type: `string` -**_columnName_** +**columnName** - Local name (not fully qualified name) of the column. - Type: `string` @@ -150,7 +150,7 @@ Type: `object` - Length: between 1 and 64 -**_tableName_** +**tableName** - Local name (not fully qualified name) of the table. - Type: `string` @@ -158,18 +158,18 @@ Type: `object` - Length: between 1 and 64 -**_fullyQualifiedColumnName_** +**fullyQualifiedColumnName** - Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`. - Type: `string` - Length: between 1 and 256 -**_column_** +**column** - This schema defines the type for a column in a table. - Type: `object` - - **_Properties_** + - **Properties** - name `required` - $ref: [#/definitions/columnName](#/definitions/columnName) - columnDataType `required` @@ -183,7 +183,7 @@ Type: `object` - tags - Tags associated with the column. - Type: `array` - - **_Items_** + - **Items** - $ref: [../../type/tagLabel.json](#....typetaglabel.json) - columnConstraint - Column level constraint. @@ -193,32 +193,32 @@ Type: `object` - Type: `integer` -**_columnJoins_** +**columnJoins** - - This schema defines the type to capture how frequently a column in this table is joined with columns in the other tables. + - 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_** + - **Properties** - columnName - $ref: [#/definitions/columnName](#/definitions/columnName) - joinedWith - Fully qualified names of the columns that this column is joined with. - Type: `array` - - **_Items_** + - **Items** - Type: `object` - - **_Properties_** + - **Properties** - fullyQualifiedName - $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName) - joinCount - Type: `integer` -**_tableJoins_** +**tableJoins** - - This schema defines the type to capture how columns in this table is joined with columns in the other tables. + - 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_** + - **Properties** - startDate - Date can be only from today going back to last 29 days. - $ref: [../../type/basic.json#/definitions/date](#....typebasic.jsondefinitionsdate) @@ -227,26 +227,26 @@ Type: `object` - Default: `1` - columnJoins - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/columnJoins](#/definitions/columnJoins) -**_tableData_** +**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_** + - **Properties** - columns - List of local column names (not fully qualified column names) of the table. - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/columnName](#/definitions/columnName) - rows - - Data for a multiple rows of the table. + - Data for multiple rows of the table. - Type: `array` - - **_Items_** - - Data for a single row of the table with in the same order as columns fields. + - **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/feed/thread.md b/docs/openmetadata-apis/schemas/entities/feed/thread.md index 2dc27034f2f..c7fa303fb02 100644 --- a/docs/openmetadata-apis/schemas/entities/feed/thread.md +++ b/docs/openmetadata-apis/schemas/entities/feed/thread.md @@ -1,6 +1,6 @@ # Thread -This schema defines Thread entity. A Thread is a collection of posts made the users. 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 mentions Users or other Data Assets. +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 @@ -23,16 +23,16 @@ Type: `object` - $ref: [../../type/basic.json#/definitions/entityLink](#....typebasic.jsondefinitionsentitylink) - posts `required` - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/post](#/definitions/post) -## Definitions -**_post_** +## Types defined in this schema +**post** - Post within a feed. - Type: `object` - - **_Properties_** + - **Properties** - message `required` - Message in markdown format. See markdown support for more details. - Type: `string` diff --git a/docs/openmetadata-apis/schemas/entities/services/database-service.md b/docs/openmetadata-apis/schemas/entities/services/database-service.md index 2104899465d..f86715b27ba 100644 --- a/docs/openmetadata-apis/schemas/entities/services/database-service.md +++ b/docs/openmetadata-apis/schemas/entities/services/database-service.md @@ -1,6 +1,6 @@ # Database Service -This schema defines Database Service entity, such as MySQL, BigQuery, Redshift, Postgres or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used. +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 @@ -18,7 +18,7 @@ Type: `object` - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... - $ref: [#/definitions/databaseServiceType](#/definitions/databaseServiceType) - description - - Description of database service instance. + - Description of a database service instance. - Type: `string` - href `required` - Link to the resource corresponding to this database service. @@ -31,8 +31,8 @@ Type: `object` - $ref: [../../type/schedule.json](#....typeschedule.json) -## Definitions -**_databaseServiceType_** +## Types defined in this schema +**databaseServiceType** - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... - Type: `string` diff --git a/docs/openmetadata-apis/schemas/entities/tags/tag-category.md b/docs/openmetadata-apis/schemas/entities/tags/tag-category.md index de6920b4934..04b33bfe194 100644 --- a/docs/openmetadata-apis/schemas/entities/tags/tag-category.md +++ b/docs/openmetadata-apis/schemas/entities/tags/tag-category.md @@ -1,6 +1,6 @@ # Tag Category -This schema defines 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 level of of tags are supported currently. +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 @@ -25,19 +25,19 @@ This schema does not accept additional properties. - children - Tags under this category. - Type: `array` - - **_Items_** + - **Items** - $ref: [#/definitions/tag](#/definitions/tag) -## Definitions -**_tagName_** +## Types defined in this schema +**tagName** - Name of the tag. - Type: `string` - Length: between 2 and 25 -**_tagCategoryType_** +**tagCategoryType** - Type of tag category. - Type: `string` @@ -46,7 +46,7 @@ This schema does not accept additional properties. 2. _"Classification"_ -**_tag_** +**tag** diff --git a/docs/openmetadata-apis/schemas/entities/teams/team.md b/docs/openmetadata-apis/schemas/entities/teams/team.md index c9d1079ecd6..b08498d42a0 100644 --- a/docs/openmetadata-apis/schemas/entities/teams/team.md +++ b/docs/openmetadata-apis/schemas/entities/teams/team.md @@ -1,6 +1,6 @@ # Team -This schema defines Team entity. A Team is a group of zero or more users. Team can have ownership of data assets. +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 @@ -34,10 +34,10 @@ Type: `object` - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) -## Definitions -**_teamName_** +## Types defined in this schema +**teamName** - - Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap. + - 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 index 804342b7305..a86956723c9 100644 --- a/docs/openmetadata-apis/schemas/entities/teams/user.md +++ b/docs/openmetadata-apis/schemas/entities/teams/user.md @@ -1,6 +1,6 @@ # User -This schema defines 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. +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 @@ -28,7 +28,7 @@ This schema does not accept additional properties. - Type: `string` - String format must be a "timezone" - deactivated - - When true indicates user has been deactivated. Users are deactivated instead of deleted. + - 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. @@ -50,10 +50,10 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist) -## Definitions -**_userName_** +## Types defined in this schema +**userName** - - Unique name of the user typically the user ID from the identify provider. Example - uid from ldap. + - 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 cc08d860e3e..e4c42495600 100644 --- a/docs/openmetadata-apis/schemas/types/audit-log.md +++ b/docs/openmetadata-apis/schemas/types/audit-log.md @@ -1,6 +1,6 @@ # Audit Log -This schema defines type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations. +This schema defines the type for Audit Log 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 diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index 2e165029d40..62aa0af08a3 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -6,15 +6,15 @@ This schema defines basic common types that are used by other schemas. -## Definitions -**_uuid_** +## Types defined in this schema +**uuid** - Unique id used to identify an entity. - Type: `string` - String format must be a "uuid" -**_email_** +**email** - Email address of a user or other entities. - Type: `string` @@ -23,31 +23,31 @@ This schema defines basic common types that are used by other schemas. - Length: between 6 and 127 -**_entityLink_** +**entityLink** - Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`. - Type: `string` - The value must match this pattern: `^<#E/\S+/\S+>$` -**_timestamp_** +**timestamp** - - Time stamp in unixTimeMillis + - Timestamp in unixTimeMillis - Type: `string` - String format must be a "utc-millisec" -**_href_** +**href** - href that points to a resource. - Type: `string` - String format must be a "uri" -**_timeInterval_** +**timeInterval** - Type: `object` - - **_Properties_** + - **Properties** - start - Start time in unixTimeMillis. - Type: `integer` @@ -56,20 +56,20 @@ This schema defines basic common types that are used by other schemas. - Type: `integer` -**_duration_** +**duration** - Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'. - Type: `string` -**_date_** +**date** - Date in ISO 8601 format in UTC time. Example - '2018-11-13'. - Type: `string` - String format must be a "date" -**_dateTime_** +**dateTime** - Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'. - Type: `string` diff --git a/docs/openmetadata-apis/schemas/types/daily-count.md b/docs/openmetadata-apis/schemas/types/daily-count.md index 5c45a767e6c..f33085bdbeb 100644 --- a/docs/openmetadata-apis/schemas/types/daily-count.md +++ b/docs/openmetadata-apis/schemas/types/daily-count.md @@ -1,6 +1,6 @@ # Daily count of some measurement -This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins. +This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins. $id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json diff --git a/docs/openmetadata-apis/schemas/types/entity-reference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md index 3471784f32b..ac691d19600 100644 --- a/docs/openmetadata-apis/schemas/types/entity-reference.md +++ b/docs/openmetadata-apis/schemas/types/entity-reference.md @@ -1,6 +1,6 @@ # Entity Reference -This schema defines the type Entity Reference used for referencing an entity. +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. $id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json @@ -24,11 +24,11 @@ Type: `object` - $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref) -## Definitions -**_entityReferenceList_** +## Types defined in this schema +**entityReferenceList** - Type: `array` - - **_Items_** + - **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 88eb728e20b..1987121eb90 100644 --- a/docs/openmetadata-apis/schemas/types/entity-usage.md +++ b/docs/openmetadata-apis/schemas/types/entity-usage.md @@ -1,6 +1,6 @@ # Usage details of an entity -This schema defines type used for capturing 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 @@ -13,5 +13,5 @@ Type: `object` - usage `required` - List usage details per day. - Type: `array` - - **_Items_** + - **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 eae09c82614..cd4e5fa34a3 100644 --- a/docs/openmetadata-apis/schemas/types/jdbc-connection.md +++ b/docs/openmetadata-apis/schemas/types/jdbc-connection.md @@ -21,25 +21,25 @@ Type: `object` - Type: `string` -## Definitions -**_driverClass_** +## Types defined in this schema +**driverClass** - Type used for JDBC driver class - Type: `string` -**_connectionUrl_** +**connectionUrl** - Type used for JDBC connection URL - Type: `string` - String format must be a "uri" -**_jdbcInfo_** +**jdbcInfo** - Type for capturing JDBC connector information - Type: `object` - - **_Properties_** + - **Properties** - driverClass `required` - $ref: [#/definitions/driverClass](#/definitions/driverClass) - Default: _"com.amazon.redshift.jdbc42.Driver"_ diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 12766f41682..7c12b53d405 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -1,6 +1,6 @@ # Profile -This schema defines type used to capture profile of a user, team, or an organization. +This schema defines the type used to capture 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 @@ -11,12 +11,12 @@ Type: `object` - $ref: [#/definitions/imageList](#/definitions/imageList) -## Definitions -**_imageList_** +## Types defined in this schema +**imageList** - - Links to list of images of varying resolutions/sizes. + - Links to a list of images of varying resolutions/sizes. - Type: `object` - - **_Properties_** + - **Properties** - image - 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 e79b0ed7abb..3ed06a6477b 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -1,6 +1,6 @@ # Type used for schedule with start time and repeat frequency -This schema defines type used for Schedule with start time and repeat frequency. +This schema defines the type used for schedule with 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 diff --git a/docs/openmetadata-apis/schemas/types/tag-label.md b/docs/openmetadata-apis/schemas/types/tag-label.md index e0e68b986cb..17e38abf108 100644 --- a/docs/openmetadata-apis/schemas/types/tag-label.md +++ b/docs/openmetadata-apis/schemas/types/tag-label.md @@ -1,6 +1,6 @@ # Tag Label -This schema defines type used for labeling an entity or an entity field with a Tag. +This schema defines the type used 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 diff --git a/docs/openmetadata-apis/schemas/types/usage-details.md b/docs/openmetadata-apis/schemas/types/usage-details.md index cccbbbd9e6a..d005ad6cb59 100644 --- a/docs/openmetadata-apis/schemas/types/usage-details.md +++ b/docs/openmetadata-apis/schemas/types/usage-details.md @@ -1,6 +1,6 @@ # Type used to return usage details of an entity -This schema defines type used for capturing 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. $id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json @@ -21,13 +21,13 @@ Type: `object` - $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate) -## Definitions -**_usageStats_** +## Types defined in this schema +**usageStats** - Type used to return usage statistics - Type: `object` - This schema does not accept additional properties. - - **_Properties_** + - **Properties** - count `required` - Usage count of a data asset on the start date. - Type: `integer`