diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json index 71d23d68c3f..20bd708ecd5 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json @@ -15,11 +15,11 @@ "type": "object", "properties": { "name": { - "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`", + "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.", "type": "string" }, "endpoint": { - "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`", + "description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.", "type": "string", "format": "uri" } diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json index f9b1bf05128..6a11bac186b 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json @@ -82,7 +82,7 @@ "$ref": "#/definitions/fullyQualifiedFeatureSourceName" }, "dataSource": { - "description": "Description of the Data Source (e.g., a Table)", + "description": "Description of the Data Source (e.g., a Table).", "$ref": "../../type/entityReference.json" }, "tags": { 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 a5568a3c9dd..daba5e7aab8 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 @@ -9,11 +9,7 @@ "javaType": "org.openmetadata.catalog.type.StatusType", "description": "Enum defining the possible Status.", "type": "string", - "enum": [ - "Successful", - "Failed", - "Pending" - ], + "enum": ["Successful", "Failed", "Pending"], "javaEnums": [ { "name": "Successful" @@ -108,7 +104,7 @@ "$ref": "#/definitions/statusType" }, "taskStatus": { - "description": "Series of task executions and its status", + "description": "Series of task executions and its status.", "type": "array", "items": { "$ref": "#/definitions/taskStatus" @@ -180,7 +176,7 @@ "default": null }, "pipelineStatus": { - "description": "Series of pipeline executions and its status", + "description": "Series of pipeline executions and its status.", "type": "array", "items": { "$ref": "#/definitions/pipelineStatus" 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 733c21c692a..4f088bf2dd7 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 @@ -110,7 +110,7 @@ "maxLength": 128 }, "tableName": { - "description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically", + "description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically.", "type": "string", "minLength": 1, "maxLength": 128 @@ -636,4 +636,4 @@ }, "required": ["id", "name", "columns"], "additionalProperties": false -} \ No newline at end of file +} diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json b/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json index 9895807f959..84252ec43d8 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json @@ -2,7 +2,7 @@ "$id": "https://open-metadata.org/schema/entity/events/webhook.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Webhook", - "description": "This schema defines webhook for receiving events from OpenMetadata", + "description": "This schema defines webhook for receiving events from OpenMetadata.", "type": "object", "javaType": "org.openmetadata.catalog.type.Webhook", "properties": { 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 5189fc97bc8..7cb879a9892 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 @@ -24,7 +24,7 @@ "$ref": "../../type/basic.json#/definitions/timestamp" }, "from": { - "description": "Name of the User posting the message", + "description": "Name of the User posting the message.", "type": "string" } }, @@ -70,16 +70,16 @@ "type": "string" }, "resolved": { - "description": "When `true` indicates the thread has been resolved", + "description": "When `true` indicates the thread has been resolved.", "type": "boolean", "default": false }, "message": { - "description": "The main message of the thread in markdown format", + "description": "The main message of the thread in markdown format.", "type": "string" }, "postsCount": { - "description": "The total count of posts in the thread", + "description": "The total count of posts in the thread.", "type": "integer", "default": 0 }, diff --git a/catalog-rest-service/src/main/resources/json/schema/type/entityRelationship.json b/catalog-rest-service/src/main/resources/json/schema/type/entityRelationship.json index c25e3d26a60..36686482ffc 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/entityRelationship.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/entityRelationship.json @@ -82,7 +82,7 @@ "minimum": 0 }, "relationshipType": { - "description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table", + "description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table.", "$ref": "#/definitions/relationshipType" }, "deleted": { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/include.json b/catalog-rest-service/src/main/resources/json/schema/type/include.json index e75c766d4a8..429c0d6be2e 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/include.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/include.json @@ -2,7 +2,7 @@ "$id": "https://open-metadata.org/schema/type/include.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Include", - "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include", + "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include.", "type": "string", "javaType": "org.openmetadata.catalog.type.Include", "enum": ["all", "deleted", "non-deleted"], diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index fc9c0691a30..c2cf431bd64 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -70,6 +70,8 @@ * [Delete Action](openmetadata-apis/schemas/entities/deleteaction.md) * [Feed](openmetadata-apis/schemas/entities/thread.md) * [Filters](openmetadata-apis/schemas/entities/filters.md) + * [Glossary](openmetadata-apis/schemas/entities/glossary.md) + * [Glossary Term](openmetadata-apis/schemas/entities/glossaryterm.md) * [Location](openmetadata-apis/schemas/entities/location.md) * [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md) * [Metrics](openmetadata-apis/schemas/entities/metrics.md) diff --git a/docs/openmetadata-apis/schemas/entities/README.md b/docs/openmetadata-apis/schemas/entities/README.md index 719a52b11e8..e929dcc9fa0 100644 --- a/docs/openmetadata-apis/schemas/entities/README.md +++ b/docs/openmetadata-apis/schemas/entities/README.md @@ -52,6 +52,14 @@ OpenMetadata has the following high-level core entities and relationships: [filters.md](filters.md) {% endcontent-ref %} +{% content-ref url="glossary.md" %} +[filters.md](glossary.md) +{% endcontent-ref %} + +{% content-ref url="glossaryterm.md" %} +[filters.md](glossaryterm.md) +{% endcontent-ref %} + {% content-ref url="location.md" %} [location.md](location.md) {% endcontent-ref %} diff --git a/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md b/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md index 68d7b3e1eb0..6fed228aeaf 100644 --- a/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md +++ b/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md @@ -20,7 +20,7 @@ This schema does not accept additional properties. - $ref: [../../type/tagLabel.json#/definitions/tagFQN](../types/taglabel.md#tagfqn) - **userRoleAttr** - Role of the user that the rule should match on. - - $ref: [../teams/team.json#/definitions/teamName](team.md#teamname) + - $ref: [../teams/role.json#/definitions/roleName](role.md#rolename) - **operation** - Operation on the entity. - $ref: [#/definitions/operation](#operation) @@ -50,7 +50,8 @@ This schema does not accept additional properties. 4. _"UpdateOwner"_ 5. _"UpdateTags"_ 6. _"UpdateLineage"_ + 7. _"DecryptTokens"_ + 8. _"UpdateTeam"_ - -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/bot.md b/docs/openmetadata-apis/schemas/entities/bot.md index 3560799156c..76e1b691e04 100644 --- a/docs/openmetadata-apis/schemas/entities/bot.md +++ b/docs/openmetadata-apis/schemas/entities/bot.md @@ -6,6 +6,8 @@ This schema defines Bot entity. A bot automates tasks, such as adding descriptio Type: `object` +This schema does not accept additional properties. + ## Properties - **id** - Unique identifier of a bot instance. @@ -41,4 +43,4 @@ Type: `object` - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/chart.md b/docs/openmetadata-apis/schemas/entities/chart.md index f24c2b4d97e..cf65e1bc00b 100644 --- a/docs/openmetadata-apis/schemas/entities/chart.md +++ b/docs/openmetadata-apis/schemas/entities/chart.md @@ -63,7 +63,7 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json](../types/entityreference.md) - **serviceType** - Service type where this chart is hosted in. - - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype) + - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype) - **usageSummary** - Latest usage information for this database. - $ref: [../../type/usageDetails.json](../types/usagedetails.md) @@ -93,4 +93,4 @@ This schema does not accept additional properties. 9. _"BoxPlot"_ 10. _"Other"_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md index b007fcb8a7f..547a8cc0d8a 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/dashboard.md @@ -63,7 +63,7 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json](../types/entityreference.md) - **serviceType** - Service type where this dashboard is hosted in. - - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype) + - $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype) - **usageSummary** - Latest usage information for this database. - $ref: [../../type/usageDetails.json](../types/usagedetails.md) @@ -76,4 +76,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/dashboardservice.md b/docs/openmetadata-apis/schemas/entities/dashboardservice.md index bfccff9850b..e03808b0008 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboardservice.md +++ b/docs/openmetadata-apis/schemas/entities/dashboardservice.md @@ -15,6 +15,7 @@ This schema does not accept additional properties. - **name** `required` - Name that identifies this dashboard service. - Type: `string` + - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 - **displayName** - Display Name that identifies this dashboard service. @@ -34,6 +35,9 @@ This schema does not accept additional properties. - **updatedBy** - User who made the update. - Type: `string` + - **owner** + - Owner of this dashboard service. + - $ref: [../../type/entityReference.json](../types/entityreference.md) - **dashboardUrl** `required` - Dashboard Service URL. This will be used to make REST API calls to Dashboard Service. - Type: `string` @@ -70,8 +74,9 @@ This schema does not accept additional properties. 3. _"Tableau"_ 4. _"Redash"_ 5. _"Metabase"_ + 6. _"PowerBI"_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/database.md b/docs/openmetadata-apis/schemas/entities/database.md index 8602dd17427..8b35cbfe339 100644 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ b/docs/openmetadata-apis/schemas/entities/database.md @@ -44,7 +44,7 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json](../types/entityreference.md) - **serviceType** - Service type where this database is hosted in. - - $ref: [../services/databaseService.json#/definitions/databaseServiceType](../services/databaseservice.md#databaseservicetype) + - $ref: [../services/databaseService.json#/definitions/databaseServiceType](databaseservice.md#databaseservicetype) - **location** - Reference to the Location that contains this database. - $ref: [../../type/entityReference.json](../types/entityreference.md) @@ -68,10 +68,9 @@ This schema does not accept additional properties. - Name that identifies the database. - Type: `string` - - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/databaseservice.md b/docs/openmetadata-apis/schemas/entities/databaseservice.md index 8dc9ea0dfa5..4f9cba3606c 100644 --- a/docs/openmetadata-apis/schemas/entities/databaseservice.md +++ b/docs/openmetadata-apis/schemas/entities/databaseservice.md @@ -9,67 +9,108 @@ Type: `object` This schema does not accept additional properties. ## Properties -- **id** `required` - - Unique identifier of this database service instance. - - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) -- **name** `required` - - Name that identifies this database service. - - Type: `string` - - Length: between 1 and 128 -- **displayName** - - Display Name that identifies this database service. - - Type: `string` -- **serviceType** `required` - - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... - - $ref: [#/definitions/databaseServiceType](#databaseservicetype) -- **description** - - Description of a database service instance. - - Type: `string` -- **version** - - Metadata version of the entity. - - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) -- **updatedAt** - - Last update time corresponding to the new version of the entity. - - $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime) -- **updatedBy** - - User who made the update. - - Type: `string` -- **href** `required` - - Link to the resource corresponding to this database service. - - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) -- **jdbc** `required` - - JDBC connection information. - - $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](../types/jdbcconnection.md#jdbcinfo) -- **ingestionSchedule** - - Schedule for running metadata ingestion jobs. - - $ref: [../../type/schedule.json](../types/schedule.md) -- **changeDescription** - - Change that lead to this version of the entity. - - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) + - **id** `required` + - Unique identifier of this database service instance. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) + - **name** `required` + - Name that identifies this database service. + - Type: `string` + - The value must match this pattern: `^[^.]*$` + - Length: between 1 and 128 + - **displayName** + - Display Name that identifies this database service. + - Type: `string` + - **serviceType** `required` + - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... + - $ref: [#/definitions/databaseServiceType](#databaseservicetype) + - **description** + - Description of a database service instance. + - Type: `string` + - **databaseConnection** `required` + - $ref: [#/definitions/databaseConnection](#databaseconnection) + - **airflowPipelines** + - References to airflow pipelines deployed for this database service. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **version** + - Metadata version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) + - **updatedAt** + - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **updatedBy** + - User who made the update. + - Type: `string` + - **owner** + - Owner of this database service. + - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **href** `required` + - Link to the resource corresponding to this database service. + - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) + - **changeDescription** + - Change that lead to this version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) + - **deleted** + - When `true` indicates the entity has been soft deleted. + - Type: `boolean` + - Default: _false_ ## Type 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"_ - 8. _"Oracle"_ - 9. _"Athena"_ - 10. _"Presto"_ - 11. _"Trino"_ - 12. _"Vertica"_ - 13. _"Glue"_ - 14. _"MariaDB"_ - 15. _"Druid"_ + - 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"_ + 8. _"Oracle"_ + 9. _"Athena"_ + 10. _"Presto"_ + 11. _"Trino"_ + 12. _"Vertica"_ + 13. _"Glue"_ + 14. _"MariaDB"_ + 15. _"Druid"_ + 16. _"Db2"_ + 17. _"ClickHouse"_ + 18. _"Databricks"_ + 19. _"DynamoDB"_ + 20. _"AzureSQL"_ + 21. _"SingleStore"_ + 22. _"SQLite"_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +### databaseConnection + + - Database Connection. + - Type: `object` + - This schema does not accept additional properties. + - **Properties** + - **username** + - username to connect to the data source. + - Type: `string` + - **password** + - password to connect to the data source. + - Type: `string` + - **hostPort** + - Host and port of the data source. + - Type: `string` + - **database** + - Database of the data source. + - Type: `string` + - **connectionOptions** + - Additional connection options that can be sent to service during the connection. + - Type: `object` + - **connectionArguments** + - Additional connection arguments such as security or protocol configs that can be sent to service during connection. + - Type: `object` + + + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/dbtmodel.md b/docs/openmetadata-apis/schemas/entities/dbtmodel.md index 66c9a82aeba..eb8b2920ae6 100644 --- a/docs/openmetadata-apis/schemas/entities/dbtmodel.md +++ b/docs/openmetadata-apis/schemas/entities/dbtmodel.md @@ -110,4 +110,4 @@ This schema does not accept additional properties. - Type: `string` - Length: between 1 and 256 -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/deleteaction.md b/docs/openmetadata-apis/schemas/entities/deleteaction.md index f618f110b19..7f91e011f35 100644 --- a/docs/openmetadata-apis/schemas/entities/deleteaction.md +++ b/docs/openmetadata-apis/schemas/entities/deleteaction.md @@ -19,4 +19,4 @@ This schema does not accept additional properties. - Range: ≥ 1 -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/events/webhook.md b/docs/openmetadata-apis/schemas/entities/events/webhook.md new file mode 100644 index 00000000000..f9d307f5a16 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/events/webhook.md @@ -0,0 +1,99 @@ +# Webhook + +This schema defines webhook for receiving events from OpenMetadata. + +$id: https://open-metadata.org/schema/entity/events/webhook.json + +Type: `object` + +This schema does not accept additional properties. + +## Properties + - **id** `required` + - Unique ID associated with a webhook subscription. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) + - **name** `required` + - Unique name of the application receiving webhook events. + - Type: `string` + - Length: between 1 and 128 + - **displayName** + - Display Name that identifies this webhook. + - Type: `string` + - **description** + - Description of the application. + - Type: `string` + - **endpoint** `required` + - Endpoint to receive the webhook events over POST requests. + - Type: `string` + - String format must be a "uri" + - **eventFilters** `required` + - Endpoint to receive the webhook events over POST requests. + - Type: `array` + - **Items** + - $ref: [../../type/changeEvent.json#/definitions/eventFilter](../types/changeevent.md#eventfilter) + - **batchSize** + - Maximum number of events sent in a batch (Default 10). + - Type: `integer` + - Default: `10` + - **timeout** + - Connection timeout in seconds. (Default 10s). + - Type: `integer` + - Default: `10` + - **enabled** + - When set to `true`, the webhook event notification is enabled. Set it to `false` to disable the subscription. (Default `true`). + - Type: `boolean` + - Default: _true_ + - **secretKey** + - Secret set by the webhook client used for computing HMAC SHA256 signature of webhook payload and sent in `X-OM-Signature` header in POST requests to publish the events. + - Type: `string` + - **version** + - Metadata version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) + - **updatedAt** + - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **updatedBy** + - User who made the update. + - Type: `string` + - **status** + - Status is `disabled`, when webhook was created with `enabled` set to false and it never started publishing events. Status is `active` when webhook is normally functioning and 200 OK response was received for callback notification. Status is `failed` on bad callback URL, connection failures, `1xx`, and `3xx` response was received for callback notification. Status is `awaitingRetry` when previous attempt at callback timed out or received `4xx`, `5xx` response. Status is `retryLimitReached` after all retries fail. + - Type: `string` + - The value is restricted to the following: + 1. _"disabled"_ + 2. _"failed"_ + 3. _"retryLimitReached"_ + 4. _"awaitingRetry"_ + 5. _"active"_ + - **failureDetails** + - Failure details are set only when `status` is not `success`. + - Type: `object` + - This schema does not accept additional properties. + - **Properties** + - **lastSuccessfulAt** + - Last non-successful callback time in UNIX UTC epoch time in milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **lastFailedAt** + - Last non-successful callback time in UNIX UTC epoch time in milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **lastFailedStatusCode** + - Last non-successful activity response code received during callback. + - Type: `integer` + - **lastFailedReason** + - Last non-successful activity response reason received during callback. + - Type: `string` + - **nextAttempt** + - Next retry will be done at this time in Unix epoch time milliseconds. Only valid is `status` is `awaitingRetry`. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **href** + - Link to this webhook resource. + - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) + - **changeDescription** + - Change that lead to this version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) + - **deleted** + - When `true` indicates the entity has been soft deleted. + - Type: `boolean` + - Default: _false_ + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/filters.md b/docs/openmetadata-apis/schemas/entities/filters.md index d8e58bc6242..d0b3e0bf805 100644 --- a/docs/openmetadata-apis/schemas/entities/filters.md +++ b/docs/openmetadata-apis/schemas/entities/filters.md @@ -27,4 +27,4 @@ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/glossary.md b/docs/openmetadata-apis/schemas/entities/glossary.md new file mode 100644 index 00000000000..b51e2f42a47 --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/glossary.md @@ -0,0 +1,69 @@ +# Glossary + +This schema defines the Glossary entity. A Glossary is collection of hierarchical GlossaryTerms. + +**$id:**[**https//:open-metadata.org/schema/entity/data/glossary.json**](https://open-metadata.org/schema/entity/data/glossary.json) + +Type: `object` + +This schema does not accept additional properties. + +## Properties + - **id** `required` + - Unique identifier of a glossary instance. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) + - **name** `required` + - Preferred name for the glossary term. + - $ref: [#/definitions/name](#name) + - Type: `string` + - **displayName** + - Display Name that identifies this glossary. + - Type: `string` + - **description** + - Description of the glossary. + - Type: `string` + - **version** + - Metadata version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) + - **updatedAt** + - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **updatedBy** + - User who made the update. + - Type: `string` + - **href** + - Link to the resource corresponding to this entity. + - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) + - **reviewers** + - User references of the reviewers for this glossary. + - Type: `array` + - **Items** + - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **owner** + - Owner of this glossary. + - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **tags** + - Tags for this glossary. + - Type: `array` + - **Items** + - $ref: [../../type/tagLabel.json](../types/taglabel.md) + - **changeDescription** + - Change that lead to this version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) + - **deleted** + - When `true` indicates the entity has been soft deleted. + - Type: `boolean` + - Default: _false_ + + +## Type definitions in this schema +### name + + - Name that identifies a glossary term. + - Type: `string` + - Length: between 1 and 128 + + + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/glossaryterm.md b/docs/openmetadata-apis/schemas/entities/glossaryterm.md new file mode 100644 index 00000000000..f6b3f03f04b --- /dev/null +++ b/docs/openmetadata-apis/schemas/entities/glossaryterm.md @@ -0,0 +1,116 @@ +# GlossaryTerm + +This schema defines te Glossary term entities. + +**$id:**[**https//:open-metadata.org/schema/entity/data/glossaryTerm.json**](https://open-metadata.org/schema/entity/data/glossaryTerm.json) + +Type: `object` + +This schema does not accept additional properties. + +## Properties + - **id** `required` + - Unique identifier of a glossary term instance. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) + - **name** `required` + - Preferred name for the glossary term. + - $ref: [#/definitions/name](#name) + - **displayName** + - Display Name that identifies this glossary. + - Type: `string` + - **description** + - Description of the glossary term. + - Type: `string` + - **fullyQualifiedName** + - A unique name that identifies a glossary term. It captures name hierarchy of glossary of terms in the form of `glossaryName.parentTerm.childTerm`. + - Type: `string` + - Length: between 1 and 256 + - **synonyms** + - Alternate names that are synonyms or near-synonyms for the glossary term. + - Type: `array` + - **Items** + - $ref: [#/definitions/name](#name) + - **glossary** `required` + - Glossary that this term belongs to. + - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **parent** + - Parent glossary term that this term is child of. When `null` this term is the root term of the glossary. + - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **children** + - Other glossary terms that are children of this glossary term. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **relatedTerms** + - Other glossary terms that are related to this glossary term. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **references** + - Link to a reference from an external glossary. + - Type: `array` + - **Items** + - $ref: [../../entity/data/glossaryTerm.json#/definitions/termReference](glossaryterm.md#termreference) + - **version** + - Metadata version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) + - **updatedAt** + - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **updatedBy** + - User who made the update. + - Type: `string` + - **href** + - Link to the resource corresponding to this entity. + - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) + - **reviewers** + - User names of the reviewers for this glossary. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **tags** + - Tags for this glossary term. + - Type: `array` + - **Items** + - $ref: [../../type/tagLabel.json](../types/taglabel.md) + - **changeDescription** + - Change that lead to this version of the entity. + - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) + - **status** + - Status of the glossary term. + - $ref: [#/definitions/status](#status) + - **deleted** + - When `true` indicates the entity has been soft deleted. + - Type: `boolean` + - Default: _false_ + + +## Type definitions in this schema +### name + + - Name that identifies a glossary term. + - Type: `string` + - Length: between 1 and 128 + + +### termReference + + - Type: `object` + - This schema does not accept additional properties. + - **Properties** + - **name** + - Name that identifies the source of an external glossary term. Example `HealthCare.gov`. + - Type: `string` + - **endpoint** + - Name that identifies the source of an external glossary term. Example `HealthCare.gov`. + - Type: `string` + - String format must be a "uri" + + +### status + + - Type: `string` + - The value is restricted to the following: + 1. _"Draft"_ + 2. _"Approved"_ + 3. _"Deprecated"_ + - Default: _"Draft"_ + + + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/location.md b/docs/openmetadata-apis/schemas/entities/location.md index e2e291d3252..85b42922287 100644 --- a/docs/openmetadata-apis/schemas/entities/location.md +++ b/docs/openmetadata-apis/schemas/entities/location.md @@ -85,4 +85,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/messagingservice.md b/docs/openmetadata-apis/schemas/entities/messagingservice.md index 816eadf2c77..b10d0d4d213 100644 --- a/docs/openmetadata-apis/schemas/entities/messagingservice.md +++ b/docs/openmetadata-apis/schemas/entities/messagingservice.md @@ -15,6 +15,7 @@ This schema does not accept additional properties. - **name** `required` - Name that identifies this messaging service. - Type: `string` + - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 - **serviceType** `required` - Type of messaging service such as Kafka or Pulsar... @@ -44,6 +45,9 @@ This schema does not accept additional properties. - **ingestionSchedule** - Schedule for running metadata ingestion jobs. - $ref: [../../type/schedule.json](../types/schedule.md) + - **owner** + - Owner of this messaging service. + - $ref: [../../type/entityReference.json](../types/entityreference.md) - **href** - Link to the resource corresponding to this messaging service. - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) @@ -76,4 +80,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/metrics.md b/docs/openmetadata-apis/schemas/entities/metrics.md index a688ea30edc..945aaa2f9ef 100644 --- a/docs/openmetadata-apis/schemas/entities/metrics.md +++ b/docs/openmetadata-apis/schemas/entities/metrics.md @@ -60,4 +60,5 @@ This schema does not accept additional properties. - Type: `boolean` - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/mlmodel.md b/docs/openmetadata-apis/schemas/entities/mlmodel.md index 2181a91214c..6243b097b5f 100644 --- a/docs/openmetadata-apis/schemas/entities/mlmodel.md +++ b/docs/openmetadata-apis/schemas/entities/mlmodel.md @@ -231,4 +231,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/moveaction.md b/docs/openmetadata-apis/schemas/entities/moveaction.md index 293db0c854f..9a50e75b2bd 100644 --- a/docs/openmetadata-apis/schemas/entities/moveaction.md +++ b/docs/openmetadata-apis/schemas/entities/moveaction.md @@ -20,16 +20,17 @@ This schema does not accept additional properties. - **destination** - Location where this entity needs to be moved to. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **storageServiceType** - The storage service to move this entity to. - - $ref: [storageService.json](storageservice.md) + - $ref: [../services/storageService.json](storageservice.md) - **storageClassType** - The storage class to move this entity to. - - $ref: [../type/storage.json#/definitions/storageClassType](../types/storage.md#storageclasstype) + - $ref: [../../type/storage.json#/definitions/storageClassType](../types/storage.md#storageclasstype) - **location** - The location where to move this entity to. - - $ref: [location.json](location.md) + - $ref: [../data/location.json](location.md) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md index 85db0b17ff3..5d8c5c3f9a7 100644 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/pipeline.md @@ -52,6 +52,11 @@ This schema does not accept additional properties. - Type: `array` - **Items** - $ref: [#/definitions/task](#task) + - **pipelineStatus** + - Series of pipeline executions and its status. + - Type: `array` + - **Items** + - $ref: [#/definitions/pipelineStatus](#pipelinestatus) - **followers** - Followers of this Pipeline. - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) @@ -82,9 +87,34 @@ This schema does not accept additional properties. ## Type definitions in this schema +### statusType + + - Enum defining the possible Status. + - Type: `string` + - The value is restricted to the following: + 1. _"Successful"_ + 2. _"Failed"_ + 3. _"Pending"_ + + +### taskStatus + + - This schema defines a time series of the status of a Pipeline or Task. + - Type: `object` + - This schema does not accept additional properties. + - **Properties** + - **name** + - Name of the Task. + - Type: `string` + - **executionStatus** + - Status at a specific execution date. + - $ref: [#/definitions/statusType](#statustype) + + ### task - Type: `object` + - This schema does not accept additional properties. - **Properties** - **name** `required` - Name that identifies this task instance uniquely. @@ -119,4 +149,26 @@ This schema does not accept additional properties. - **Items** - $ref: [../../type/tagLabel.json](../types/taglabel.md) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file + +### pipelineStatus + + - Series of pipeline executions, its status and task status. + - Type: `object` + - This schema does not accept additional properties. + - **Properties** + - **executionDate** + - Date where the job was executed. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **executionStatus** + - Status at a specific execution date. + - $ref: [#/definitions/statusType](#statustype) + - **taskStatus** + - Series of task executions and its status. + - Type: `array` + - **Items** + - $ref: [#/definitions/taskStatus](#taskstatus) + + + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/pipelineservice.md b/docs/openmetadata-apis/schemas/entities/pipelineservice.md index 931feea028b..94fb298a03b 100644 --- a/docs/openmetadata-apis/schemas/entities/pipelineservice.md +++ b/docs/openmetadata-apis/schemas/entities/pipelineservice.md @@ -15,6 +15,7 @@ This schema does not accept additional properties. - **name** `required` - Name that identifies this pipeline service. - Type: `string` + - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 - **serviceType** - Type of pipeline service such as Airflow or Prefect... @@ -41,6 +42,9 @@ This schema does not accept additional properties. - **ingestionSchedule** - Schedule for running metadata ingestion jobs. - $ref: [../../type/schedule.json](../types/schedule.md) + - **owner** + - Owner of this pipeline service. + - $ref: [../../type/entityReference.json](../types/entityreference.md) - **href** - Link to the resource corresponding to this pipeline service. - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) @@ -62,8 +66,9 @@ This schema does not accept additional properties. 1. _"Airflow"_ 2. _"Prefect"_ 3. _"Glue"_ + 4. _"Generic"_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/policy.md b/docs/openmetadata-apis/schemas/entities/policy.md index cf387390fdf..446fb2ada19 100644 --- a/docs/openmetadata-apis/schemas/entities/policy.md +++ b/docs/openmetadata-apis/schemas/entities/policy.md @@ -88,4 +88,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md index 7af4f835cb4..629d7a1f340 100644 --- a/docs/openmetadata-apis/schemas/entities/report.md +++ b/docs/openmetadata-apis/schemas/entities/report.md @@ -56,4 +56,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/role.md b/docs/openmetadata-apis/schemas/entities/role.md index 0e8d1fa5a80..a054005fdfd 100644 --- a/docs/openmetadata-apis/schemas/entities/role.md +++ b/docs/openmetadata-apis/schemas/entities/role.md @@ -44,16 +44,23 @@ This schema does not accept additional properties. - **users** - Users that have this role assigned. - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **default** + - If `true`, this role is set as default and will be assigned to all users. + - Type: `boolean` + - Default: _false_ + - **teams** + - Teams that have this role assigned. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) ## Type definitions in this schema ### roleName - - A unique name of the role. + - A unique name for the role. - Type: `string` - Length: between 1 and 128 -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/rule.md b/docs/openmetadata-apis/schemas/entities/rule.md index f08764ec9b8..54fd9e49a20 100644 --- a/docs/openmetadata-apis/schemas/entities/rule.md +++ b/docs/openmetadata-apis/schemas/entities/rule.md @@ -29,4 +29,4 @@ This schema does not accept additional properties. - Default: _true_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/storageservice.md b/docs/openmetadata-apis/schemas/entities/storageservice.md index 316f7a8ae56..e5dd76be45b 100644 --- a/docs/openmetadata-apis/schemas/entities/storageservice.md +++ b/docs/openmetadata-apis/schemas/entities/storageservice.md @@ -15,6 +15,7 @@ This schema does not accept additional properties. - **name** `required` - Name that identifies this storage service. - Type: `string` + - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 - **displayName** - Display Name that identifies this storage service. @@ -37,6 +38,9 @@ This schema does not accept additional properties. - **href** `required` - Link to the resource corresponding to this storage service. - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) + - **owner** + - Owner of this storage service. + - $ref: [../../type/entityReference.json](../types/entityreference.md) - **changeDescription** - Change that lead to this version of the entity. - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) @@ -46,4 +50,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/table.md b/docs/openmetadata-apis/schemas/entities/table.md index 49a918c650b..3251ef69313 100644 --- a/docs/openmetadata-apis/schemas/entities/table.md +++ b/docs/openmetadata-apis/schemas/entities/table.md @@ -47,6 +47,7 @@ This schema does not accept additional properties. - Table constraints. - Type: `array` - **Items** +#### TableConstraint - $ref: [#/definitions/tableConstraint](#tableconstraint) - **owner** - Owner of this table. @@ -59,7 +60,7 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json](../types/entityreference.md) - **serviceType** - Service type this table is hosted in. - - $ref: [../services/databaseService.json#/definitions/databaseServiceType](../services/databaseservice.md#databaseservicetype) + - $ref: [../services/databaseService.json#/definitions/databaseServiceType](databaseservice.md#databaseservicetype) - **location** - Reference to the Location that contains this table. - $ref: [../../type/entityReference.json](../types/entityreference.md) @@ -93,6 +94,11 @@ This schema does not accept additional properties. - Type: `array` - **Items** - $ref: [#/definitions/sqlQuery](#sqlquery) + - **tableTests** + - List of test cases that ran against a table. + - Type: `array` + - **Items** + - $ref: [../../tests/tableTest.json](../tests/tabletest.md) - **dataModel** - This captures information about how the table is modeled. Currently only DBT model is supported. - $ref: [#/definitions/dataModel](#datamodel) @@ -158,6 +164,7 @@ This schema does not accept additional properties. 33. _"GEOGRAPHY"_ 34. _"ENUM"_ 35. _"JSON"_ + 36. _"UUID"_ ### constraint @@ -173,8 +180,10 @@ This schema does not accept additional properties. ### tableConstraint +## TableConstraint - This enum defines the type for table constraint. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **constraintType** - Type: `string` @@ -193,15 +202,13 @@ This schema does not accept additional properties. - Local name (not fully qualified name) of the column. ColumnName is `-` when the column is not named in struct dataType. For example, BigQuery supports struct with unnamed fields. - Type: `string` - - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 ### tableName - - Local name (not fully qualified name) of a table. + - Local name (not fully qualified name) of a table. Dots will be escaped automatically. - Type: `string` - - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 @@ -220,6 +227,9 @@ This schema does not accept additional properties. - **Properties** - **name** `required` - $ref: [#/definitions/columnName](#columnname) + - **displayName** + - Display Name that identifies this column name. + - Type: `string` - **dataType** `required` - Data type of the column (int, date etc.). - $ref: [#/definitions/dataType](#datatype) @@ -256,6 +266,11 @@ This schema does not accept additional properties. - Type: `array` - **Items** - $ref: [#/definitions/column](#column) + - **columnTests** + - List of column test cases that ran against a table column. + - Type: `array` + - **Items** + - $ref: [../../tests/columnTest.json](../tests/columntest.md) ### columnJoins @@ -271,6 +286,7 @@ This schema does not accept additional properties. - Type: `array` - **Items** - Type: `object` + - This schema does not accept additional properties. - **Properties** - **fullyQualifiedName** - $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname) @@ -359,9 +375,15 @@ This schema does not accept additional properties. - Type: `number` - **min** - Minimum value in a column. - - Type: `number` + - Types: `number`, `integer`, `string` - **max** - Maximum value in a column. + - Types: `number`, `integer`, `string` + - **minLength** + - Minimum string length in a column. + - Type: `number` + - **maxLength** + - Maximum string length in a column. - Type: `number` - **mean** - Avg value in a column. @@ -405,6 +427,7 @@ This schema does not accept additional properties. - This schema defines the type to capture the table's sql queries. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **query** - SQL Query text that matches the table name. @@ -437,6 +460,7 @@ This schema does not accept additional properties. - This captures information about how the table is modeled. Currently only DBT model is supported. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **modelType** `required` - $ref: [#/definitions/modelType](#modeltype) @@ -468,4 +492,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/tagbased.md b/docs/openmetadata-apis/schemas/entities/tagbased.md index ce3837ddda0..7432070badb 100644 --- a/docs/openmetadata-apis/schemas/entities/tagbased.md +++ b/docs/openmetadata-apis/schemas/entities/tagbased.md @@ -21,4 +21,4 @@ This schema does not accept additional properties. - Item Count: ≥ 1 - **Items** -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/tagcategory.md b/docs/openmetadata-apis/schemas/entities/tagcategory.md index 782b7ad132e..546b89c3c87 100644 --- a/docs/openmetadata-apis/schemas/entities/tagcategory.md +++ b/docs/openmetadata-apis/schemas/entities/tagcategory.md @@ -71,4 +71,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/team.md b/docs/openmetadata-apis/schemas/entities/team.md index 3060d370db0..2acf66d8db5 100644 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ b/docs/openmetadata-apis/schemas/entities/team.md @@ -47,6 +47,9 @@ This schema does not accept additional properties. - When `true` indicates the entity has been soft deleted. - Type: `boolean` - Default: _false_ + - **defaultRoles** + - Roles to be assigned to all users that are part of this team. + - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) ## Type definitions in this schema @@ -59,4 +62,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/thread.md b/docs/openmetadata-apis/schemas/entities/thread.md index cc59517b9ec..9e532bd63d8 100644 --- a/docs/openmetadata-apis/schemas/entities/thread.md +++ b/docs/openmetadata-apis/schemas/entities/thread.md @@ -19,11 +19,34 @@ This schema does not accept additional properties. - Timestamp of the when the first post created the thread in Unix epoch time milliseconds. - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - **about** `required` - - Data asset about which this thread is created for with format <#E/{entities}/{entityType}/{field}/{fieldValue}. + - Data asset about which this thread is created for with format <#E/{entities}/{entityName}/{field}/{fieldValue}. - $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink) + - **entityId** + - Entity Id of the entity that the thread belongs to. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) - **addressedTo** - - User or team this thread is addressed to in format <#E/{entities}/{entityType}/{field}/{fieldValue}. + - User or team this thread is addressed to in format <#E/{entities}/{entityName}/{field}/{fieldValue}. - $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink) + - **createdBy** + - User who created the thread. + - Type: `string` + - **updatedAt** + - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. + - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) + - **updatedBy** + - User who made the update. + - Type: `string` + - **resolved** + - When `true` indicates the thread has been resolved. + - Type: `boolean` + - Default: _false_ + - **message** + - The main message of the thread in markdown format. + - Type: `string` + - **postsCount** + - The total count of posts in the thread. + - Type: `integer` + - Default: `0` - **posts** `required` - Type: `array` - **Items** @@ -35,6 +58,7 @@ This schema does not accept additional properties. - Post within a feed. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **message** `required` - Message in markdown format. See markdown support for more details. @@ -43,10 +67,10 @@ This schema does not accept additional properties. - Timestamp of the post in Unix epoch time milliseconds. - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - **from** `required` - - ID of User (regular user or a bot) posting the message. - - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) + - Name of the User posting the message. + - Type: `string` -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/topic.md b/docs/openmetadata-apis/schemas/entities/topic.md index 33a22b95041..acc9a3249ad 100644 --- a/docs/openmetadata-apis/schemas/entities/topic.md +++ b/docs/openmetadata-apis/schemas/entities/topic.md @@ -38,17 +38,17 @@ This schema does not accept additional properties. - $ref: [../../type/entityReference.json](../types/entityreference.md) - **serviceType** - Service type where this topic is hosted in. - - $ref: [../services/messagingService.json#/definitions/messagingServiceType](../services/messagingservice.md#messagingservicetype) - - **partitions** `required` - - Number of partitions into which the topic is divided. - - Type: `integer` - - Range: ≥ 1 + - $ref: [../services/messagingService.json#/definitions/messagingServiceType](messagingservice.md#messagingservicetype) - **schemaText** - Schema used for message serialization. Optional as some topics may not have associated schemas. - Type: `string` - **schemaType** - Schema used for message serialization. - $ref: [#/definitions/schemaType](#schematype) + - **partitions** `required` + - Number of partitions into which the topic is divided. + - Type: `integer` + - Range: ≥ 1 - **cleanupPolicies** - Topic clean up policies. For Kafka - `cleanup.policy` configuration. - Type: `array` @@ -70,6 +70,9 @@ This schema does not accept additional properties. - Maximum size of a partition in bytes before old data is discarded. For Kafka - `retention.bytes` configuration. - Type: `integer` - Default: _"-1"_ + - **topicConfig** + - Contains key/value pair of topic configuration. + - $ref: [#/definitions/topicConfig](#topicconfig) - **owner** - Owner of this topic. - $ref: [../../type/entityReference.json](../types/entityreference.md) @@ -98,7 +101,6 @@ This schema does not accept additional properties. - Name that identifies a topic. - Type: `string` - - The value must match this pattern: `^[^.]*$` - Length: between 1 and 128 @@ -120,6 +122,12 @@ This schema does not accept additional properties. 2. _"compact"_ +### topicConfig + + - Contains key/value pair of topic configuration. + - Type: `object` -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/user.md b/docs/openmetadata-apis/schemas/entities/user.md index 8de9be77656..131aa785e64 100644 --- a/docs/openmetadata-apis/schemas/entities/user.md +++ b/docs/openmetadata-apis/schemas/entities/user.md @@ -79,4 +79,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/webhook.md b/docs/openmetadata-apis/schemas/entities/webhook.md index 91559c5b671..54eedfcf280 100644 --- a/docs/openmetadata-apis/schemas/entities/webhook.md +++ b/docs/openmetadata-apis/schemas/entities/webhook.md @@ -93,4 +93,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/auditlog.md b/docs/openmetadata-apis/schemas/types/auditlog.md index 741bf3543ea..0a064e91588 100644 --- a/docs/openmetadata-apis/schemas/types/auditlog.md +++ b/docs/openmetadata-apis/schemas/types/auditlog.md @@ -37,4 +37,4 @@ This schema does not accept additional properties. - $ref: [basic.json#/definitions/timestamp](basic.md#timestamp) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index fac8a41076f..7c538315d47 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -38,6 +38,7 @@ This schema defines basic common types that are used by other schemas. - Time interval in unixTimeMillis. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **start** - Start time in unixTimeMillis. @@ -69,7 +70,7 @@ This schema defines basic common types that are used by other schemas. ### entityLink - - Link to an entity or field within an entity using this format `<#E/{entities}/{entityType}/{field}/{fieldValue}`. + - Link to an entity or field within an entity using this format `<#E/{entities}/{entityType}/{field}/{arrayFieldName}/{arrayFieldValue}`. - Type: `string` - The value must match this pattern: `^<#E/\S+/\S+>$` @@ -82,4 +83,4 @@ This schema defines basic common types that are used by other schemas. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/changeevent.md b/docs/openmetadata-apis/schemas/types/changeevent.md index 7ef4b3db85e..80409b2c6bb 100644 --- a/docs/openmetadata-apis/schemas/types/changeevent.md +++ b/docs/openmetadata-apis/schemas/types/changeevent.md @@ -68,4 +68,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/dailycount.md b/docs/openmetadata-apis/schemas/types/dailycount.md index cfee29d9e9a..101ad8eb14e 100644 --- a/docs/openmetadata-apis/schemas/types/dailycount.md +++ b/docs/openmetadata-apis/schemas/types/dailycount.md @@ -17,4 +17,4 @@ This schema does not accept additional properties. - $ref: [basic.json#/definitions/date](basic.md#date) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/databaseconnectionconfig.md b/docs/openmetadata-apis/schemas/types/databaseconnectionconfig.md index dddb2ddc950..e0599e56d94 100644 --- a/docs/openmetadata-apis/schemas/types/databaseconnectionconfig.md +++ b/docs/openmetadata-apis/schemas/types/databaseconnectionconfig.md @@ -56,4 +56,4 @@ This schema does not accept additional properties. - Type: `string` -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityhistory.md b/docs/openmetadata-apis/schemas/types/entityhistory.md index 40d9aea3cd4..3c9cdf6eba5 100644 --- a/docs/openmetadata-apis/schemas/types/entityhistory.md +++ b/docs/openmetadata-apis/schemas/types/entityhistory.md @@ -74,4 +74,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entitylineage.md b/docs/openmetadata-apis/schemas/types/entitylineage.md index b90d591e37d..ab56ef1b68b 100644 --- a/docs/openmetadata-apis/schemas/types/entitylineage.md +++ b/docs/openmetadata-apis/schemas/types/entitylineage.md @@ -31,6 +31,7 @@ This schema does not accept additional properties. - Edge in the lineage graph from one entity to another by entity IDs. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **fromEntity** - From entity that is upstream of lineage edge. @@ -46,6 +47,7 @@ This schema does not accept additional properties. - Edge in the lineage graph from one entity to another using entity references. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **fromEntity** - From entity that is upstream of lineage edge. @@ -59,4 +61,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityreference.md b/docs/openmetadata-apis/schemas/types/entityreference.md index 2d34acf07f5..5883dc27297 100644 --- a/docs/openmetadata-apis/schemas/types/entityreference.md +++ b/docs/openmetadata-apis/schemas/types/entityreference.md @@ -39,4 +39,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityrelationship.md b/docs/openmetadata-apis/schemas/types/entityrelationship.md index a6a7cbb06f1..a79a5965f05 100644 --- a/docs/openmetadata-apis/schemas/types/entityrelationship.md +++ b/docs/openmetadata-apis/schemas/types/entityrelationship.md @@ -27,13 +27,44 @@ This schema does not accept additional properties. - **toEntity** `required` - Type of the entity towards which the relationship refers to. Examples: `database`, `table`, `metrics` ... - Type: `string` - - **relation** `required` - - Describes relationship between the two entities. - - Type: `string` + - **relation** + - Describes relationship between the two entities as an integer. + - Type: `integer` + - Range: ≥ 0 + - **relationshipType** `required` + - Describes relationship between the two entities. Eg: Database --- Contains --> Table. + - $ref: [#/definitions/relationshipType](#relationshiptype) - **deleted** - `true` indicates the relationship has been soft deleted. - Type: `boolean` - Default: _false_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +## Type definitions in this schema +### relationshipType + + - This enum captures all the relationships between Catalog entities. Note that the relationship from is a Strong entity and to is Weak entity when possible. + - Type: `string` + - The value is restricted to the following: + 1. _"contains"_ + 2. _"createdBy"_ + 3. _"repliedTo"_ + 4. _"isAbout"_ + 5. _"addressedTo"_ + 6. _"mentionedIn"_ + 7. _"testedBy"_ + 8. _"uses"_ + 9. _"owns"_ + 10. _"parentOf"_ + 11. _"has"_ + 12. _"follows"_ + 13. _"joinedWith"_ + 14. _"upstream"_ + 15. _"appliedTo"_ + 16. _"relatedTo"_ + 17. _"reviews"_ + + + + +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityusage.md b/docs/openmetadata-apis/schemas/types/entityusage.md index f63096f8fd2..2683d83d3c5 100644 --- a/docs/openmetadata-apis/schemas/types/entityusage.md +++ b/docs/openmetadata-apis/schemas/types/entityusage.md @@ -19,4 +19,4 @@ This schema does not accept additional properties. - $ref: [usageDetails.json](usagedetails.md) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/include.md b/docs/openmetadata-apis/schemas/types/include.md index 1f954225b76..5a3765591b3 100644 --- a/docs/openmetadata-apis/schemas/types/include.md +++ b/docs/openmetadata-apis/schemas/types/include.md @@ -13,4 +13,4 @@ The value is restricted to the following: 3. _"non-deleted"_ -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/jdbcconnection.md b/docs/openmetadata-apis/schemas/types/jdbcconnection.md index 9419321351a..b022d18f1be 100644 --- a/docs/openmetadata-apis/schemas/types/jdbcconnection.md +++ b/docs/openmetadata-apis/schemas/types/jdbcconnection.md @@ -40,6 +40,7 @@ This schema does not accept additional properties. - Type for capturing JDBC connector information. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **driverClass** `required` - $ref: [#/definitions/driverClass](#driverclass) @@ -49,4 +50,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/paging.md b/docs/openmetadata-apis/schemas/types/paging.md index cabba6e8a5a..7a1e7ff31b6 100644 --- a/docs/openmetadata-apis/schemas/types/paging.md +++ b/docs/openmetadata-apis/schemas/types/paging.md @@ -20,4 +20,4 @@ This schema does not accept additional properties. - Type: `integer` -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 6661a018688..9a989bdd782 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -6,6 +6,8 @@ This schema defines the type for a profile of a user, team, or organization. Type: `object` +This schema does not accept additional properties. + ## Properties - **images** - $ref: [#/definitions/imageList](#imagelist) @@ -16,6 +18,7 @@ Type: `object` - Links to a list of images of varying resolutions/sizes. - Type: `object` + - This schema does not accept additional properties. - **Properties** - **image** - Type: `string` @@ -42,4 +45,4 @@ Type: `object` -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index aaece9afa45..962e84e29df 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -6,6 +6,8 @@ This schema defines the type used for the schedule. The schedule has a start tim Type: `object` +This schema does not accept additional properties. + ## Properties - **startDate** - Start date and time of the schedule. @@ -15,4 +17,4 @@ Type: `object` - $ref: [basic.json#/definitions/duration](basic.md#duration) -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/storage.md b/docs/openmetadata-apis/schemas/types/storage.md index a46adffd83b..20817864d22 100644 --- a/docs/openmetadata-apis/schemas/types/storage.md +++ b/docs/openmetadata-apis/schemas/types/storage.md @@ -62,4 +62,4 @@ Definitions related to Storage Service. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/taglabel.md b/docs/openmetadata-apis/schemas/types/taglabel.md index 21e31bc8f13..9e8388cb3aa 100644 --- a/docs/openmetadata-apis/schemas/types/taglabel.md +++ b/docs/openmetadata-apis/schemas/types/taglabel.md @@ -44,4 +44,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/usagedetails.md b/docs/openmetadata-apis/schemas/types/usagedetails.md index 814bc3e8a52..0a716eeb8ea 100644 --- a/docs/openmetadata-apis/schemas/types/usagedetails.md +++ b/docs/openmetadata-apis/schemas/types/usagedetails.md @@ -42,4 +42,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, January 25, 2022_ \ No newline at end of file +_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file