yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-06 20:47:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated schema docs (#3329)

Browse Source 
* updated schema docs

* addressing ingestion-core version bump
This commit is contained in:
parthp2107 2022-03-10 12:55:35 +05:30 committed by GitHub
parent 6720fa9569
commit 794cf64787
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
53 changed files with 168 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json
View File

@ -20,7 +20,7 @@
"type": "string" "type": "string"
}, },
"source": { "source": {
"description": "Label is from Tags or Glossary", "description": "Label is from Tags or Glossary.",
"type": "string", "type": "string",
"enum": ["Tag", "Glossary"], "enum": ["Tag", "Glossary"],
"default": "Tag" "default": "Tag"

2
docs/openmetadata-apis/schemas/entities/accesscontrolrule.md
View File

@ -54,4 +54,4 @@ This schema <u>does not</u> accept additional properties.
8. _"UpdateTeam"_ 8. _"UpdateTeam"_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/bot.md
View File

@ -43,4 +43,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _false_ - Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/chart.md
View File

@ -93,4 +93,4 @@ This schema <u>does not</u> accept additional properties.
9. _"BoxPlot"_ 9. _"BoxPlot"_
10. _"Other"_ 10. _"Other"_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/dashboard.md
View File

@ -76,4 +76,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _false_ - Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/dashboardservice.md
View File

@ -79,4 +79,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/database.md
View File

@ -73,4 +73,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/databaseservice.md
View File

@ -113,4 +113,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/dbtmodel.md
View File

@ -110,4 +110,4 @@ This schema <u>does not</u> accept additional properties.
- Type: `string` - Type: `string`
- Length: between 1 and 256 - Length: between 1 and 256
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/deleteaction.md
View File

@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
- Range: &ge; 1 - Range: &ge; 1
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

6
docs/openmetadata-apis/schemas/entities/events/webhook.md
View File

@ -2,7 +2,7 @@
This schema defines webhook for receiving events from OpenMetadata. This schema defines webhook for receiving events from OpenMetadata.
<b id="https/open-metadata.org/schema/entity/events/webhook.json">&#36;id: https://open-metadata.org/schema/entity/events/webhook.json</b> **$id:** [**https://open-metadata.org/schema/entity/events/webhook.json**](https://open-metadata.org/schema/entity/events/webhook.json)
Type: `object` Type: `object`
@ -94,6 +94,6 @@ This schema <u>does not</u> accept additional properties.
- When `true` indicates the entity has been soft deleted. - When `true` indicates the entity has been soft deleted.
- Type: `boolean` - Type: `boolean`
- Default: _false_ - Default: _false_
g
_This document was updated on: Wednesday, March 9, 2022_
_This document was updated on: Monday, March 7, 2022_

2
docs/openmetadata-apis/schemas/entities/filters.md
View File

@ -27,4 +27,4 @@
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

5
docs/openmetadata-apis/schemas/entities/glossary.md
View File

@ -42,6 +42,9 @@ This schema <u>does not</u> accept additional properties.
- **owner** - **owner**
- Owner of this glossary. - Owner of this glossary.
- $ref: [../../type/entityReference.json](../types/entityreference.md) - $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageCount**
- Count of how many times terms from this glossary are used.
- Type: `integer`
- **tags** - **tags**
- Tags for this glossary. - Tags for this glossary.
- Type: `array` - Type: `array`
@ -66,4 +69,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

5
docs/openmetadata-apis/schemas/entities/glossaryterm.md
View File

@ -62,6 +62,9 @@ This schema <u>does not</u> accept additional properties.
- **reviewers** - **reviewers**
- User names of the reviewers for this glossary. - User names of the reviewers for this glossary.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) - $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**
- Tags for this glossary term. - Tags for this glossary term.
- Type: `array` - Type: `array`
@ -113,4 +116,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

3
docs/openmetadata-apis/schemas/entities/location.md
View File

@ -81,8 +81,9 @@ This schema <u>does not</u> accept additional properties.
2. _"Prefix"_ 2. _"Prefix"_
3. _"Database"_ 3. _"Database"_
4. _"Table"_ 4. _"Table"_
5. _"Iceberg"_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/messagingservice.md
View File

@ -80,4 +80,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/metrics.md
View File

@ -61,4 +61,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _false_ - Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/mlmodel.md
View File

@ -231,4 +231,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/moveaction.md
View File

@ -33,4 +33,4 @@ This schema <u>does not</u> accept additional properties.
- $ref: [../data/location.json](location.md) - $ref: [../data/location.json](location.md)
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/pipeline.md
View File

@ -171,4 +171,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/pipelineservice.md
View File

@ -71,4 +71,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/policy.md
View File

@ -88,4 +88,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/report.md
View File

@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _false_ - Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

6
docs/openmetadata-apis/schemas/entities/role.md
View File

@ -44,8 +44,8 @@ This schema <u>does not</u> accept additional properties.
- **users** - **users**
- Users that have this role assigned. - Users that have this role assigned.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist) - $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **default** - **defaultRole**
- If `true`, this role is set as default and will be assigned to all users. - If `true`, this role is set as default role and will be assigned to all users.
- Type: `boolean` - Type: `boolean`
- Default: _false_ - Default: _false_
- **teams** - **teams**
@ -63,4 +63,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/rule.md
View File

