From 794cf64787cd41adbeba507e77371bafda886b87 Mon Sep 17 00:00:00 2001 From: parthp2107 <83201188+parthp2107@users.noreply.github.com> Date: Thu, 10 Mar 2022 12:55:35 +0530 Subject: [PATCH] updated schema docs (#3329) * updated schema docs * addressing ingestion-core version bump --- .../resources/json/schema/type/tagLabel.json | 2 +- .../schemas/entities/accesscontrolrule.md | 2 +- .../openmetadata-apis/schemas/entities/bot.md | 2 +- .../schemas/entities/chart.md | 2 +- .../schemas/entities/dashboard.md | 2 +- .../schemas/entities/dashboardservice.md | 2 +- .../schemas/entities/database.md | 2 +- .../schemas/entities/databaseservice.md | 2 +- .../schemas/entities/dbtmodel.md | 2 +- .../schemas/entities/deleteaction.md | 2 +- .../schemas/entities/events/webhook.md | 6 +- .../schemas/entities/filters.md | 2 +- .../schemas/entities/glossary.md | 5 +- .../schemas/entities/glossaryterm.md | 5 +- .../schemas/entities/location.md | 3 +- .../schemas/entities/messagingservice.md | 2 +- .../schemas/entities/metrics.md | 2 +- .../schemas/entities/mlmodel.md | 2 +- .../schemas/entities/moveaction.md | 2 +- .../schemas/entities/pipeline.md | 2 +- .../schemas/entities/pipelineservice.md | 2 +- .../schemas/entities/policy.md | 2 +- .../schemas/entities/report.md | 2 +- .../schemas/entities/role.md | 6 +- .../schemas/entities/rule.md | 2 +- .../schemas/entities/storageservice.md | 2 +- .../schemas/entities/table.md | 6 +- .../schemas/entities/tagbased.md | 2 +- .../schemas/entities/tagcategory.md | 2 +- .../schemas/entities/team.md | 2 +- .../schemas/entities/thread.md | 9 +- .../schemas/entities/topic.md | 2 +- .../schemas/entities/user.md | 2 +- .../schemas/entities/webhook.md | 171 +++++++++--------- .../schemas/types/auditlog.md | 2 +- docs/openmetadata-apis/schemas/types/basic.md | 2 +- .../schemas/types/changeevent.md | 2 +- .../schemas/types/dailycount.md | 2 +- .../schemas/types/databaseconnectionconfig.md | 2 +- .../schemas/types/entityhistory.md | 2 +- .../schemas/types/entitylineage.md | 2 +- .../schemas/types/entityreference.md | 2 +- .../schemas/types/entityrelationship.md | 2 +- .../schemas/types/entityusage.md | 2 +- .../schemas/types/include.md | 2 +- .../schemas/types/jdbcconnection.md | 2 +- .../openmetadata-apis/schemas/types/paging.md | 2 +- .../schemas/types/profile.md | 2 +- .../schemas/types/schedule.md | 2 +- .../schemas/types/storage.md | 2 +- .../schemas/types/taglabel.md | 13 +- .../schemas/types/usagedetails.md | 2 +- ingestion-core/src/metadata/_version.py | 3 +- 53 files changed, 168 insertions(+), 145 deletions(-) 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 438254b4b9d..0c079aa16ff 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 @@ -20,7 +20,7 @@ "type": "string" }, "source": { - "description": "Label is from Tags or Glossary", + "description": "Label is from Tags or Glossary.", "type": "string", "enum": ["Tag", "Glossary"], "default": "Tag" diff --git a/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md b/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md index 6fed228aeaf..6bf9aae682c 100644 --- a/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md +++ b/docs/openmetadata-apis/schemas/entities/accesscontrolrule.md @@ -54,4 +54,4 @@ This schema does not accept additional properties. 8. _"UpdateTeam"_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 76e1b691e04..07661ad82cd 100644 --- a/docs/openmetadata-apis/schemas/entities/bot.md +++ b/docs/openmetadata-apis/schemas/entities/bot.md @@ -43,4 +43,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 cf65e1bc00b..2e5147f4259 100644 --- a/docs/openmetadata-apis/schemas/entities/chart.md +++ b/docs/openmetadata-apis/schemas/entities/chart.md @@ -93,4 +93,4 @@ This schema does not accept additional properties. 9. _"BoxPlot"_ 10. _"Other"_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 547a8cc0d8a..8c9a1243fb6 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/dashboard.md @@ -76,4 +76,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 e03808b0008..c4470ab763a 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboardservice.md +++ b/docs/openmetadata-apis/schemas/entities/dashboardservice.md @@ -79,4 +79,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 8b35cbfe339..dc0c8656448 100644 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ b/docs/openmetadata-apis/schemas/entities/database.md @@ -73,4 +73,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 4f9cba3606c..b3ecc26c49d 100644 --- a/docs/openmetadata-apis/schemas/entities/databaseservice.md +++ b/docs/openmetadata-apis/schemas/entities/databaseservice.md @@ -113,4 +113,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 eb8b2920ae6..ac2eb2e04c6 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 7f91e011f35..1569a7e0327 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 index f9d307f5a16..f18234a3f92 100644 --- a/docs/openmetadata-apis/schemas/entities/events/webhook.md +++ b/docs/openmetadata-apis/schemas/entities/events/webhook.md @@ -2,7 +2,7 @@ This schema defines webhook for receiving events from OpenMetadata. -$id: https://open-metadata.org/schema/entity/events/webhook.json +**$id:** [**https://open-metadata.org/schema/entity/events/webhook.json**](https://open-metadata.org/schema/entity/events/webhook.json) Type: `object` @@ -94,6 +94,6 @@ This schema does not accept additional properties. - When `true` indicates the entity has been soft deleted. - Type: `boolean` - Default: _false_ +g - -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 d0b3e0bf805..5d63444370e 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 index b51e2f42a47..daec7729913 100644 --- a/docs/openmetadata-apis/schemas/entities/glossary.md +++ b/docs/openmetadata-apis/schemas/entities/glossary.md @@ -42,6 +42,9 @@ This schema does not accept additional properties. - **owner** - Owner of this glossary. - $ref: [../../type/entityReference.json](../types/entityreference.md) + - **usageCount** + - Count of how many times terms from this glossary are used. + - Type: `integer` - **tags** - Tags for this glossary. - Type: `array` @@ -66,4 +69,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 index f6b3f03f04b..678efb71f9e 100644 --- a/docs/openmetadata-apis/schemas/entities/glossaryterm.md +++ b/docs/openmetadata-apis/schemas/entities/glossaryterm.md @@ -62,6 +62,9 @@ This schema does not accept additional properties. - **reviewers** - User names of the reviewers for this glossary. - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) + - **usageCount** + - Count of how many times this and it's children glossary terms are used as labels. + - Type: `integer` - **tags** - Tags for this glossary term. - Type: `array` @@ -113,4 +116,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 85b42922287..bfab1d73cba 100644 --- a/docs/openmetadata-apis/schemas/entities/location.md +++ b/docs/openmetadata-apis/schemas/entities/location.md @@ -81,8 +81,9 @@ This schema does not accept additional properties. 2. _"Prefix"_ 3. _"Database"_ 4. _"Table"_ + 5. _"Iceberg"_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 b10d0d4d213..b8a51d2b7ba 100644 --- a/docs/openmetadata-apis/schemas/entities/messagingservice.md +++ b/docs/openmetadata-apis/schemas/entities/messagingservice.md @@ -80,4 +80,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 945aaa2f9ef..6ed00c272b2 100644 --- a/docs/openmetadata-apis/schemas/entities/metrics.md +++ b/docs/openmetadata-apis/schemas/entities/metrics.md @@ -61,4 +61,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 6243b097b5f..81b2b8d8a66 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 9a50e75b2bd..ea06047327e 100644 --- a/docs/openmetadata-apis/schemas/entities/moveaction.md +++ b/docs/openmetadata-apis/schemas/entities/moveaction.md @@ -33,4 +33,4 @@ This schema does not accept additional properties. - $ref: [../data/location.json](location.md) -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 5d8c5c3f9a7..d348deea49f 100644 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/pipeline.md @@ -171,4 +171,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 94fb298a03b..87034c4a383 100644 --- a/docs/openmetadata-apis/schemas/entities/pipelineservice.md +++ b/docs/openmetadata-apis/schemas/entities/pipelineservice.md @@ -71,4 +71,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 446fb2ada19..253c51f1aff 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 629d7a1f340..15534d49c0e 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 a054005fdfd..1f592b30e94 100644 --- a/docs/openmetadata-apis/schemas/entities/role.md +++ b/docs/openmetadata-apis/schemas/entities/role.md @@ -44,8 +44,8 @@ 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. + - **defaultRole** + - If `true`, this role is set as default role and will be assigned to all users. - Type: `boolean` - Default: _false_ - **teams** @@ -63,4 +63,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 54fd9e49a20..31cb266e054 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 e5dd76be45b..81135d22172 100644 --- a/docs/openmetadata-apis/schemas/entities/storageservice.md +++ b/docs/openmetadata-apis/schemas/entities/storageservice.md @@ -50,4 +50,4 @@ This schema does not accept additional properties. - Default: _false_ -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 3251ef69313..fabd46f435b 100644 --- a/docs/openmetadata-apis/schemas/entities/table.md +++ b/docs/openmetadata-apis/schemas/entities/table.md @@ -122,6 +122,7 @@ This schema does not accept additional properties. 3. _"View"_ 4. _"SecureView"_ 5. _"MaterializedView"_ + 6. _"Iceberg"_ ### dataType @@ -373,6 +374,9 @@ This schema does not accept additional properties. - **distinctCount** - Number of values that contain distinct values. - Type: `number` + - **distinctProportion** + - Proportion of distinct values in a column. + - Type: `number` - **min** - Minimum value in a column. - Types: `number`, `integer`, `string` @@ -492,4 +496,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 7432070badb..03a856c0926 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 546b89c3c87..981a65629b5 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 2acf66d8db5..f818fa60b47 100644 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ b/docs/openmetadata-apis/schemas/entities/team.md @@ -62,4 +62,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 9e532bd63d8..d9d44585cca 100644 --- a/docs/openmetadata-apis/schemas/entities/thread.md +++ b/docs/openmetadata-apis/schemas/entities/thread.md @@ -40,14 +40,14 @@ This schema does not accept additional properties. - When `true` indicates the thread has been resolved. - Type: `boolean` - Default: _false_ - - **message** + - **message** `required` - 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` + - **posts** - Type: `array` - **Items** - $ref: [#/definitions/post](#post) @@ -60,6 +60,9 @@ This schema does not accept additional properties. - Type: `object` - This schema does not accept additional properties. - **Properties** + - **id** `required` + - Unique identifier that identifies the post. + - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) - **message** `required` - Message in markdown format. See markdown support for more details. - Type: `string` @@ -73,4 +76,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 acc9a3249ad..15f985bf8ff 100644 --- a/docs/openmetadata-apis/schemas/entities/topic.md +++ b/docs/openmetadata-apis/schemas/entities/topic.md @@ -130,4 +130,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 131aa785e64..359de2d1674 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 54eedfcf280..7d6d5ff1324 100644 --- a/docs/openmetadata-apis/schemas/entities/webhook.md +++ b/docs/openmetadata-apis/schemas/entities/webhook.md @@ -1,4 +1,4 @@ -# ChangeEvent +# Webhook This schema defines webhook for receiving events from OpenMetadata. @@ -9,88 +9,91 @@ 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 - - **description** - - Description of the application. - - Type: `string` - - **endpoint** - - Endpoint to receive the webhook events over POST requests. - - Type: `string` - - String format must be a "uri" - - **eventFilters** - - 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 `notStarted`, when webhook was created with `enabled` set to false and it never started publishing events. Status is `started` 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. _"notStarted"_ - 2. _"started"_ - 3. _"failed"_ - 4. _"awaitingRetry"_ - 5. _"retryLimitReached"_ - - **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_ +- **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 +_This document was updated on: Wednesday, March 9, 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 0a064e91588..71c3a5d7b1a 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 7c538315d47..66243364fd2 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -83,4 +83,4 @@ This schema defines basic common types that are used by other schemas. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 80409b2c6bb..0cece59fc2c 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 101ad8eb14e..2e9e838cbd4 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 e0599e56d94..026c1f373aa 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 3c9cdf6eba5..7dd1dada778 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 ab56ef1b68b..9e78b4df7cd 100644 --- a/docs/openmetadata-apis/schemas/types/entitylineage.md +++ b/docs/openmetadata-apis/schemas/types/entitylineage.md @@ -61,4 +61,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 5883dc27297..2df47abfa20 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 a79a5965f05..d7600433b1c 100644 --- a/docs/openmetadata-apis/schemas/types/entityrelationship.md +++ b/docs/openmetadata-apis/schemas/types/entityrelationship.md @@ -67,4 +67,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 2683d83d3c5..b959d03d2c3 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 5a3765591b3..1281ca415e2 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 b022d18f1be..fca7ca4169e 100644 --- a/docs/openmetadata-apis/schemas/types/jdbcconnection.md +++ b/docs/openmetadata-apis/schemas/types/jdbcconnection.md @@ -50,4 +50,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 7a1e7ff31b6..d17e0314689 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 9a989bdd782..915c32bd2f2 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -45,4 +45,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 962e84e29df..c07acaa1034 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -17,4 +17,4 @@ This schema does not accept additional properties. - $ref: [basic.json#/definitions/duration](basic.md#duration) -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 20817864d22..854f539aaac 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 9e8388cb3aa..3361272af20 100644 --- a/docs/openmetadata-apis/schemas/types/taglabel.md +++ b/docs/openmetadata-apis/schemas/types/taglabel.md @@ -1,8 +1,8 @@ -# Tag Label +# TagLabel This schema defines the type for labeling an entity with a Tag. -**$id:**[**https://open-metadata.org/schema/type/tagLabel.json**](https://open-metadata.org/schema/type/tagLabel.json) +$id: https://open-metadata.org/schema/type/tagLabel.json Type: `object` @@ -14,6 +14,13 @@ This schema does not accept additional properties. - **description** - Unique name of the tag category. - Type: `string` + - **source** `required` + - Label is from Tags or Glossary. + - Type: `string` + - The value is restricted to the following: + 1. _"Tag"_ + 2. _"Glossary"_ + - Default: _"Tag"_ - **labelType** `required` - 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` @@ -44,4 +51,4 @@ This schema does not accept additional properties. -_This document was updated on: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 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 0a716eeb8ea..9d389c0ebd0 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: Monday, March 7, 2022_ \ No newline at end of file +_This document was updated on: Wednesday, March 9, 2022_ \ No newline at end of file diff --git a/ingestion-core/src/metadata/_version.py b/ingestion-core/src/metadata/_version.py index bcb0209a7f0..5d6bea44be0 100644 --- a/ingestion-core/src/metadata/_version.py +++ b/ingestion-core/src/metadata/_version.py @@ -7,6 +7,5 @@ Provides metadata version information. from incremental import Version - -__version__ = Version("metadata", 0, 9, 0, dev=24) +__version__ = Version("metadata", 0, 9, 0, dev=25) __all__ = ["__version__"]