mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-31 04:14:34 +00:00
updated schema docs (#3329)
* updated schema docs * addressing ingestion-core version bump
This commit is contained in:
parthp2107
GitHub
parent
6720fa9569
commit
794cf64787
@ -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"
|
||||
|
||||
@ -54,4 +54,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
8. _"UpdateTeam"_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -43,4 +43,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -93,4 +93,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
9. _"BoxPlot"_
|
||||
10. _"Other"_
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -76,4 +76,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -110,4 +110,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 256
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Range: ≥ 1
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This schema defines webhook for receiving events from OpenMetadata.
|
||||
|
||||
<b id="https/open-metadata.org/schema/entity/events/webhook.json">$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`
|
||||
|
||||
@ -94,6 +94,6 @@ This schema <u>does not</u> 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_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -27,4 +27,4 @@
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -42,6 +42,9 @@ This schema <u>does not</u> 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 <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_
|
||||
@ -62,6 +62,9 @@ This schema <u>does not</u> 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 <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_
|
||||
@ -81,8 +81,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
2. _"Prefix"_
|
||||
3. _"Database"_
|
||||
4. _"Table"_
|
||||
5. _"Iceberg"_
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -61,4 +61,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -33,4 +33,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../data/location.json](location.md)
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -44,8 +44,8 @@ This schema <u>does not</u> 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 <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_
|
||||
@ -29,4 +29,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _true_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -50,4 +50,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -122,6 +122,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
3. _"View"_
|
||||
4. _"SecureView"_
|
||||
5. _"MaterializedView"_
|
||||
6. _"Iceberg"_
|
||||
|
||||
|
||||
### dataType
|
||||
@ -373,6 +374,9 @@ This schema <u>does not</u> 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 <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_
|
||||
@ -21,4 +21,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Item Count: ≥ 1
|
||||
- **Items**
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -40,14 +40,14 @@ This schema <u>does not</u> 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 <u>does not</u> accept additional properties.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> 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 <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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -1,4 +1,4 @@
|
||||
# ChangeEvent
|
||||
# Webhook
|
||||
|
||||
This schema defines webhook for receiving events from OpenMetadata.
|
||||
|
||||
@ -9,88 +9,91 @@ Type: `object`
|
||||
This schema <u>does not</u> 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 <u>does not</u> 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 <u>does not</u> 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_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -37,4 +37,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -17,4 +17,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $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_
|
||||
@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `string`
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -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_
|
||||
@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [usageDetails.json](usagedetails.md)
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -13,4 +13,4 @@ The value is restricted to the following:
|
||||
3. _"non-deleted"_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -20,4 +20,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
||||
_This document was updated on: Wednesday, March 9, 2022_
|
||||
@ -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_
|
||||
@ -17,4 +17,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $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_
|
||||
@ -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_
|
||||
@ -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)
|
||||
<b id="https/open-metadata.org/schema/type/taglabel.json">$id: https://open-metadata.org/schema/type/tagLabel.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
@ -14,6 +14,13 @@ This schema <u>does not</u> 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 <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_
|
||||
@ -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_
|
||||
@ -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__"]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user