@ -29,4 +29,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _true_ - Default: _true_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/storageservice.md
View File

@ -50,4 +50,4 @@ This schema <u>does not</u> accept additional properties.
- Default: _false_ - Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

6
docs/openmetadata-apis/schemas/entities/table.md
View File

@ -122,6 +122,7 @@ This schema <u>does not</u> accept additional properties.
3. _"View"_ 3. _"View"_
4. _"SecureView"_ 4. _"SecureView"_
5. _"MaterializedView"_ 5. _"MaterializedView"_
6. _"Iceberg"_
### dataType ### dataType
@ -373,6 +374,9 @@ This schema <u>does not</u> accept additional properties.
- **distinctCount** - **distinctCount**
- Number of values that contain distinct values. - Number of values that contain distinct values.
- Type: `number` - Type: `number`
- **distinctProportion**
- Proportion of distinct values in a column.
- Type: `number`
- **min** - **min**
- Minimum value in a column. - Minimum value in a column.
- Types: `number`, `integer`, `string` - Types: `number`, `integer`, `string`
@ -492,4 +496,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/tagbased.md
View File

@ -21,4 +21,4 @@ This schema <u>does not</u> accept additional properties.
- Item Count: &ge; 1 - Item Count: &ge; 1
- **Items** - **Items**
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/tagcategory.md
View File

@ -71,4 +71,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/team.md
View File

@ -62,4 +62,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

9
docs/openmetadata-apis/schemas/entities/thread.md
View File

