diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index 589f5f942f1..b5d8c3b26e7 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -4,17 +4,17 @@ This schema defines basic common types that are used by other schemas. **$id:** [**https://open-metadata.org/schema/type/basic.json**](https://open-metadata.org/schema/type/basic.json) -## Types definitions in this schema +## Type definitions in this schema **uuid** -* Unique id used to identify an entity. +* Unique id used to identify an entity * Type: `string` * String format must be a "uuid" **email** -* Email address of a user or other entities. +* 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+$` @@ -22,7 +22,7 @@ This schema defines basic common types that are used by other schemas. **entityLink** -* Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`. +* Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}` * Type: `string` * The value must match this pattern: `^<#E/\S+/\S+>$` @@ -34,7 +34,7 @@ This schema defines basic common types that are used by other schemas. **href** -* href that points to a resource. +* URI that points to a resource * Type: `string` * String format must be a "uri" @@ -43,7 +43,7 @@ This schema defines basic common types that are used by other schemas. * Type: `object` * **Properties** * **start** - * Start time in unixTimeMillis. + * Start time in unixTimeMillis * Type: `integer` * **end** * End time in unixTimeMillis. @@ -51,18 +51,18 @@ This schema defines basic common types that are used by other schemas. **duration** -* Duration in ISO 8601 format in UTC. Example - 'P23DT23H'. +* Duration in ISO 8601 format in UTC. Example - 'P23DT23H' * Type: `string` **date** -* Date in ISO 8601 format in UTC. Example - '2018-11-13'. +* 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'. +* Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00' * Type: `string` * String format must be a "date-Time"