mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-12 11:39:39 +00:00
updated json schema and schema docs (#3219)
* updated json schema and schema docs * added glossay to readme
This commit is contained in:
parent
f540981de1
commit
a07bc411dc
@ -15,11 +15,11 @@
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`",
|
||||
"description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.",
|
||||
"type": "string"
|
||||
},
|
||||
"endpoint": {
|
||||
"description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`",
|
||||
"description": "Name that identifies the source of an external glossary term. Example `HealthCare.gov`.",
|
||||
"type": "string",
|
||||
"format": "uri"
|
||||
}
|
||||
|
@ -82,7 +82,7 @@
|
||||
"$ref": "#/definitions/fullyQualifiedFeatureSourceName"
|
||||
},
|
||||
"dataSource": {
|
||||
"description": "Description of the Data Source (e.g., a Table)",
|
||||
"description": "Description of the Data Source (e.g., a Table).",
|
||||
"$ref": "../../type/entityReference.json"
|
||||
},
|
||||
"tags": {
|
||||
|
@ -9,11 +9,7 @@
|
||||
"javaType": "org.openmetadata.catalog.type.StatusType",
|
||||
"description": "Enum defining the possible Status.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"Successful",
|
||||
"Failed",
|
||||
"Pending"
|
||||
],
|
||||
"enum": ["Successful", "Failed", "Pending"],
|
||||
"javaEnums": [
|
||||
{
|
||||
"name": "Successful"
|
||||
@ -108,7 +104,7 @@
|
||||
"$ref": "#/definitions/statusType"
|
||||
},
|
||||
"taskStatus": {
|
||||
"description": "Series of task executions and its status",
|
||||
"description": "Series of task executions and its status.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/taskStatus"
|
||||
@ -180,7 +176,7 @@
|
||||
"default": null
|
||||
},
|
||||
"pipelineStatus": {
|
||||
"description": "Series of pipeline executions and its status",
|
||||
"description": "Series of pipeline executions and its status.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/pipelineStatus"
|
||||
|
@ -110,7 +110,7 @@
|
||||
"maxLength": 128
|
||||
},
|
||||
"tableName": {
|
||||
"description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically",
|
||||
"description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
@ -636,4 +636,4 @@
|
||||
},
|
||||
"required": ["id", "name", "columns"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
}
|
||||
|
@ -2,7 +2,7 @@
|
||||
"$id": "https://open-metadata.org/schema/entity/events/webhook.json",
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "Webhook",
|
||||
"description": "This schema defines webhook for receiving events from OpenMetadata",
|
||||
"description": "This schema defines webhook for receiving events from OpenMetadata.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.Webhook",
|
||||
"properties": {
|
||||
|
@ -24,7 +24,7 @@
|
||||
"$ref": "../../type/basic.json#/definitions/timestamp"
|
||||
},
|
||||
"from": {
|
||||
"description": "Name of the User posting the message",
|
||||
"description": "Name of the User posting the message.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@ -70,16 +70,16 @@
|
||||
"type": "string"
|
||||
},
|
||||
"resolved": {
|
||||
"description": "When `true` indicates the thread has been resolved",
|
||||
"description": "When `true` indicates the thread has been resolved.",
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"message": {
|
||||
"description": "The main message of the thread in markdown format",
|
||||
"description": "The main message of the thread in markdown format.",
|
||||
"type": "string"
|
||||
},
|
||||
"postsCount": {
|
||||
"description": "The total count of posts in the thread",
|
||||
"description": "The total count of posts in the thread.",
|
||||
"type": "integer",
|
||||
"default": 0
|
||||
},
|
||||
|
@ -82,7 +82,7 @@
|
||||
"minimum": 0
|
||||
},
|
||||
"relationshipType": {
|
||||
"description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table",
|
||||
"description": "Describes relationship between the two entities. Eg: Database --- Contains --> Table.",
|
||||
"$ref": "#/definitions/relationshipType"
|
||||
},
|
||||
"deleted": {
|
||||
|
@ -2,7 +2,7 @@
|
||||
"$id": "https://open-metadata.org/schema/type/include.json",
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "Include",
|
||||
"description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include",
|
||||
"description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include.",
|
||||
"type": "string",
|
||||
"javaType": "org.openmetadata.catalog.type.Include",
|
||||
"enum": ["all", "deleted", "non-deleted"],
|
||||
|
@ -70,6 +70,8 @@
|
||||
* [Delete Action](openmetadata-apis/schemas/entities/deleteaction.md)
|
||||
* [Feed](openmetadata-apis/schemas/entities/thread.md)
|
||||
* [Filters](openmetadata-apis/schemas/entities/filters.md)
|
||||
* [Glossary](openmetadata-apis/schemas/entities/glossary.md)
|
||||
* [Glossary Term](openmetadata-apis/schemas/entities/glossaryterm.md)
|
||||
* [Location](openmetadata-apis/schemas/entities/location.md)
|
||||
* [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
|
||||
* [Metrics](openmetadata-apis/schemas/entities/metrics.md)
|
||||
|
@ -52,6 +52,14 @@ OpenMetadata has the following high-level core entities and relationships:
|
||||
[filters.md](filters.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="glossary.md" %}
|
||||
[filters.md](glossary.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="glossaryterm.md" %}
|
||||
[filters.md](glossaryterm.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="location.md" %}
|
||||
[location.md](location.md)
|
||||
{% endcontent-ref %}
|
||||
|
@ -20,7 +20,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/tagLabel.json#/definitions/tagFQN](../types/taglabel.md#tagfqn)
|
||||
- **userRoleAttr**
|
||||
- Role of the user that the rule should match on.
|
||||
- $ref: [../teams/team.json#/definitions/teamName](team.md#teamname)
|
||||
- $ref: [../teams/role.json#/definitions/roleName](role.md#rolename)
|
||||
- **operation**
|
||||
- Operation on the entity.
|
||||
- $ref: [#/definitions/operation](#operation)
|
||||
@ -50,7 +50,8 @@ This schema <u>does not</u> accept additional properties.
|
||||
4. _"UpdateOwner"_
|
||||
5. _"UpdateTags"_
|
||||
6. _"UpdateLineage"_
|
||||
7. _"DecryptTokens"_
|
||||
8. _"UpdateTeam"_
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -6,6 +6,8 @@ This schema defines Bot entity. A bot automates tasks, such as adding descriptio
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **id**
|
||||
- Unique identifier of a bot instance.
|
||||
@ -41,4 +43,4 @@ Type: `object`
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -63,7 +63,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **serviceType**
|
||||
- Service type where this chart is hosted in.
|
||||
- $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype)
|
||||
- $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype)
|
||||
- **usageSummary**
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
|
||||
@ -93,4 +93,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
9. _"BoxPlot"_
|
||||
10. _"Other"_
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -63,7 +63,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **serviceType**
|
||||
- Service type where this dashboard is hosted in.
|
||||
- $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](../services/dashboardservice.md#dashboardservicetype)
|
||||
- $ref: [../services/dashboardService.json#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype)
|
||||
- **usageSummary**
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
|
||||
@ -76,4 +76,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -15,6 +15,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **name** `required`
|
||||
- Name that identifies this dashboard service.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
- **displayName**
|
||||
- Display Name that identifies this dashboard service.
|
||||
@ -34,6 +35,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **owner**
|
||||
- Owner of this dashboard service.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **dashboardUrl** `required`
|
||||
- Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
|
||||
- Type: `string`
|
||||
@ -70,8 +74,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
3. _"Tableau"_
|
||||
4. _"Redash"_
|
||||
5. _"Metabase"_
|
||||
6. _"PowerBI"_
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -44,7 +44,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **serviceType**
|
||||
- Service type where this database is hosted in.
|
||||
- $ref: [../services/databaseService.json#/definitions/databaseServiceType](../services/databaseservice.md#databaseservicetype)
|
||||
- $ref: [../services/databaseService.json#/definitions/databaseServiceType](databaseservice.md#databaseservicetype)
|
||||
- **location**
|
||||
- Reference to the Location that contains this database.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
@ -68,10 +68,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Name that identifies the database.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -9,67 +9,108 @@ Type: `object`
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **id** `required`
|
||||
- Unique identifier of this database service instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- **name** `required`
|
||||
- Name that identifies this database service.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 128
|
||||
- **displayName**
|
||||
- Display Name that identifies this database service.
|
||||
- Type: `string`
|
||||
- **serviceType** `required`
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- $ref: [#/definitions/databaseServiceType](#databaseservicetype)
|
||||
- **description**
|
||||
- Description of a database service instance.
|
||||
- Type: `string`
|
||||
- **version**
|
||||
- Metadata version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
|
||||
- **updatedAt**
|
||||
- Last update time corresponding to the new version of the entity.
|
||||
- $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **href** `required`
|
||||
- Link to the resource corresponding to this database service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
- **jdbc** `required`
|
||||
- JDBC connection information.
|
||||
- $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](../types/jdbcconnection.md#jdbcinfo)
|
||||
- **ingestionSchedule**
|
||||
- Schedule for running metadata ingestion jobs.
|
||||
- $ref: [../../type/schedule.json](../types/schedule.md)
|
||||
- **changeDescription**
|
||||
- Change that lead to this version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
|
||||
- **id** `required`
|
||||
- Unique identifier of this database service instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- **name** `required`
|
||||
- Name that identifies this database service.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
- **displayName**
|
||||
- Display Name that identifies this database service.
|
||||
- Type: `string`
|
||||
- **serviceType** `required`
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- $ref: [#/definitions/databaseServiceType](#databaseservicetype)
|
||||
- **description**
|
||||
- Description of a database service instance.
|
||||
- Type: `string`
|
||||
- **databaseConnection** `required`
|
||||
- $ref: [#/definitions/databaseConnection](#databaseconnection)
|
||||
- **airflowPipelines**
|
||||
- References to airflow pipelines deployed for this database service.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
- **version**
|
||||
- Metadata version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
|
||||
- **updatedAt**
|
||||
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **owner**
|
||||
- Owner of this database service.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **href** `required`
|
||||
- Link to the resource corresponding to this database service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
- **changeDescription**
|
||||
- Change that lead to this version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
|
||||
- **deleted**
|
||||
- When `true` indicates the entity has been soft deleted.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
|
||||
### databaseServiceType
|
||||
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"BigQuery"_
|
||||
2. _"MySQL"_
|
||||
3. _"Redshift"_
|
||||
4. _"Snowflake"_
|
||||
5. _"Postgres"_
|
||||
6. _"MSSQL"_
|
||||
7. _"Hive"_
|
||||
8. _"Oracle"_
|
||||
9. _"Athena"_
|
||||
10. _"Presto"_
|
||||
11. _"Trino"_
|
||||
12. _"Vertica"_
|
||||
13. _"Glue"_
|
||||
14. _"MariaDB"_
|
||||
15. _"Druid"_
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"BigQuery"_
|
||||
2. _"MySQL"_
|
||||
3. _"Redshift"_
|
||||
4. _"Snowflake"_
|
||||
5. _"Postgres"_
|
||||
6. _"MSSQL"_
|
||||
7. _"Hive"_
|
||||
8. _"Oracle"_
|
||||
9. _"Athena"_
|
||||
10. _"Presto"_
|
||||
11. _"Trino"_
|
||||
12. _"Vertica"_
|
||||
13. _"Glue"_
|
||||
14. _"MariaDB"_
|
||||
15. _"Druid"_
|
||||
16. _"Db2"_
|
||||
17. _"ClickHouse"_
|
||||
18. _"Databricks"_
|
||||
19. _"DynamoDB"_
|
||||
20. _"AzureSQL"_
|
||||
21. _"SingleStore"_
|
||||
22. _"SQLite"_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
### databaseConnection
|
||||
|
||||
- Database Connection.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **username**
|
||||
- username to connect to the data source.
|
||||
- Type: `string`
|
||||
- **password**
|
||||
- password to connect to the data source.
|
||||
- Type: `string`
|
||||
- **hostPort**
|
||||
- Host and port of the data source.
|
||||
- Type: `string`
|
||||
- **database**
|
||||
- Database of the data source.
|
||||
- Type: `string`
|
||||
- **connectionOptions**
|
||||
- Additional connection options that can be sent to service during the connection.
|
||||
- Type: `object`
|
||||
- **connectionArguments**
|
||||
- Additional connection arguments such as security or protocol configs that can be sent to service during connection.
|
||||
- Type: `object`
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -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: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Range: ≥ 1
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
99
docs/openmetadata-apis/schemas/entities/events/webhook.md
Normal file
99
docs/openmetadata-apis/schemas/entities/events/webhook.md
Normal file
@ -0,0 +1,99 @@
|
||||
# Webhook
|
||||
|
||||
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>
|
||||
|
||||
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
|
||||
- **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_
|
@ -27,4 +27,4 @@
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
69
docs/openmetadata-apis/schemas/entities/glossary.md
Normal file
69
docs/openmetadata-apis/schemas/entities/glossary.md
Normal file
@ -0,0 +1,69 @@
|
||||
# Glossary
|
||||
|
||||
This schema defines the Glossary entity. A Glossary is collection of hierarchical GlossaryTerms.
|
||||
|
||||
**$id:**[**https//:open-metadata.org/schema/entity/data/glossary.json**](https://open-metadata.org/schema/entity/data/glossary.json)
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **id** `required`
|
||||
- Unique identifier of a glossary instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- **name** `required`
|
||||
- Preferred name for the glossary term.
|
||||
- $ref: [#/definitions/name](#name)
|
||||
- Type: `string`
|
||||
- **displayName**
|
||||
- Display Name that identifies this glossary.
|
||||
- Type: `string`
|
||||
- **description**
|
||||
- Description of the glossary.
|
||||
- Type: `string`
|
||||
- **version**
|
||||
- Metadata version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
|
||||
- **updatedAt**
|
||||
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **href**
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
- **reviewers**
|
||||
- User references of the reviewers for this glossary.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **owner**
|
||||
- Owner of this glossary.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **tags**
|
||||
- Tags for this glossary.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
|
||||
- **changeDescription**
|
||||
- Change that lead to this version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
|
||||
- **deleted**
|
||||
- When `true` indicates the entity has been soft deleted.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
### name
|
||||
|
||||
- Name that identifies a glossary term.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
116
docs/openmetadata-apis/schemas/entities/glossaryterm.md
Normal file
116
docs/openmetadata-apis/schemas/entities/glossaryterm.md
Normal file
@ -0,0 +1,116 @@
|
||||
# GlossaryTerm
|
||||
|
||||
This schema defines te Glossary term entities.
|
||||
|
||||
**$id:**[**https//:open-metadata.org/schema/entity/data/glossaryTerm.json**](https://open-metadata.org/schema/entity/data/glossaryTerm.json)
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **id** `required`
|
||||
- Unique identifier of a glossary term instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- **name** `required`
|
||||
- Preferred name for the glossary term.
|
||||
- $ref: [#/definitions/name](#name)
|
||||
- **displayName**
|
||||
- Display Name that identifies this glossary.
|
||||
- Type: `string`
|
||||
- **description**
|
||||
- Description of the glossary term.
|
||||
- Type: `string`
|
||||
- **fullyQualifiedName**
|
||||
- A unique name that identifies a glossary term. It captures name hierarchy of glossary of terms in the form of `glossaryName.parentTerm.childTerm`.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 256
|
||||
- **synonyms**
|
||||
- Alternate names that are synonyms or near-synonyms for the glossary term.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/name](#name)
|
||||
- **glossary** `required`
|
||||
- Glossary that this term belongs to.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **parent**
|
||||
- Parent glossary term that this term is child of. When `null` this term is the root term of the glossary.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **children**
|
||||
- Other glossary terms that are children of this glossary term.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
- **relatedTerms**
|
||||
- Other glossary terms that are related to this glossary term.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
- **references**
|
||||
- Link to a reference from an external glossary.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../entity/data/glossaryTerm.json#/definitions/termReference](glossaryterm.md#termreference)
|
||||
- **version**
|
||||
- Metadata version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
|
||||
- **updatedAt**
|
||||
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **href**
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
- **reviewers**
|
||||
- User names of the reviewers for this glossary.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
- **tags**
|
||||
- Tags for this glossary term.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
|
||||
- **changeDescription**
|
||||
- Change that lead to this version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
|
||||
- **status**
|
||||
- Status of the glossary term.
|
||||
- $ref: [#/definitions/status](#status)
|
||||
- **deleted**
|
||||
- When `true` indicates the entity has been soft deleted.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
### name
|
||||
|
||||
- Name that identifies a glossary term.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
### termReference
|
||||
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **name**
|
||||
- Name that identifies the source of an external glossary term. Example `HealthCare.gov`.
|
||||
- Type: `string`
|
||||
- **endpoint**
|
||||
- Name that identifies the source of an external glossary term. Example `HealthCare.gov`.
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
### status
|
||||
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"Draft"_
|
||||
2. _"Approved"_
|
||||
3. _"Deprecated"_
|
||||
- Default: _"Draft"_
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -85,4 +85,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -15,6 +15,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **name** `required`
|
||||
- Name that identifies this messaging service.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
- **serviceType** `required`
|
||||
- Type of messaging service such as Kafka or Pulsar...
|
||||
@ -44,6 +45,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **ingestionSchedule**
|
||||
- Schedule for running metadata ingestion jobs.
|
||||
- $ref: [../../type/schedule.json](../types/schedule.md)
|
||||
- **owner**
|
||||
- Owner of this messaging service.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **href**
|
||||
- Link to the resource corresponding to this messaging service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
@ -76,4 +80,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -60,4 +60,5 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -231,4 +231,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -20,16 +20,17 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **destination**
|
||||
- Location where this entity needs to be moved to.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **storageServiceType**
|
||||
- The storage service to move this entity to.
|
||||
- $ref: [storageService.json](storageservice.md)
|
||||
- $ref: [../services/storageService.json](storageservice.md)
|
||||
- **storageClassType**
|
||||
- The storage class to move this entity to.
|
||||
- $ref: [../type/storage.json#/definitions/storageClassType](../types/storage.md#storageclasstype)
|
||||
- $ref: [../../type/storage.json#/definitions/storageClassType](../types/storage.md#storageclasstype)
|
||||
- **location**
|
||||
- The location where to move this entity to.
|
||||
- $ref: [location.json](location.md)
|
||||
- $ref: [../data/location.json](location.md)
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -52,6 +52,11 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/task](#task)
|
||||
- **pipelineStatus**
|
||||
- Series of pipeline executions and its status.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/pipelineStatus](#pipelinestatus)
|
||||
- **followers**
|
||||
- Followers of this Pipeline.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
@ -82,9 +87,34 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
### statusType
|
||||
|
||||
- Enum defining the possible Status.
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"Successful"_
|
||||
2. _"Failed"_
|
||||
3. _"Pending"_
|
||||
|
||||
|
||||
### taskStatus
|
||||
|
||||
- This schema defines a time series of the status of a Pipeline or Task.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **name**
|
||||
- Name of the Task.
|
||||
- Type: `string`
|
||||
- **executionStatus**
|
||||
- Status at a specific execution date.
|
||||
- $ref: [#/definitions/statusType](#statustype)
|
||||
|
||||
|
||||
### task
|
||||
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **name** `required`
|
||||
- Name that identifies this task instance uniquely.
|
||||
@ -119,4 +149,26 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
|
||||
### pipelineStatus
|
||||
|
||||
- Series of pipeline executions, its status and task status.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **executionDate**
|
||||
- Date where the job was executed.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **executionStatus**
|
||||
- Status at a specific execution date.
|
||||
- $ref: [#/definitions/statusType](#statustype)
|
||||
- **taskStatus**
|
||||
- Series of task executions and its status.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/taskStatus](#taskstatus)
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -15,6 +15,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **name** `required`
|
||||
- Name that identifies this pipeline service.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
- **serviceType**
|
||||
- Type of pipeline service such as Airflow or Prefect...
|
||||
@ -41,6 +42,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **ingestionSchedule**
|
||||
- Schedule for running metadata ingestion jobs.
|
||||
- $ref: [../../type/schedule.json](../types/schedule.md)
|
||||
- **owner**
|
||||
- Owner of this pipeline service.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **href**
|
||||
- Link to the resource corresponding to this pipeline service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
@ -62,8 +66,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
1. _"Airflow"_
|
||||
2. _"Prefect"_
|
||||
3. _"Glue"_
|
||||
4. _"Generic"_
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -88,4 +88,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -44,16 +44,23 @@ 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.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
- **teams**
|
||||
- Teams that have this role assigned.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
### roleName
|
||||
|
||||
- A unique name of the role.
|
||||
- A unique name for the role.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -29,4 +29,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _true_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -15,6 +15,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **name** `required`
|
||||
- Name that identifies this storage service.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
- **displayName**
|
||||
- Display Name that identifies this storage service.
|
||||
@ -37,6 +38,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **href** `required`
|
||||
- Link to the resource corresponding to this storage service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
|
||||
- **owner**
|
||||
- Owner of this storage service.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **changeDescription**
|
||||
- Change that lead to this version of the entity.
|
||||
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
|
||||
@ -46,4 +50,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -47,6 +47,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Table constraints.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
#### TableConstraint
|
||||
- $ref: [#/definitions/tableConstraint](#tableconstraint)
|
||||
- **owner**
|
||||
- Owner of this table.
|
||||
@ -59,7 +60,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **serviceType**
|
||||
- Service type this table is hosted in.
|
||||
- $ref: [../services/databaseService.json#/definitions/databaseServiceType](../services/databaseservice.md#databaseservicetype)
|
||||
- $ref: [../services/databaseService.json#/definitions/databaseServiceType](databaseservice.md#databaseservicetype)
|
||||
- **location**
|
||||
- Reference to the Location that contains this table.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
@ -93,6 +94,11 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/sqlQuery](#sqlquery)
|
||||
- **tableTests**
|
||||
- List of test cases that ran against a table.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../tests/tableTest.json](../tests/tabletest.md)
|
||||
- **dataModel**
|
||||
- This captures information about how the table is modeled. Currently only DBT model is supported.
|
||||
- $ref: [#/definitions/dataModel](#datamodel)
|
||||
@ -158,6 +164,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
33. _"GEOGRAPHY"_
|
||||
34. _"ENUM"_
|
||||
35. _"JSON"_
|
||||
36. _"UUID"_
|
||||
|
||||
|
||||
### constraint
|
||||
@ -173,8 +180,10 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
### tableConstraint
|
||||
|
||||
## TableConstraint
|
||||
- This enum defines the type for table constraint.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **constraintType**
|
||||
- Type: `string`
|
||||
@ -193,15 +202,13 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Local name (not fully qualified name) of the column. ColumnName is `-` when the column is not named in struct dataType. For example, BigQuery supports struct with unnamed fields.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
### tableName
|
||||
|
||||
- Local name (not fully qualified name) of a table.
|
||||
- Local name (not fully qualified name) of a table. Dots will be escaped automatically.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
@ -220,6 +227,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **name** `required`
|
||||
- $ref: [#/definitions/columnName](#columnname)
|
||||
- **displayName**
|
||||
- Display Name that identifies this column name.
|
||||
- Type: `string`
|
||||
- **dataType** `required`
|
||||
- Data type of the column (int, date etc.).
|
||||
- $ref: [#/definitions/dataType](#datatype)
|
||||
@ -256,6 +266,11 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/column](#column)
|
||||
- **columnTests**
|
||||
- List of column test cases that ran against a table column.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../tests/columnTest.json](../tests/columntest.md)
|
||||
|
||||
|
||||
### columnJoins
|
||||
@ -271,6 +286,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **fullyQualifiedName**
|
||||
- $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname)
|
||||
@ -359,9 +375,15 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `number`
|
||||
- **min**
|
||||
- Minimum value in a column.
|
||||
- Type: `number`
|
||||
- Types: `number`, `integer`, `string`
|
||||
- **max**
|
||||
- Maximum value in a column.
|
||||
- Types: `number`, `integer`, `string`
|
||||
- **minLength**
|
||||
- Minimum string length in a column.
|
||||
- Type: `number`
|
||||
- **maxLength**
|
||||
- Maximum string length in a column.
|
||||
- Type: `number`
|
||||
- **mean**
|
||||
- Avg value in a column.
|
||||
@ -405,6 +427,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- This schema defines the type to capture the table's sql queries.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **query**
|
||||
- SQL Query text that matches the table name.
|
||||
@ -437,6 +460,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- This captures information about how the table is modeled. Currently only DBT model is supported.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **modelType** `required`
|
||||
- $ref: [#/definitions/modelType](#modeltype)
|
||||
@ -468,4 +492,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -21,4 +21,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Item Count: ≥ 1
|
||||
- **Items**
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -71,4 +71,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -47,6 +47,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- When `true` indicates the entity has been soft deleted.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
- **defaultRoles**
|
||||
- Roles to be assigned to all users that are part of this team.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
|
||||
|
||||
|
||||
## Type definitions in this schema
|
||||
@ -59,4 +62,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -19,11 +19,34 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Timestamp of the when the first post created the thread in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **about** `required`
|
||||
- Data asset about which this thread is created for with format <#E/{entities}/{entityType}/{field}/{fieldValue}.
|
||||
- Data asset about which this thread is created for with format <#E/{entities}/{entityName}/{field}/{fieldValue}.
|
||||
- $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
|
||||
- **entityId**
|
||||
- Entity Id of the entity that the thread belongs to.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- **addressedTo**
|
||||
- User or team this thread is addressed to in format <#E/{entities}/{entityType}/{field}/{fieldValue}.
|
||||
- User or team this thread is addressed to in format <#E/{entities}/{entityName}/{field}/{fieldValue}.
|
||||
- $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
|
||||
- **createdBy**
|
||||
- User who created the thread.
|
||||
- Type: `string`
|
||||
- **updatedAt**
|
||||
- Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **updatedBy**
|
||||
- User who made the update.
|
||||
- Type: `string`
|
||||
- **resolved**
|
||||
- When `true` indicates the thread has been resolved.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
- **message**
|
||||
- The main message of the thread in markdown format.
|
||||
- Type: `string`
|
||||
- **postsCount**
|
||||
- The total count of posts in the thread.
|
||||
- Type: `integer`
|
||||
- Default: `0`
|
||||
- **posts** `required`
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
@ -35,6 +58,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Post within a feed.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **message** `required`
|
||||
- Message in markdown format. See markdown support for more details.
|
||||
@ -43,10 +67,10 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Timestamp of the post in Unix epoch time milliseconds.
|
||||
- $ref: [../../type/basic.json#/definitions/timestamp](../types/basic.md#timestamp)
|
||||
- **from** `required`
|
||||
- ID of User (regular user or a bot) posting the message.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
|
||||
- Name of the User posting the message.
|
||||
- Type: `string`
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -38,17 +38,17 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
- **serviceType**
|
||||
- Service type where this topic is hosted in.
|
||||
- $ref: [../services/messagingService.json#/definitions/messagingServiceType](../services/messagingservice.md#messagingservicetype)
|
||||
- **partitions** `required`
|
||||
- Number of partitions into which the topic is divided.
|
||||
- Type: `integer`
|
||||
- Range: ≥ 1
|
||||
- $ref: [../services/messagingService.json#/definitions/messagingServiceType](messagingservice.md#messagingservicetype)
|
||||
- **schemaText**
|
||||
- Schema used for message serialization. Optional as some topics may not have associated schemas.
|
||||
- Type: `string`
|
||||
- **schemaType**
|
||||
- Schema used for message serialization.
|
||||
- $ref: [#/definitions/schemaType](#schematype)
|
||||
- **partitions** `required`
|
||||
- Number of partitions into which the topic is divided.
|
||||
- Type: `integer`
|
||||
- Range: ≥ 1
|
||||
- **cleanupPolicies**
|
||||
- Topic clean up policies. For Kafka - `cleanup.policy` configuration.
|
||||
- Type: `array`
|
||||
@ -70,6 +70,9 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Maximum size of a partition in bytes before old data is discarded. For Kafka - `retention.bytes` configuration.
|
||||
- Type: `integer`
|
||||
- Default: _"-1"_
|
||||
- **topicConfig**
|
||||
- Contains key/value pair of topic configuration.
|
||||
- $ref: [#/definitions/topicConfig](#topicconfig)
|
||||
- **owner**
|
||||
- Owner of this topic.
|
||||
- $ref: [../../type/entityReference.json](../types/entityreference.md)
|
||||
@ -98,7 +101,6 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Name that identifies a topic.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^[^.]*$`
|
||||
- Length: between 1 and 128
|
||||
|
||||
|
||||
@ -120,6 +122,12 @@ This schema <u>does not</u> accept additional properties.
|
||||
2. _"compact"_
|
||||
|
||||
|
||||
### topicConfig
|
||||
|
||||
- Contains key/value pair of topic configuration.
|
||||
- Type: `object`
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -79,4 +79,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -93,4 +93,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 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: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -38,6 +38,7 @@ This schema defines basic common types that are used by other schemas.
|
||||
|
||||
- Time interval in unixTimeMillis.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **start**
|
||||
- Start time in unixTimeMillis.
|
||||
@ -69,7 +70,7 @@ This schema defines basic common types that are used by other schemas.
|
||||
|
||||
### entityLink
|
||||
|
||||
- Link to an entity or field within an entity using this format `<#E/{entities}/{entityType}/{field}/{fieldValue}`.
|
||||
- Link to an entity or field within an entity using this format `<#E/{entities}/{entityType}/{field}/{arrayFieldName}/{arrayFieldValue}`.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^<#E/\S+/\S+>$`
|
||||
|
||||
@ -82,4 +83,4 @@ This schema defines basic common types that are used by other schemas.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -68,4 +68,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 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: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -56,4 +56,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `string`
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -74,4 +74,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -31,6 +31,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Edge in the lineage graph from one entity to another by entity IDs.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **fromEntity**
|
||||
- From entity that is upstream of lineage edge.
|
||||
@ -46,6 +47,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Edge in the lineage graph from one entity to another using entity references.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **fromEntity**
|
||||
- From entity that is upstream of lineage edge.
|
||||
@ -59,4 +61,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -39,4 +39,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -27,13 +27,44 @@ This schema <u>does not</u> accept additional properties.
|
||||
- **toEntity** `required`
|
||||
- Type of the entity towards which the relationship refers to. Examples: `database`, `table`, `metrics` ...
|
||||
- Type: `string`
|
||||
- **relation** `required`
|
||||
- Describes relationship between the two entities.
|
||||
- Type: `string`
|
||||
- **relation**
|
||||
- Describes relationship between the two entities as an integer.
|
||||
- Type: `integer`
|
||||
- Range: ≥ 0
|
||||
- **relationshipType** `required`
|
||||
- Describes relationship between the two entities. Eg: Database --- Contains --> Table.
|
||||
- $ref: [#/definitions/relationshipType](#relationshiptype)
|
||||
- **deleted**
|
||||
- `true` indicates the relationship has been soft deleted.
|
||||
- Type: `boolean`
|
||||
- Default: _false_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
## Type definitions in this schema
|
||||
### relationshipType
|
||||
|
||||
- This enum captures all the relationships between Catalog entities. Note that the relationship from is a Strong entity and to is Weak entity when possible.
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"contains"_
|
||||
2. _"createdBy"_
|
||||
3. _"repliedTo"_
|
||||
4. _"isAbout"_
|
||||
5. _"addressedTo"_
|
||||
6. _"mentionedIn"_
|
||||
7. _"testedBy"_
|
||||
8. _"uses"_
|
||||
9. _"owns"_
|
||||
10. _"parentOf"_
|
||||
11. _"has"_
|
||||
12. _"follows"_
|
||||
13. _"joinedWith"_
|
||||
14. _"upstream"_
|
||||
15. _"appliedTo"_
|
||||
16. _"relatedTo"_
|
||||
17. _"reviews"_
|
||||
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -19,4 +19,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [usageDetails.json](usagedetails.md)
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -13,4 +13,4 @@ The value is restricted to the following:
|
||||
3. _"non-deleted"_
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -40,6 +40,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
- Type for capturing JDBC connector information.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **driverClass** `required`
|
||||
- $ref: [#/definitions/driverClass](#driverclass)
|
||||
@ -49,4 +50,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -20,4 +20,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -6,6 +6,8 @@ This schema defines the type for a profile of a user, team, or organization.
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **images**
|
||||
- $ref: [#/definitions/imageList](#imagelist)
|
||||
@ -16,6 +18,7 @@ Type: `object`
|
||||
|
||||
- Links to a list of images of varying resolutions/sizes.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **Properties**
|
||||
- **image**
|
||||
- Type: `string`
|
||||
@ -42,4 +45,4 @@ Type: `object`
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -6,6 +6,8 @@ This schema defines the type used for the schedule. The schedule has a start tim
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- **startDate**
|
||||
- Start date and time of the schedule.
|
||||
@ -15,4 +17,4 @@ Type: `object`
|
||||
- $ref: [basic.json#/definitions/duration](basic.md#duration)
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -62,4 +62,4 @@ Definitions related to Storage Service.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -44,4 +44,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
@ -42,4 +42,4 @@ This schema <u>does not</u> accept additional properties.
|
||||
|
||||
|
||||
|
||||
_This document was updated on: Tuesday, January 25, 2022_
|
||||
_This document was updated on: Monday, March 7, 2022_
|
Loading…
x
Reference in New Issue
Block a user