@ -40,14 +40,14 @@ This schema <u>does not</u> accept additional properties.
- When `true` indicates the thread has been resolved. - When `true` indicates the thread has been resolved.
- Type: `boolean` - Type: `boolean`
- Default: _false_ - Default: _false_
- **message** - **message** `required`
- The main message of the thread in markdown format. - The main message of the thread in markdown format.
- Type: `string` - Type: `string`
- **postsCount** - **postsCount**
- The total count of posts in the thread. - The total count of posts in the thread.
- Type: `integer` - Type: `integer`
- Default: `0` - Default: `0`
- **posts** `required` - **posts**
- Type: `array` - Type: `array`
- **Items** - **Items**
- $ref: [#/definitions/post](#post) - $ref: [#/definitions/post](#post)
@ -60,6 +60,9 @@ This schema <u>does not</u> accept additional properties.
- Type: `object` - Type: `object`
- This schema <u>does not</u> accept additional properties. - This schema <u>does not</u> accept additional properties.
- **Properties** - **Properties**
- **id** `required`
- Unique identifier that identifies the post.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **message** `required` - **message** `required`
- Message in markdown format. See markdown support for more details. - Message in markdown format. See markdown support for more details.
- Type: `string` - Type: `string`
@ -73,4 +76,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/topic.md
View File

@ -130,4 +130,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/entities/user.md
View File

@ -79,4 +79,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

171
docs/openmetadata-apis/schemas/entities/webhook.md
View File

@ -1,4 +1,4 @@
# ChangeEvent # Webhook
This schema defines webhook for receiving events from OpenMetadata. This schema defines webhook for receiving events from OpenMetadata.
@ -9,88 +9,91 @@ Type: `object`
This schema <u>does not</u> accept additional properties. This schema <u>does not</u> accept additional properties.
## Properties ## Properties
- **id** `required` - **id** `required`
- Unique ID associated with a webhook subscription. - Unique ID associated with a webhook subscription.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid) - $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required` - **name** `required`
- Unique name of the application receiving webhook events. - Unique name of the application receiving webhook events.
- Type: `string` - Type: `string`
- Length: between 1 and 128 - Length: between 1 and 128
- **description** - **displayName**
- Description of the application. - Display Name that identifies this webhook.
- Type: `string` - Type: `string`
- **endpoint** - **description**
- Endpoint to receive the webhook events over POST requests. - Description of the application.
- Type: `string` - Type: `string`
- String format must be a "uri" - **endpoint** `required`
- **eventFilters** - Endpoint to receive the webhook events over POST requests.
- Endpoint to receive the webhook events over POST requests. - Type: `string`
- Type: `array` - String format must be a "uri"
- **Items** - **eventFilters** `required`
- $ref: [../../type/changeEvent.json#/definitions/eventFilter](../types/changeevent.md#eventfilter) - Endpoint to receive the webhook events over POST requests.
- **batchSize** - Type: `array`
- Maximum number of events sent in a batch (Default 10). - **Items**
- Type: `integer` - $ref: [../../type/changeEvent.json#/definitions/eventFilter](../types/changeevent.md#eventfilter)
- Default: `10` - **batchSize**
- **timeout** - Maximum number of events sent in a batch (Default 10).
- Connection timeout in seconds. (Default 10s). - Type: `integer`
- Type: `integer` - Default: `10`
- Default: `10` - **timeout**
- **enabled** - Connection timeout in seconds. (Default 10s).
- When set to `true`, the webhook event notification is enabled. Set it to `false` to disable the subscription. (Default `true`). - Type: `integer`
- Type: `boolean` - Default: `10`
- Default: _true_ - **enabled**
- **secretKey** - When set to `true`, the webhook event notification is enabled. Set it to `false` to disable the subscription. (Default `true`).
- 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: `boolean`
- Type: `string` - Default: _true_
- **version** - **secretKey**
- Metadata version of the entity. - 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.
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion) - Type: `string`
- **updatedAt** - **version**
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. - Metadata version of the entity.
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
- **updatedBy** - **updatedAt**
- User who made the update. - Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
- Type: `string` - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
- **status** - **updatedBy**
- 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. - User who made the update.
- Type: `string` - Type: `string`
- The value is restricted to the following: - **status**
1. _"notStarted"_ - 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.
2. _"started"_ - Type: `string`
3. _"failed"_ - The value is restricted to the following:
4. _"awaitingRetry"_ 1. _"disabled"_
5. _"retryLimitReached"_ 2. _"failed"_
- **failureDetails** 3. _"retryLimitReached"_
- Failure details are set only when `status` is not `success`. 4. _"awaitingRetry"_
- Type: `object` 5. _"active"_
- This schema <u>does not</u> accept additional properties. - **failureDetails**
- **Properties** - Failure details are set only when `status` is not `success`.
- **lastSuccessfulAt** - Type: `object`
- Last non-successful callback time in UNIX UTC epoch time in milliseconds. - This schema <u>does not</u> accept additional properties.
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - **Properties**
- **lastFailedAt** - **lastSuccessfulAt**
- Last non-successful callback time in UNIX UTC epoch time in milliseconds. - Last non-successful callback time in UNIX UTC epoch time in milliseconds.
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
- **lastFailedStatusCode** - **lastFailedAt**
- Last non-successful activity response code received during callback. - Last non-successful callback time in UNIX UTC epoch time in milliseconds.
- Type: `integer` - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
- **lastFailedReason** - **lastFailedStatusCode**
- Last non-successful activity response reason received during callback. - Last non-successful activity response code received during callback.
- Type: `string` - Type: `integer`
- **nextAttempt** - **lastFailedReason**
- Next retry will be done at this time in Unix epoch time milliseconds. Only valid is `status` is `awaitingRetry`. - Last non-successful activity response reason received during callback.
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp) - Type: `string`
- **href** - **nextAttempt**
- Link to this webhook resource. - Next retry will be done at this time in Unix epoch time milliseconds. Only valid is `status` is `awaitingRetry`.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href) - $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
- **changeDescription** - **href**
- Change that lead to this version of the entity. - Link to this webhook resource.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription) - $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **deleted** - **changeDescription**
- When `true` indicates the entity has been soft deleted. - Change that lead to this version of the entity.
- Type: `boolean` - $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
- Default: _false_ - **deleted**
- When `true` indicates the entity has been soft deleted.
- Type: `boolean`
- Default: _false_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/auditlog.md
View File

@ -37,4 +37,4 @@ This schema <u>does not</u> accept additional properties.
- $ref: [basic.json#/definitions/timestamp](basic.md#timestamp) - $ref: [basic.json#/definitions/timestamp](basic.md#timestamp)
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/basic.md
View File

@ -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_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/changeevent.md
View File

@ -68,4 +68,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/dailycount.md
View File

@ -17,4 +17,4 @@ This schema <u>does not</u> accept additional properties.
- $ref: [basic.json#/definitions/date](basic.md#date) - $ref: [basic.json#/definitions/date](basic.md#date)
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/databaseconnectionconfig.md
View File

@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
- Type: `string` - Type: `string`
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/entityhistory.md
View File

@ -74,4 +74,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/entitylineage.md
View File

@ -61,4 +61,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/entityreference.md
View File

@ -39,4 +39,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/entityrelationship.md
View File

@ -67,4 +67,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/entityusage.md
View File

@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
- $ref: [usageDetails.json](usagedetails.md) - $ref: [usageDetails.json](usagedetails.md)
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/include.md
View File

@ -13,4 +13,4 @@ The value is restricted to the following:
3. _"non-deleted"_ 3. _"non-deleted"_
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/jdbcconnection.md
View File

@ -50,4 +50,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/paging.md
View File

@ -20,4 +20,4 @@ This schema <u>does not</u> accept additional properties.
- Type: `integer` - Type: `integer`
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/profile.md
View File

@ -45,4 +45,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/schedule.md
View File

@ -17,4 +17,4 @@ This schema <u>does not</u> accept additional properties.
- $ref: [basic.json#/definitions/duration](basic.md#duration) - $ref: [basic.json#/definitions/duration](basic.md#duration)
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/storage.md
View File

@ -62,4 +62,4 @@ Definitions related to Storage Service.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

13
docs/openmetadata-apis/schemas/types/taglabel.md
View File

@ -1,8 +1,8 @@
# Tag Label # TagLabel
This schema defines the type for labeling an entity with a Tag. 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) <b id="https/open-metadata.org/schema/type/taglabel.json">&#36;id: https://open-metadata.org/schema/type/tagLabel.json</b>
Type: `object` Type: `object`
@ -14,6 +14,13 @@ This schema <u>does not</u> accept additional properties.
- **description** - **description**
- Unique name of the tag category. - Unique name of the tag category.
- Type: `string` - 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` - **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. - 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` - Type: `string`
@ -44,4 +51,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

2
docs/openmetadata-apis/schemas/types/usagedetails.md
View File

@ -42,4 +42,4 @@ This schema <u>does not</u> accept additional properties.
_This document was updated on: Monday, March 7, 2022_ _This document was updated on: Wednesday, March 9, 2022_

3
ingestion-core/src/metadata/_version.py
View File

@ -7,6 +7,5 @@ Provides metadata version information.
from incremental import Version from incremental import Version
__version__ = Version("metadata", 0, 9, 0, dev=25)
__version__ = Version("metadata", 0, 9, 0, dev=24)
__all__ = ["__version__"] __all__ = ["__version__"]