diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md index 245b7edf484..0720ca948e2 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/dashboard.md @@ -1,6 +1,6 @@ # 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. +This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are updated in real-time and allow interactive data exploration. **$id:** [**https://open-metadata.org/schema/entity/data/dashboard.json**](https://open-metadata.org/schema/entity/data/dashboard.json) diff --git a/docs/openmetadata-apis/schemas/entities/database-service.md b/docs/openmetadata-apis/schemas/entities/database-service.md index 32ec28b683b..d5ddfee408c 100644 --- a/docs/openmetadata-apis/schemas/entities/database-service.md +++ b/docs/openmetadata-apis/schemas/entities/database-service.md @@ -1,6 +1,6 @@ # 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. +This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service. **$id:** [**https://open-metadata.org/schema/entity/services/databaseService.json**](https://open-metadata.org/schema/entity/services/databaseService.json) diff --git a/docs/openmetadata-apis/schemas/entities/database.md b/docs/openmetadata-apis/schemas/entities/database.md index 2ca4077e978..2a606a3012a 100644 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ b/docs/openmetadata-apis/schemas/entities/database.md @@ -1,6 +1,6 @@ # Database -This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables. +This schema defines the Database entity. A database also referred to as Database Catalog is a collection of tables. **$id:** [**https://open-metadata.org/schema/entity/data/database.json**](https://open-metadata.org/schema/entity/data/database.json) diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md index d135ef93232..0a9c8d4049a 100644 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/pipeline.md @@ -1,6 +1,6 @@ # 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. +This schema defines the Pipeline entity. A pipeline enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Load the data. **$id:** [**https://open-metadata.org/schema/entity/data/pipeline.json**](https://open-metadata.org/schema/entity/data/pipeline.json) diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md index 15bff79fd06..a39f5d3015e 100644 --- a/docs/openmetadata-apis/schemas/entities/report.md +++ b/docs/openmetadata-apis/schemas/entities/report.md @@ -1,6 +1,6 @@ # 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. +This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and visual form. **$id:** [**https://open-metadata.org/schema/entity/data/report.json**](https://open-metadata.org/schema/entity/data/report.json) @@ -12,7 +12,7 @@ Type: `object` * Unique identifier that identifies this report. * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#types-definitions-in-this-schema) * **name** `required` - * Name that identifies the this report instance uniquely. + * Name that identifies this report instance uniquely. * Type: `string` * Length: between 1 and 64 * **fullyQualifiedName** diff --git a/docs/openmetadata-apis/schemas/entities/tag-category.md b/docs/openmetadata-apis/schemas/entities/tag-category.md index c4dcd3d47f6..0850d951a53 100644 --- a/docs/openmetadata-apis/schemas/entities/tag-category.md +++ b/docs/openmetadata-apis/schemas/entities/tag-category.md @@ -1,6 +1,6 @@ # 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. +This schema defines the Tag Category entity. A Tag Category contains tags called Primary Tags. Primary Tags can further have children called Secondary Tags. Only two levels of tags are supported currently. **$id:** [**https://open-metadata.org/schema/entity/tags/tagCategory.json**](https://open-metadata.org/schema/entity/tags/tagCategory.json) diff --git a/docs/openmetadata-apis/schemas/entities/team.md b/docs/openmetadata-apis/schemas/entities/team.md index 5b97740db4c..fdd35133d69 100644 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ b/docs/openmetadata-apis/schemas/entities/team.md @@ -38,7 +38,7 @@ Type: `object` **teamName** -* A unique name of the team typically the team ID from an identity 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/user.md b/docs/openmetadata-apis/schemas/entities/user.md index 7abcdd6f482..654fb7ddcb8 100644 --- a/docs/openmetadata-apis/schemas/entities/user.md +++ b/docs/openmetadata-apis/schemas/entities/user.md @@ -54,7 +54,7 @@ This schema does not accept additional properties. **userName** -* A unique name of the user typically the user ID from an identity 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 47a6f0e32fc..aed4ad15b70 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 Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations. +This schema defines the Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations. **$id:** [**https://open-metadata.org/schema/type/auditLog.json**](https://open-metadata.org/schema/type/auditLog.json) @@ -23,15 +23,15 @@ Type: `object` * Requested API Path. * Type: `string` * **userName** `required` - * Name of the user who requested for the API. + * Name of the user who made the API request. * Type: `string` * **dateTime** - * Date which the api call is made. + * Date when the API call is made. * $ref: [basic.json\#/definitions/dateTime](basic.md#types-definitions-in-this-schema) * **entityId** `required` * Entity Id that was modified by the operation. * $ref: [basic.json\#/definitions/uuid](basic.md#types-definitions-in-this-schema) * **entityType** `required` - * Entity Type that modified by the operation. + * Entity Type that is modified by the operation. * Type: `string` diff --git a/docs/openmetadata-apis/schemas/types/entity-reference.md b/docs/openmetadata-apis/schemas/types/entity-reference.md index a4b54547b90..92d79745fa3 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 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. +This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database. **$id:** [**https://open-metadata.org/schema/type/entityReference.json**](https://open-metadata.org/schema/type/entityReference.json) @@ -15,7 +15,7 @@ Type: `object` * Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`... * Type: `string` * **name** - * Name of the entity instance. For entities such as tables, database where name is not unique, fullyQualifiedName is returned in this field. + * Name of the entity instance. For entities such as tables, databases where the name is not unique, fullyQualifiedName is returned in this field. * Type: `string` * **description** * Optional description of entity. diff --git a/docs/openmetadata-apis/schemas/types/jdbc-connection.md b/docs/openmetadata-apis/schemas/types/jdbc-connection.md index 7dd35812596..00092413e19 100644 --- a/docs/openmetadata-apis/schemas/types/jdbc-connection.md +++ b/docs/openmetadata-apis/schemas/types/jdbc-connection.md @@ -41,7 +41,6 @@ Type: `object` * **Properties** * **driverClass** `required` * $ref: [\#/definitions/driverClass](jdbc-connection.md#types-definitions-in-this-schema) - * Default: _"com.amazon.redshift.jdbc42.Driver"_ * **connectionUrl** `required` * $ref: [\#/definitions/connectionUrl](jdbc-connection.md#types-definitions-in-this-schema) diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 73949e7ea7d..b0201e0cb02 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 the type for profile of a user, team, or an organization. +This schema defines the type for a profile of a user, team, or organization. **$id:** [**https://open-metadata.org/schema/type/profile.json**](https://open-metadata.org/schema/type/profile.json) diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index 33757a72892..4ad2cb6405b 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -1,6 +1,6 @@ # Schedule -This schema defines the type used for schedule. Schedule has a start time and repeat frequency. +This schema defines the type used for the schedule. The schedule has a start time and repeat frequency. **$id:** [**https://open-metadata.org/schema/type/schedule.json**](https://open-metadata.org/schema/type/schedule.json) diff --git a/docs/openmetadata-apis/schemas/types/tag-label.md b/docs/openmetadata-apis/schemas/types/tag-label.md index 1eb7dd33b83..9bb72ed6b10 100644 --- a/docs/openmetadata-apis/schemas/types/tag-label.md +++ b/docs/openmetadata-apis/schemas/types/tag-label.md @@ -12,7 +12,7 @@ Type: `object` * 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. + * Label type describes how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using the associated tag relationship \(see TagCategory.json for more details\). 'Propagated\` indicates a tag label was propagated from upstream based on lineage. 'Automated' is used when a tool was used to determine the tag label. * Type: `string` * The value is restricted to the following: 1. _"Manual"_