yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-04 07:33:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated schema documentaiton (#1188)

Browse Source 
* updated schema documentaiton

* id correction
This commit is contained in:
parthp2107 2021-11-15 21:35:54 +05:30 committed by GitHub
parent 7f2d1e5fc4
commit d52297e28f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
38 changed files with 1975 additions and 1305 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/SUMMARY.md
View File

@ -39,7 +39,9 @@
* [OpenMetadata Types](openmetadata-apis/schemas/types/README.md)
* [Audit Log](openmetadata-apis/schemas/types/auditlog.md)
* [Basic Types](openmetadata-apis/schemas/types/basic.md)
* [Change Event](openmetadata-apis/schemas/types/changeevent.md)
* [Daily Count](openmetadata-apis/schemas/types/dailycount.md)
* [Entity History](openmetadata-apis/schemas/types/entityhistory.md)
* [Entity Lineage](openmetadata-apis/schemas/types/entitylineage.md)
* [Entity Reference](openmetadata-apis/schemas/types/entityreference.md)
* [Entity Usage](openmetadata-apis/schemas/types/entityusage.md)
@ -56,16 +58,18 @@
* [Dashboard Service](openmetadata-apis/schemas/entities/dashboardservice.md)
* [Database](openmetadata-apis/schemas/entities/database.md)
* [Database Service](openmetadata-apis/schemas/entities/databaseservice.md)
* [Location](openmetadata-apis/schemas/entities/location.md)
* [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md)
* [Feed](openmetadata-apis/schemas/entities/thread.md)
* [Metrics](openmetadata-apis/schemas/entities/metrics.md)
* [Model](openmetadata-apis/schemas/entities/model.md)
* [ML Model](openmetadata-apis/schemas/entities/mlmodel.md)
* [Pipeline](openmetadata-apis/schemas/entities/pipeline.md)
* [Pipeline Service](openmetadata-apis/schemas/entities/pipelineservice.md)
* [Policy](openmetadata-apis/schemas/entities/policy.md)
* [Report](openmetadata-apis/schemas/entities/report.md)
* [Storage Service](openmetadata-apis/schemas/entities/storageservice.md)
* [Table](openmetadata-apis/schemas/entities/table.md)
* [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md)
* [Task](openmetadata-apis/schemas/entities/task.md)
* [Team](openmetadata-apis/schemas/entities/team.md)
* [Topic](openmetadata-apis/schemas/entities/topic.md)
* [User](openmetadata-apis/schemas/entities/user.md)

20
docs/openmetadata-apis/schemas/entities/README.md
View File

@ -36,6 +36,10 @@ OpenMetadata has the following high-level core entities and relationships:
[databaseservice.md](databaseservice.md)
{% endcontent-ref %}
{% content-ref url="location.md" %}
[location.md](location.md)
{% endcontent-ref %}
{% content-ref url="messagingservice.md" %}
[messagingservice.md](messagingservice.md)
{% endcontent-ref %}
@ -44,8 +48,8 @@ OpenMetadata has the following high-level core entities and relationships:
[metrics.md](metrics.md)
{% endcontent-ref %}
{% content-ref url="model.md" %}
[model.md](model.md)
{% content-ref url="mlmodel.md" %}
[mlmodel.md](mlmodel.md)
{% endcontent-ref %}
{% content-ref url="pipeline.md" %}
@ -56,10 +60,18 @@ OpenMetadata has the following high-level core entities and relationships:
[pipelineservice.md](pipelineservice.md)
{% endcontent-ref %}
{% content-ref url="policy.md" %}
[policy.md](policy.md)
{% endcontent-ref %}
{% content-ref url="report.md" %}
[report.md](report.md)
{% endcontent-ref %}
{% content-ref url="storageservice.md" %}
[storageservice.md](storageservice.md)
{% endcontent-ref %}
{% content-ref url="table.md" %}
[table.md](table.md)
{% endcontent-ref %}
@ -68,10 +80,6 @@ OpenMetadata has the following high-level core entities and relationships:
[tagcategory.md](tagcategory.md)
{% endcontent-ref %}
{% content-ref url="task.md" %}
[task.md](task.md)
{% endcontent-ref %}
{% content-ref url="team.md" %}
[team.md](team.md)
{% endcontent-ref %}

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

@ -7,31 +7,34 @@ This schema defines Bot entity. A bot automates tasks, such as adding descriptio
Type: `object`
## Properties
- **id**
- Unique identifier of a bot instance.
- $ref: [../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name**
- Name of the bot.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Name used for display purposes. Example 'FirstName LastName'.
- Type: `string`
- **description**
- Description of the bot.
- 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**
- Link to the resource corresponding to this bot.
- $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)
* **id**
* Unique identifier of a bot instance.
* $ref: [../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name**
* Name of the bot.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Name used for display purposes. Example 'FirstName LastName'.
* Type: `string`
* **description**
* Description of the bot.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../type/basic.json#/definitions/entityVersion](../types/basic.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**
* Link to the resource corresponding to this bot.
* $ref: [../type/basic.json#/definitions/href](../types/basic.md#href)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,76 +1,78 @@
# Chart
This schema defines the Chart entity. Charts are built using tables or SQL queries by analyzing the data. Charts can be part of Dashboard.
This schema defines the Chart entity. Charts are built using tables or sql queries by analyzing the data. Charts can be part of Dashboard.
**$id: **[**https://open-metadata.org/schema/entity/data/chart.json**](https://open-metadata.org/schema/entity/data/chart.json)
**$id:**[**https://open-metadata.org/schema/entity/data/chart.json**](https://open-metadata.org/schema/entity/data/chart.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies a chart instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this Chart.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this Chart. It could be title or label from the source services.
- Type: `string`
- **fullyQualifiedName**
- A unique name that identifies a dashboard in the format 'ServiceName.ChartName'.
- Type: `string`
- Length: between 1 and 64
- **description**
- Description of the dashboard, what it is, and how to use it.
- 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`
- **chartType**
- $ref: [#/definitions/chartType](#charttype)
- **chartUrl**
- Chart URL, pointing to its own Service URL.
- Type: `string`
- String format must be a "uri"
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this dashboard.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **tables**
- Link to table used in this chart.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **followers**
- Followers of this chart.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this chart.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **service** `required`
- Link to service where this dashboard is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.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 that identifies a chart instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this Chart.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this Chart. It could be title or label from the source services.
* Type: `string`
* **fullyQualifiedName**
* A unique name that identifies a dashboard in the format 'ServiceName.ChartName'.
* Type: `string`
* Length: between 1 and 64
* **description**
* Description of the dashboard, what it is, and how to use it.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **chartType**
* $ref: [#/definitions/chartType](chart.md#charttype)
* **chartUrl**
* Chart URL, pointing to its own Service URL.
* Type: `string`
* String format must be a "uri"
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this dashboard.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **tables**
* Link to table used in this chart.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **followers**
* Followers of this chart.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **tags**
* Tags for this chart.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **service** `required`
* Link to service where this dashboard is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
## Type definitions in this schema
### chartType
* This schema defines the type used for describing different types of charts.
* Type: `string`
* The value is restricted to the following:
- This schema defines the type used for describing different types of charts.
- Type: `string`
- The value is restricted to the following:
1. _"Line"_
2. _"Table"_
3. _"Bar"_
@ -82,4 +84,5 @@ Type: `object`
9. _"BoxPlot"_
10. _"Other"_
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,66 +2,69 @@
This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are updated in real-time and allow interactive data exploration.
**$id: **[**https://open-metadata.org/schema/entity/data/dashboard.json**](https://open-metadata.org/schema/entity/data/dashboard.json)
**$id:**[**https://open-metadata.org/schema/entity/data/dashboard.json**](https://open-metadata.org/schema/entity/data/dashboard.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies a dashboard instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this dashboard.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this Dashboard. It could be title or label from the source services.
- Type: `string`
- **fullyQualifiedName**
- A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
- Type: `string`
- Length: between 1 and 64
- **description**
- Description of the dashboard, what it is, and how to use it.
- 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`
- **dashboardUrl**
- Dashboard URL.
- Type: `string`
- String format must be a "uri"
- **charts**
- All the charts included in this Dashboard.
- Type: `array`
- **Items**
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this dashboard.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **followers**
- Followers of this dashboard.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this dashboard.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **service** `required`
- Link to service where this dashboard is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.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 that identifies a dashboard instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this dashboard.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this Dashboard. It could be title or label from the source services.
* Type: `string`
* **fullyQualifiedName**
* A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
* Type: `string`
* Length: between 1 and 64
* **description**
* Description of the dashboard, what it is, and how to use it.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **dashboardUrl**
* Dashboard URL.
* Type: `string`
* String format must be a "uri"
* **charts**
* All the charts included in this Dashboard.
* Type: `array`
* **Items**
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this dashboard.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **followers**
* Followers of this dashboard.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **tags**
* Tags for this dashboard.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **service** `required`
* Link to service where this dashboard is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,65 +1,69 @@
# Dashboard Service
This schema defines the Messaging Service entity, such as Kafka and Pulsar.
This schema defines the Dashboard Service entity, such as Looker and Superset.
**$id: **[**https://open-metadata.org/schema/entity/services/dashboardService.json**](https://open-metadata.org/schema/entity/services/dashboardService.json)
**$id:**[**https://open-metadata.org/schema/entity/services/dashboardService.json**](https://open-metadata.org/schema/entity/services/dashboardService.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier of this dashboard service instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this dashboard service.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this dashboard service.
- Type: `string`
- **serviceType** `required`
- Type of dashboard service such as Looker or Superset...
- $ref: [#/definitions/dashboardServiceType](#dashboardservicetype)
- **description**
- Description of a dashboard 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`
- **dashboardUrl** `required`
- Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
- Type: `string`
- String format must be a "uri"
- **username**
- Username to log-into Dashboard Service.
- Type: `string`
- **password**
- Password to log-into Dashboard Service.
- Type: `string`
- **ingestionSchedule**
- Schedule for running metadata ingestion jobs.
- $ref: [../../type/schedule.json](../types/schedule.md)
- **href**
- Link to the resource corresponding to this dashboard 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)
* **id** `required`
* Unique identifier of this dashboard service instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this dashboard service.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this dashboard service.
* Type: `string`
* **serviceType** `required`
* Type of dashboard service such as Looker or Superset...
* $ref: [#/definitions/dashboardServiceType](dashboardservice.md#dashboardservicetype)
* **description**
* Description of a dashboard service instance.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **dashboardUrl** `required`
* Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
* Type: `string`
* String format must be a "uri"
* **username**
* Username to log-into Dashboard Service.
* Type: `string`
* **password**
* Password to log-into Dashboard Service.
* Type: `string`
* **ingestionSchedule**
* Schedule for running metadata ingestion jobs.
* $ref: [../../type/schedule.json](../types/schedule.md)
* **href**
* Link to the resource corresponding to this dashboard service.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
## Type definitions in this schema
### dashboardServiceType
* Type of Dashboard service - Superset, Looker, Redash or Tableau.
* Type: `string`
* The value is restricted to the following:
- Type of Dashboard service - Superset, Looker, Redash or Tableau.
- Type: `string`
- The value is restricted to the following:
1. _"Superset"_
2. _"Looker"_
3. _"Tableau"_
4. _"Redash"_
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,59 +2,66 @@
This schema defines the Database entity. A database also referred to as Database Catalog is a collection of tables.
**$id: **[**https://open-metadata.org/schema/entity/data/database.json**](https://open-metadata.org/schema/entity/data/database.json)
**$id:**[**https://open-metadata.org/schema/entity/data/database.json**](https://open-metadata.org/schema/entity/data/database.json)
Type: `object`
## Properties
- **id**
- Unique identifier that identifies this database instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies the database.
- $ref: [#/definitions/databaseName](#databasename)
- **fullyQualifiedName**
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
- Type: `string`
- **displayName**
- Display Name that identifies this database.
- Type: `string`
- **description**
- Description of the database 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**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this database.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **service** `required`
- Link to the database cluster/service where this database is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **location**
- Reference to the Location that contains this database.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
- **tables**
- References to tables in the database.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
* **id**
* Unique identifier that identifies this database instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies the database.
* $ref: [#/definitions/databaseName](database.md#databasename)
* **fullyQualifiedName**
* Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
* Type: `string`
* **displayName**
* Display Name that identifies this database.
* Type: `string`
* **description**
* Description of the database instance.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this database.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **service** `required`
* Link to the database cluster/service where this database is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
* **tables**
* References to tables in the database.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
## Type definitions in this schema
### databaseName
* Name that identifies the database.
* Type: `string`
* The value must match this pattern: `^[^.]*$`
* Length: between 1 and 64
- Name that identifies the database.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,54 +2,57 @@
This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.
**$id: **[**https://open-metadata.org/schema/entity/services/databaseService.json**](https://open-metadata.org/schema/entity/services/databaseService.json)
**$id:**[**https://open-metadata.org/schema/entity/services/databaseService.json**](https://open-metadata.org/schema/entity/services/databaseService.json)
Type: `object`
## 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 64
- **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`
* Length: between 1 and 64
* **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](databaseservice.md#databaseservicetype)
* **description**
* Description of a database service instance.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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)
## 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:
- 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"_
@ -62,5 +65,7 @@ Type: `object`
10. _"Presto"_
11. _"Trino"_
12. _"Vertica"_
13. _"Glue"_
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

71
docs/openmetadata-apis/schemas/entities/location.md Normal file
View File

@ -0,0 +1,71 @@
# Table
This schema defines the Location entity. A Location can contain the data of a table or group other sublocation together.
**$id:**[**https://open-metadata.org/schema/entity/data/location.json**](https://open-metadata.org/schema/entity/data/location.json)
Type: `object`
## Properties
- **id**
- Unique identifier of this location instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name of a location without the service. For example s3://bucket/path1/path2.
- Type: `string`
- **displayName**
- Display Name that identifies this table. It could be title or label from the source services.
- Type: `string`
- **fullyQualifiedName**
- Fully qualified name of a location in the form `serviceName.locationName`.
- Type: `string`
- **description**
- Description of a location.
- 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**
- Link to this location resource.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **locationType**
- $ref: [#/definitions/locationType](#locationtype)
- **owner**
- Owner of this location.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **followers**
- Followers of this location.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this location.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **service** `required`
- Link to the database cluster/service where this database is hosted in.
- $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)
## Type definitions in this schema
### locationType
- This schema defines the type used for describing different types of Location.
- Type: `string`
- The value is restricted to the following:
1. _"Bucket"_
2. _"Prefix"_
3. _"Database"_
4. _"Table"_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,66 +2,70 @@
This schema defines the Messaging Service entity, such as Kafka and Pulsar.
**$id: **[**https://open-metadata.org/schema/entity/services/messagingService.json**](https://open-metadata.org/schema/entity/services/messagingService.json)
**$id:**[**https://open-metadata.org/schema/entity/services/messagingService.json**](https://open-metadata.org/schema/entity/services/messagingService.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier of this messaging service instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this messaging service.
- Type: `string`
- Length: between 1 and 64
- **serviceType** `required`
- Type of messaging service such as Kafka or Pulsar...
- $ref: [#/definitions/messagingServiceType](#messagingservicetype)
- **description**
- Description of a messaging service instance.
- Type: `string`
- **displayName**
- Display Name that identifies this messaging service. It could be title or label from the source services.
- 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`
- **brokers** `required`
- Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
- $ref: [#/definitions/brokers](#brokers)
- **schemaRegistry**
- Schema registry URL.
- Type: `string`
- String format must be a "uri"
- **ingestionSchedule**
- Schedule for running metadata ingestion jobs.
- $ref: [../../type/schedule.json](../types/schedule.md)
- **href**
- Link to the resource corresponding to this messaging 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)
* **id** `required`
* Unique identifier of this messaging service instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this messaging service.
* Type: `string`
* Length: between 1 and 64
* **serviceType** `required`
* Type of messaging service such as Kafka or Pulsar...
* $ref: [#/definitions/messagingServiceType](messagingservice.md#messagingservicetype)
* **description**
* Description of a messaging service instance.
* Type: `string`
* **displayName**
* Display Name that identifies this messaging service. It could be title or label from the source services.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **brokers** `required`
* Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
* $ref: [#/definitions/brokers](messagingservice.md#brokers)
* **schemaRegistry**
* Schema registry URL.
* Type: `string`
* String format must be a "uri"
* **ingestionSchedule**
* Schedule for running metadata ingestion jobs.
* $ref: [../../type/schedule.json](../types/schedule.md)
* **href**
* Link to the resource corresponding to this messaging service.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
## Type definitions in this schema
### messagingServiceType
* Type of messaging service - Kafka or Pulsar.
* Type: `string`
* The value is restricted to the following:
- Type of messaging service - Kafka or Pulsar.
- Type: `string`
- The value is restricted to the following:
1. _"Kafka"_
2. _"Pulsar"_
### brokers
* Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
* Type: `array`
* **Items**
* Type: `string`
- Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
- Type: `array`
- **Items**
- Type: `string`
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,49 +2,57 @@
This schema defines the Metrics entity. Metrics are measurements computed from data such as `Monthly Active Users`. Some of the metrics that measures used to determine performance against an objective are called KPIs or Key Performance Indicators, such as `User Retention`.
**$id: **[**https://open-metadata.org/schema/entity/data/metrics.json**](https://open-metadata.org/schema/entity/data/metrics.json)
**$id:**[**https://open-metadata.org/schema/entity/data/metrics.json**](https://open-metadata.org/schema/entity/data/metrics.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies this metrics instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this metrics instance uniquely.
- Type: `string`
- Length: between 1 and 64
- **fullyQualifiedName**
- A unique name that identifies a metric in the format 'ServiceName.MetricName'.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this metric.
- Type: `string`
- **description**
- Description of metrics instance, what it is, and how to use it.
- 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**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this metrics.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **tags**
- Tags for this chart.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **service** `required`
- Link to service where this metrics is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.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 that identifies this metrics instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this metrics instance uniquely.
* Type: `string`
* Length: between 1 and 64
* **fullyQualifiedName**
* A unique name that identifies a metric in the format 'ServiceName.MetricName'.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this metric.
* Type: `string`
* **description**
* Description of metrics instance, what it is, and how to use it.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this metrics.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **service** `required`
* Link to service where this metrics is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

199
docs/openmetadata-apis/schemas/entities/mlmodel.md Normal file
View File

@ -0,0 +1,199 @@
# MLModel
This schema defines the Model entity. Models are algorithms trained on data to find patterns or make predictions.
**$id:**[**https://open-metadata.org/schema/entity/data/mlmodel.json**](https://open-metadata.org/schema/entity/data/mlmodel.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier of a MLModel instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this MLModel.
- Type: `string`
- Length: between 1 and 64
- **fullyQualifiedName**
- A unique name that identifies a MLModel.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this MLModel.
- Type: `string`
- **description**
- Description of the MLModel, what it is, and how to use it.
- Type: `string`
- **algorithm** `required`
- Algorithm used to train the MLModel.
- Type: `string`
- **mlFeatures**
- Features used to train the ML Model.
- Type: `array`
- **Items**
- $ref: [#/definitions/mlFeature](#mlfeature)
- **mlHyperParameters**
- Hyper Parameters used to train the ML Model.
- Type: `array`
- **Items**
- $ref: [#/definitions/mlHyperParameter](#mlhyperparameter)
- **dashboard**
- Performance Dashboard URL to track metric evolution.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this MLModel.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **followers**
- Followers of this MLModel.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this MLModel.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **usageSummary**
- Latest usage information for this MLModel.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
- **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`
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
## Type definitions in this schema
### featureType
- This enum defines the type of data stored in a ML Feature.
- Type: `string`
- The value is restricted to the following:
1. _"numerical"_
2. _"categorical"_
### featureSourceDataType
- This enum defines the type of data of a ML Feature source.
- Type: `string`
- The value is restricted to the following:
1. _"integer"_
2. _"number"_
3. _"string"_
4. _"array"_
5. _"date"_
6. _"timestamp"_
7. _"object"_
8. _"boolean"_
### featureName
- Local name (not fully qualified name) of the ML Feature.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64
### featureSourceName
- Local name (not fully qualified name) of a ML Feature source.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64
### fullyQualifiedFeatureSourceName
- Fully qualified name of the ML Feature Source that includes `serviceName.[databaseName].tableName/fileName/apiName.columnName[.nestedColumnName]`.
- Type: `string`
- Length: between 1 and 256
### fullyQualifiedFeatureName
- Fully qualified name of the ML Feature that includes `modelName.featureName`.
- Type: `string`
- Length: between 1 and 256
### featureSource
- This schema defines the sources of a ML Feature.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name**
- $ref: [#/definitions/featureSourceName](#featuresourcename)
- **dataType**
- Data type of the source (int, date etc.).
- $ref: [#/definitions/featureSourceDataType](#featuresourcedatatype)
- **description**
- Description of the feature source.
- Type: `string`
- **fullyQualifiedName**
- $ref: [#/definitions/fullyQualifiedFeatureSourceName](#fullyqualifiedfeaturesourcename)
- **tags**
- Tags associated with the feature source.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
### mlFeature
- This schema defines the type for a ML Feature used in a MLModel.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name**
- $ref: [#/definitions/featureName](#featurename)
- **dataType**
- Data type of the column (numerical vs. categorical).
- $ref: [#/definitions/featureType](#featuretype)
- **description**
- Description of the ML Feature.
- Type: `string`
- **fullyQualifiedName**
- $ref: [#/definitions/fullyQualifiedFeatureName](#fullyqualifiedfeaturename)
- **featureSources**
- Columns used to create the ML Feature.
- Type: `array`
- **Items**
- $ref: [#/definitions/featureSource](#featuresource)
- **featureAlgorithm**
- Description of the algorithm used to compute the feature, e.g., PCA, bucketing...
- Type: `string`
- **tags**
- Tags associated with the feature.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
### mlHyperParameter
- This schema defines the type for a ML HyperParameter used in a MLModel.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name**
- Hyper parameter name.
- Type: `string`
- **value**
- Hyper parameter value.
- Type: `string`
- **description**
- Description of the Hyper Parameter.
- Type: `string`
_This document was updated on: Monday, November 15, 2021_

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

@ -2,72 +2,116 @@
This schema defines the Pipeline entity. A pipeline enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Load the data.
**$id: **[**https://open-metadata.org/schema/entity/data/pipeline.json**](https://open-metadata.org/schema/entity/data/pipeline.json)
**$id:**[**https://open-metadata.org/schema/entity/data/pipeline.json**](https://open-metadata.org/schema/entity/data/pipeline.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies a pipeline instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this pipeline instance uniquely.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this Pipeline. It could be title or label from the source services.
- Type: `string`
- **fullyQualifiedName**
- A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
- Type: `string`
- Length: between 1 and 64
- **description**
- Description of this Pipeline.
- 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`
- **pipelineUrl**
- Pipeline URL to visit/manage. This URL points to respective pipeline service UI.
- Type: `string`
- String format must be a "uri"
- **concurrency**
- Concurrency of the Pipeline.
- Type: `integer`
- **pipelineLocation**
- Pipeline Code Location.
- Type: `string`
- **startDate**
- Start date of the workflow.
- $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
- **tasks**
- All the tasks that are part of pipeline.
- Type: `array`
- **Items**
- $ref: [#/definitions/task](#task)
- **followers**
- Followers of this Pipeline.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this Pipeline.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this pipeline.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **service** `required`
- Link to service where this pipeline is hosted in.
- $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)
* **id** `required`
* Unique identifier that identifies a pipeline instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this pipeline instance uniquely.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this Pipeline. It could be title or label from the source services.
* Type: `string`
* **fullyQualifiedName**
* A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
* Type: `string`
* Length: between 1 and 64
* **description**
* Description of this Pipeline.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **pipelineUrl**
* Pipeline URL to visit/manage. This URL points to respective pipeline service UI.
* Type: `string`
* String format must be a "uri"
* **concurrency**
* Concurrency of the Pipeline.
* Type: `integer`
* **pipelineLocation**
* Pipeline Code Location.
* Type: `string`
* **startDate**
* Start date of the workflow.
* $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
* **tasks**
* All the tasks that are part of pipeline.
* Type: `array`
* **Items**
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **followers**
* Followers of this Pipeline.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **tags**
* Tags for this Pipeline.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this pipeline.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **service** `required`
* Link to service where this pipeline is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
## Type definitions in this schema
_This document was updated on: Monday, October 18, 2021_
### task
- Type: `object`
- **Properties**
- **name** `required`
- Name that identifies this task instance uniquely.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this Task. It could be title or label from the pipeline services.
- Type: `string`
- **fullyQualifiedName**
- A unique name that identifies a pipeline in the format 'ServiceName.PipelineName.TaskName'.
- Type: `string`
- Length: between 1 and 64
- **description**
- Description of this Task.
- Type: `string`
- **taskUrl**
- Task URL to visit/manage. This URL points to respective pipeline service UI.
- Type: `string`
- String format must be a "uri"
- **downstreamTasks**
- All the tasks that are downstream of this task.
- Type: `array`
- **Items**
- Type: `string`
- Length: between 1 and 64
- **taskType**
- Type of the Task. Usually refers to the class it implements.
- Type: `string`
- **taskSQL**
- SQL used in the task. Can be used to determine the lineage.
- $ref: [../../type/basic.json#/definitions/sqlQuery](../types/basic.md#sqlquery)
- **tags**
- Tags for this task.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
_This document was updated on: Monday, November 15, 2021_

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

@ -2,56 +2,61 @@
This schema defines the Pipeline Service entity, such as Airflow and Prefect.
**$id: https://open-metadata.org/schema/entity/services/messagingservice.json**
**$id: [https://open-metadata.org/schema/entity/services/messagingservice.json](https://open-metadata.org/schema/entity/services/messagingservice.json)**
Type: `object`
## Properties
- **id** `required`
- Unique identifier of this pipeline service instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this pipeline service.
- Type: `string`
- Length: between 1 and 64
- **serviceType**
- Type of pipeline service such as Airflow or Prefect...
- $ref: [#/definitions/pipelineServiceType](#pipelineservicetype)
- **description**
- Description of a pipeline service instance.
- Type: `string`
- **displayName**
- Display Name that identifies this pipeline service. It could be title or label from the source services.
- 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`
- **pipelineUrl** `required`
- Pipeline Service Management/UI URL.
- Type: `string`
- String format must be a "uri"
- **ingestionSchedule**
- Schedule for running metadata ingestion jobs.
- $ref: [../../type/schedule.json](../types/schedule.md)
- **href**
- Link to the resource corresponding to this pipeline 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)
* **id** `required`
* Unique identifier of this pipeline service instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this pipeline service.
* Type: `string`
* Length: between 1 and 64
* **serviceType**
* Type of pipeline service such as Airflow or Prefect...
* $ref: [#/definitions/pipelineServiceType](pipelineservice.md#pipelineservicetype)
* **description**
* Description of a pipeline service instance.
* Type: `string`
* **displayName**
* Display Name that identifies this pipeline service. It could be title or label from the source services.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **pipelineUrl** `required`
* Pipeline Service Management/UI URL.
* Type: `string`
* String format must be a "uri"
* **ingestionSchedule**
* Schedule for running metadata ingestion jobs.
* $ref: [../../type/schedule.json](../types/schedule.md)
* **href**
* Link to the resource corresponding to this pipeline service.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
## Type definitions in this schema
### pipelineServiceType
* Type of pipeline service - Airflow or Prefect.
* Type: `string`
* The value is restricted to the following:
- Type of pipeline service - Airflow or Prefect.
- Type: `string`
- The value is restricted to the following:
1. _"Airflow"_
2. _"Prefect"_
3. _"Glue"_
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

67
docs/openmetadata-apis/schemas/entities/policy.md Normal file
View File

@ -0,0 +1,67 @@
# Policy
This schema defines the Policy entity. A Policy defines lifecycle or access control that needs to be applied across different Data Entities.
**$id: [https://open-metadata.org/schema/entity/policies/policy.json](https://open-metadata.org/schema/entity/policies/policy.json)**
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies this Policy.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this Policy.
- Type: `string`
- Length: between 1 and 64
- **fullyQualifiedName**
- Name that uniquely identifies a Policy.
- Type: `string`
- Length: between 1 and 128
- **displayName**
- Title for this Policy.
- Type: `string`
- **description**
- A short description of the Policy, comprehensible to regular users.
- Type: `string`
- **owner** `required`
- Owner of this Policy.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **policyUrl**
- Link to a well documented definition of this Policy.
- Type: `string`
- String format must be a "uri"
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **policyType** `required`
- $ref: [#/definitions/policyType](#policytype)
- **enabled**
- Is the policy enabled.
- Type: `boolean`
- Default: _true_
- **version**
- Metadata version of the Policy.
- $ref: [../../type/entityHistory.json#/definitions/entityVersion](../types/entityhistory.md#entityversion)
- **updatedAt**
- Last update time corresponding to the new version of the Policy.
- $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
- **updatedBy**
- User who made the update.
- Type: `string`
- **changeDescription**
- Change that led to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
## Type definitions in this schema
### policyType
- This schema defines the type used for describing different types of policies.
- Type: `string`
- The value is restricted to the following:
1. _"AccessControl"_
2. _"Lifecycle"_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,49 +2,52 @@
This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and visual form.
**$id: **[**https://open-metadata.org/schema/entity/data/report.json**](https://open-metadata.org/schema/entity/data/report.json)
**$id:**[**https://open-metadata.org/schema/entity/data/report.json**](https://open-metadata.org/schema/entity/data/report.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier that identifies this report.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this report instance uniquely.
- Type: `string`
- Length: between 1 and 64
- **fullyQualifiedName**
- A unique name that identifies a report in the format 'ServiceName.ReportName'.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this report. It could be title or label from the source services.
- Type: `string`
- **description**
- Description of this report 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**
- Link to the resource corresponding to this report.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **owner**
- Owner of this pipeline.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **service** `required`
- Link to service where this report is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **usageSummary**
- Latest usage information for this database.
- $ref: [../../type/usageDetails.json](../types/usagedetails.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 that identifies this report.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies this report instance uniquely.
* Type: `string`
* Length: between 1 and 64
* **fullyQualifiedName**
* A unique name that identifies a report in the format 'ServiceName.ReportName'.
* Type: `string`
* Length: between 1 and 64
* **displayName**
* Display Name that identifies this report. It could be title or label from the source services.
* Type: `string`
* **description**
* Description of this report instance.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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**
* Link to the resource corresponding to this report.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **owner**
* Owner of this pipeline.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **service** `required`
* Link to service where this report is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **usageSummary**
* Latest usage information for this database.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

54
docs/openmetadata-apis/schemas/entities/storageservice.md Normal file
View File

@ -0,0 +1,54 @@
# Storage Service
This schema defines the Storage Service entity, such as S3, GCS, HDFS.
**$id:**[**https://open-metadata.org/schema/entity/services/storageService.json**](https://open-metadata.org/schema/entity/services/storageService.json)
Type: `object`
## Properties
- **id** `required`
- Unique identifier of this storage service instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies this storage service.
- Type: `string`
- Length: between 1 and 64
- **displayName**
- Display Name that identifies this storage service.
- Type: `string`
- **serviceType** `required`
- Type of storage service such as S3, GCS, HDFS...
- $ref: [#/definitions/storageServiceType](#storageservicetype)
- **description**
- Description of a storage 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 storage 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)
## Type definitions in this schema
### storageServiceType
- Type of storage service such as S3, GCS, HDFS...
- Type: `string`
- The value is restricted to the following:
1. _"S3"_
2. _"GCS"_
3. _"HDFS"_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,90 +2,103 @@
This schema defines the Table entity. A Table organizes data in rows and columns and is defined by a Schema. OpenMetadata does not have a separate abstraction for Schema. Both Table and Schema are captured in this entity.
**$id: **[**https://open-metadata.org/schema/entity/data/table.json**](https://open-metadata.org/schema/entity/data/table.json)
**$id:**[**https://open-metadata.org/schema/entity/data/table.json**](https://open-metadata.org/schema/entity/data/table.json)
Type: `object`
## Properties
This schema <u>does not</u> accept additional properties.
## Properties
- **id** `required`
- Unique identifier of this table instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name of a table. Expected to be unique within a database.
- $ref: [#/definitions/tableName](#tablename)
- **displayName**
- Display Name that identifies this table. It could be title or label from the source services.
- Type: `string`
- **fullyQualifiedName**
- Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
- Type: `string`
- **description**
- Description of a table.
- 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**
- Link to this table resource.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **tableType**
- $ref: [#/definitions/tableType](#tabletype)
- **columns** `required`
- Columns in this table.
- Type: `array`
- **Items**
- $ref: [#/definitions/column](#column)
- **tableConstraints**
- Table constraints.
- Type: `array`
- **Items**
- $ref: [#/definitions/tableConstraint](#tableconstraint)
- **owner**
- Owner of this table.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **database**
- Reference to Database that contains this table.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **location**
- Reference to the Location that contains this table.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **viewDefinition**
- View Definition in SQL. Applies to TableType.View only.
- $ref: [../../type/basic.json#/definitions/sqlQuery](../types/basic.md#sqlquery)
- **tags**
- Tags for this table.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **usageSummary**
- Latest usage information for this table.
- $ref: [../../type/usageDetails.json](../types/usagedetails.md)
- **followers**
- Followers of this table.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **joins**
- Details of other tables this table is frequently joined with.
- $ref: [#/definitions/tableJoins](#tablejoins)
- **sampleData**
- Sample data for a table.
- $ref: [#/definitions/tableData](#tabledata)
- **tableProfile**
- Data profile for a table.
- Type: `array`
- **Items**
- $ref: [#/definitions/tableProfile](#tableprofile)
- **tableQueries**
- List of queries that ran against a table.
- Type: `array`
- **Items**
- $ref: [#/definitions/sqlQuery](#sqlquery)
- **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 table instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name of a table. Expected to be unique within a database.
* $ref: [#/definitions/tableName](table.md#tablename)
* **displayName**
* Display Name that identifies this table. It could be title or label from the source services.
* Type: `string`
* **fullyQualifiedName**
* Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
* Type: `string`
* **description**
* Description of a table.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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**
* Link to this table resource.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **tableType**
* $ref: [#/definitions/tableType](table.md#tabletype)
* **columns** `required`
* Columns in this table.
* Type: `array`
* **Items**
* $ref: [#/definitions/column](table.md#column)
* **tableConstraints**
* Table constraints.
* Type: `array`
* **Items**
* $ref: [#/definitions/tableConstraint](table.md#tableconstraint)
* **owner**
* Owner of this table.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **database**
* Reference to Database that contains this table.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **viewDefinition**
* View Definition in SQL. Applies to TableType.View only.
* $ref: [../../type/basic.json#/definitions/sqlQuery](../types/basic.md#sqlquery)
* **tags**
* Tags for this table.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **usageSummary**
* Latest usage information for this table.
* $ref: [../../type/usageDetails.json](../types/usagedetails.md)
* **followers**
* Followers of this table.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **joins**
* Details of other tables this table is frequently joined with.
* $ref: [#/definitions/tableJoins](table.md#tablejoins)
* **sampleData**
* Sample data for a table.
* $ref: [#/definitions/tableData](table.md#tabledata)
* **tableProfile**
* Data profile for a table.
* Type: `array`
* **Items**
* $ref: [#/definitions/tableProfile](table.md#tableprofile)
## Type definitions in this schema
### tableType
* This schema defines the type used for describing different types of tables.
* Type: `string`
* The value is restricted to the following:
- This schema defines the type used for describing different types of tables.
- Type: `string`
- The value is restricted to the following:
1. _"Regular"_
2. _"External"_
3. _"View"_
@ -94,9 +107,9 @@ Type: `object`
### dataType
* This enum defines the type of data stored in a column.
* Type: `string`
* The value is restricted to the following:
- This enum defines the type of data stored in a column.
- Type: `string`
- The value is restricted to the following:
1. _"NUMBER"_
2. _"TINYINT"_
3. _"SMALLINT"_
@ -134,205 +147,231 @@ Type: `object`
### constraint
* This enum defines the type for column constraint.
* Type: `string`
* The value is restricted to the following:
- This enum defines the type for column constraint.
- Type: `string`
- The value is restricted to the following:
1. _"NULL"_
2. _"NOT\_NULL"_
2. _"NOT_NULL"_
3. _"UNIQUE"_
4. _"PRIMARY\_KEY"_
4. _"PRIMARY_KEY"_
### tableConstraint
* This enum defines the type for table constraint.
* Type: `object`
* **Properties**
* **constraintType**
* Type: `string`
* The value is restricted to the following:
- This enum defines the type for table constraint.
- Type: `object`
- **Properties**
- **constraintType**
- Type: `string`
- The value is restricted to the following:
1. _"UNIQUE"_
2. _"PRIMARY\_KEY"_
3. _"FOREIGN\_KEY"_
* **columns**
* List of column names corresponding to the constraint.
* Type: `array`
* **Items**
* Type: `string`
2. _"PRIMARY_KEY"_
3. _"FOREIGN_KEY"_
- **columns**
- List of column names corresponding to the constraint.
- Type: `array`
- **Items**
- Type: `string`
### columnName
* 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 64
- 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 64
### tableName
* Local name (not fully qualified name) of a table.
* Type: `string`
* The value must match this pattern: `^[^.]*$`
* Length: between 1 and 64
- Local name (not fully qualified name) of a table.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64
### fullyQualifiedColumnName
* Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName[.nestedColumnName]`. When columnName is null for dataType struct fields, `field_#` where `#` is field index is used. For map dataType, for key the field name `key` is used and for the value field `value` is used.
* Type: `string`
* Length: between 1 and 256
- Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName[.nestedColumnName]`. When columnName is null for dataType struct fields, `field_#` where `#` is field index is used. For map dataType, for key the field name `key` is used and for the value field `value` is used.
- Type: `string`
- Length: between 1 and 256
### column
* This schema defines the type for a column in a table.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **name** `required`
* $ref: [#/definitions/columnName](table.md#columnname)
* **dataType** `required`
* Data type of the column (int, date etc.).
* $ref: [#/definitions/dataType](table.md#datatype)
* **arrayDataType**
* Data type used array in dataType. For example, `array<int>` has dataType as `array` and arrayDataType as `int`.
* $ref: [#/definitions/dataType](table.md#datatype)
* **dataLength**
* Length of `char`, `varchar`, `binary`, `varbinary` `dataTypes`, else null. For example, `varchar(20)` has dataType as `varchar` and dataLength as `20`.
* Type: `integer`
* **dataTypeDisplay**
* Display name used for dataType. This is useful for complex types, such as \`array, map\<int,string>, struct<>, and union types.
* Type: `string`
* **description**
* Description of the column.
* Type: `string`
* **fullyQualifiedName**
* $ref: [#/definitions/fullyQualifiedColumnName](table.md#fullyqualifiedcolumnname)
* **tags**
* Tags associated with the column.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **constraint**
* Column level constraint.
* $ref: [#/definitions/constraint](table.md#constraint)
* **ordinalPosition**
* Ordinal position of the column.
* Type: `integer`
* **jsonSchema**
* Json schema only if the dataType is JSON else null.
* Type: `string`
* **children**
* Child columns if dataType or arrayDataType is `map`, `struct`, or `union` else `null`.
* Type: `array`
* **Items**
* $ref: [#/definitions/column](table.md#column)
- This schema defines the type for a column in a table.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name** `required`
- $ref: [#/definitions/columnName](#columnname)
- **dataType** `required`
- Data type of the column (int, date etc.).
- $ref: [#/definitions/dataType](#datatype)
- **arrayDataType**
- Data type used array in dataType. For example, `array<int>` has dataType as `array` and arrayDataType as `int`.
- $ref: [#/definitions/dataType](#datatype)
- **dataLength**
- Length of `char`, `varchar`, `binary`, `varbinary` `dataTypes`, else null. For example, `varchar(20)` has dataType as `varchar` and dataLength as `20`.
- Type: `integer`
- **dataTypeDisplay**
- Display name used for dataType. This is useful for complex types, such as `array<int>, map<int,string>, struct<>, and union types.
- Type: `string`
- **description**
- Description of the column.
- Type: `string`
- **fullyQualifiedName**
- $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname)
- **tags**
- Tags associated with the column.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **constraint**
- Column level constraint.
- $ref: [#/definitions/constraint](#constraint)
- **ordinalPosition**
- Ordinal position of the column.
- Type: `integer`
- **jsonSchema**
- Json schema only if the dataType is JSON else null.
- Type: `string`
- **children**
- Child columns if dataType or arrayDataType is `map`, `struct`, or `union` else `null`.
- Type: `array`
- **Items**
- $ref: [#/definitions/column](#column)
### columnJoins
* This schema defines the type to capture how frequently a column is joined with columns in the other tables.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **columnName**
* $ref: [#/definitions/columnName](table.md#columnname)
* **joinedWith**
* Fully qualified names of the columns that this column is joined with.
* Type: `array`
* **Items**
* Type: `object`
* **Properties**
* **fullyQualifiedName**
* $ref: [#/definitions/fullyQualifiedColumnName](table.md#fullyqualifiedcolumnname)
* **joinCount**
* Type: `integer`
- This schema defines the type to capture how frequently a column is joined with columns in the other tables.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **columnName**
- $ref: [#/definitions/columnName](#columnname)
- **joinedWith**
- Fully qualified names of the columns that this column is joined with.
- Type: `array`
- **Items**
- Type: `object`
- **Properties**
- **fullyQualifiedName**
- $ref: [#/definitions/fullyQualifiedColumnName](#fullyqualifiedcolumnname)
- **joinCount**
- Type: `integer`
### tableJoins
* This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **startDate**
* Date can be only from today going back to last 29 days.
* $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
* **dayCount**
* Type: `integer`
* Default: `1`
* **columnJoins**
* Type: `array`
* **Items**
* $ref: [#/definitions/columnJoins](table.md#columnjoins)
- This schema defines the type to capture information about how columns in this table are joined with columns in the other tables.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **startDate**
- Date can be only from today going back to last 29 days.
- $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
- **dayCount**
- Type: `integer`
- Default: `1`
- **columnJoins**
- Type: `array`
- **Items**
- $ref: [#/definitions/columnJoins](#columnjoins)
### tableData
* This schema defines the type to capture rows of sample data for a table.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **columns**
* List of local column names (not fully qualified column names) of the table.
* Type: `array`
* **Items**
* $ref: [#/definitions/columnName](table.md#columnname)
* **rows**
* Data for multiple rows of the table.
* Type: `array`
* **Items**
* Data for a single row of the table within the same order as columns fields.
* Type: `array`
- This schema defines the type to capture rows of sample data for a table.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **columns**
- List of local column names (not fully qualified column names) of the table.
- Type: `array`
- **Items**
- $ref: [#/definitions/columnName](#columnname)
- **rows**
- Data for multiple rows of the table.
- Type: `array`
- **Items**
- Data for a single row of the table within the same order as columns fields.
- Type: `array`
### columnProfile
* This schema defines the type to capture the table's column profile.
* Type: `object`
* **Properties**
* **name**
* Column Name.
* Type: `string`
* **uniqueCount**
* No. of unique values in the column.
* Type: `number`
* **uniqueProportion**
* Proportion of number of unique values in a column.
* Type: `number`
* **nullCount**
* No.of null values in a column.
* Type: `number`
* **nullProportion**
* No.of null value proportion in columns.
* Type: `number`
* **min**
* Minimum value in a column.
* Type: `string`
* **max**
* Maximum value in a column.
* Type: `string`
* **mean**
* Avg value in a column.
* Type: `string`
* **median**
* Median value in a column.
* Type: `string`
* **stddev**
* Standard deviation of a column.
* Type: `number`
- This schema defines the type to capture the table's column profile.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name**
- Column Name.
- Type: `string`
- **uniqueCount**
- No. of unique values in the column.
- Type: `number`
- **uniqueProportion**
- Proportion of number of unique values in a column.
- Type: `number`
- **nullCount**
- No.of null values in a column.
- Type: `number`
- **nullProportion**
- No.of null value proportion in columns.
- Type: `number`
- **min**
- Minimum value in a column.
- Type: `string`
- **max**
- Maximum value in a column.
- Type: `string`
- **mean**
- Avg value in a column.
- Type: `string`
- **median**
- Median value in a column.
- Type: `string`
- **stddev**
- Standard deviation of a column.
- Type: `number`
### tableProfile
* This schema defines the type to capture the table's data profile.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **profileDate**
* Data one which profile is taken.
* $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
* **columnCount**
* No.of columns in the table.
* Type: `number`
* **rowCount**
* No.of rows in the table.
* Type: `number`
* **columnProfile**
* List of local column profiles of the table.
* Type: `array`
* **Items**
* $ref: [#/definitions/columnProfile](table.md#columnprofile)
- This schema defines the type to capture the table's data profile.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **profileDate**
- Data one which profile is taken.
- $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
- **columnCount**
- No.of columns in the table.
- Type: `number`
- **rowCount**
- No.of rows in the table.
- Type: `number`
- **columnProfile**
- List of local column profiles of the table.
- Type: `array`
- **Items**
- $ref: [#/definitions/columnProfile](#columnprofile)
_This document was updated on: Monday, October 18, 2021_
### sqlQuery
- This schema defines the type to capture the table's sql queries.
- Type: `object`
- **Properties**
- **query**
- SQL Query text that matches the table name.
- Type: `string`
- **duration**
- How long did the query took to run in seconds.
- Type: `number`
- **user**
- User who ran this query.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **vote**
- Users can vote up to rank the popular queries.
- Type: `number`
- Default: `1`
- **checksum**
- Checksum to avoid registering duplicate queries.
- Type: `string`
- **queryDate**
- Date on which the query ran.
- $ref: [../../type/basic.json#/definitions/date](../types/basic.md#date)
_This document was updated on: Monday, November 15, 2021_

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

@ -2,61 +2,63 @@
This schema defines the Tag Category entity. A Tag Category contains tags called Primary Tags. Primary Tags can further have children Tags called Secondary Tags. Only two levels of tags are supported currently.
**$id: **[**https://open-metadata.org/schema/entity/tags/tagCategory.json**](https://open-metadata.org/schema/entity/tags/tagCategory.json)
**$id:**[**https://open-metadata.org/schema/entity/tags/tagCategory.json**](https://open-metadata.org/schema/entity/tags/tagCategory.json)
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
* **name** `required`
* $ref: [#/definitions/tagName](tagcategory.md#tagname)
* **displayName**
* Display Name that identifies this tag category.
* Type: `string`
* **description** `required`
* Description of the tag category.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **categoryType** `required`
* $ref: [#/definitions/tagCategoryType](tagcategory.md#tagcategorytype)
* **href**
* Link to the resource corresponding to the tag category.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **usageCount**
* Count of how many times the tags from this tag category are used.
* Type: `integer`
* **children**
* Tags under this category.
* Type: `array`
* **Items**
* $ref: [#/definitions/tag](tagcategory.md#tag)
- **name** `required`
- $ref: [#/definitions/tagName](#tagname)
- **displayName**
- Display Name that identifies this tag category.
- Type: `string`
- **description** `required`
- Description of the tag category.
- 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`
- **categoryType** `required`
- $ref: [#/definitions/tagCategoryType](#tagcategorytype)
- **href**
- Link to the resource corresponding to the tag category.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **usageCount**
- Count of how many times the tags from this tag category are used.
- Type: `integer`
- **children**
- Tags under this category.
- Type: `array`
- **Items**
- $ref: [#/definitions/tag](#tag)
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
## Type definitions in this schema
### tagName
* Name of the tag.
* Type: `string`
* Length: between 2 and 25
- Name of the tag.
- Type: `string`
- Length: between 2 and 25
### tagCategoryType
* Type of tag category.
* Type: `string`
* The value is restricted to the following:
- Type of tag category.
- Type: `string`
- The value is restricted to the following:
1. _"Descriptive"_
2. _"Classification"_
### tag
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,53 +2,55 @@
This schema defines the Team entity. A Team is a group of zero or more users. Teams can own zero or more data assets.
**$id: **[**https://open-metadata.org/schema/entity/teams/team.json**](https://open-metadata.org/schema/entity/teams/team.json)
**$id:**[**https://open-metadata.org/schema/entity/teams/team.json**](https://open-metadata.org/schema/entity/teams/team.json)
Type: `object`
## Properties
* **id** `required`
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* $ref: [#/definitions/teamName](team.md#teamname)
* **displayName**
* Name used for display purposes. Example 'Data Science team'.
* Type: `string`
* **description**
* Description of the team.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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 entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **profile**
* Team profile information.
* $ref: [../../type/profile.json](../types/profile.md)
* **deleted**
* When true the team has been deleted.
* Type: `boolean`
* **users**
* Users that are part of the team.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **owns**
* List of entities owned by the team.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **id** `required`
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- $ref: [#/definitions/teamName](#teamname)
- **displayName**
- Name used for display purposes. Example 'Data Science team'.
- Type: `string`
- **description**
- Description of the team.
- 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 entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **profile**
- Team profile information.
- $ref: [../../type/profile.json](../types/profile.md)
- **deleted**
- When true the team has been deleted.
- Type: `boolean`
- **users**
- Users that are part of the team.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **owns**
- List of entities owned by the team.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
## Type definitions in this schema
### teamName
* A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.
* Type: `string`
* Length: between 1 and 64
- A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.
- Type: `string`
- Length: between 1 and 64
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,49 +1,48 @@
# Feed
# Thread
This schema defines the Thread entity. A Thread is a collection of posts made by the users. The first post that starts a thread is **about** a data asset **from** a user. Other users can respond to this post by creating new posts in the thread. Note that bot users can also interact with a thread. A post can contains links that mention Users or other Data Assets.
**$id: **[**https://open-metadata.org/schema/entity/feed/thread.json**](https://open-metadata.org/schema/entity/feed/thread.json)
**$id:**[**https://open-metadata.org/schema/entity/feed/thread.json**](https://open-metadata.org/schema/entity/feed/thread.json)
Type: `object`
## Properties
* **id** `required`
* Unique identifier that identifies an entity instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **threadTs**
* Timestamp of the when the first post created the thread.
* $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
* **about** `required`
* Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}.
* $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
* **addressedTo**
* User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}.
* $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
* **posts** `required`
* Type: `array`
* **Items**
* $ref: [#/definitions/post](thread.md#post)
- **id** `required`
- Unique identifier that identifies an entity instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **href**
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **threadTs**
- Timestamp of the when the first post created the thread.
- $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
- **about** `required`
- Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}.
- $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
- **addressedTo**
- User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}.
- $ref: [../../type/basic.json#/definitions/entityLink](../types/basic.md#entitylink)
- **posts** `required`
- Type: `array`
- **Items**
- $ref: [#/definitions/post](#post)
## Type definitions in this schema
### post
* Post within a feed.
* Type: `object`
* **Properties**
* **message** `required`
* Message in markdown format. See markdown support for more details.
* Type: `string`
* **postTs**
* Timestamp of the post.
* Type: `string`
* String format must be a "date-time"
* **from** `required`
* ID of User (regular user or a bot) posting the message.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- Post within a feed.
- Type: `object`
- **Properties**
- **message** `required`
- Message in markdown format. See markdown support for more details.
- Type: `string`
- **postTs**
- Timestamp of the post.
- Type: `string`
- String format must be a "date-time"
- **from** `required`
- ID of User (regular user or a bot) posting the message.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,99 +1,101 @@
# Topic
This schema defines the Topic entity. A topic is a feed into which messages are published by publishers and read from by consumers in a messaging service.
This schema defines the Topic entity. A topic is a feed into which message are published to by publishers and read from by consumers in a messaging service.
**$id: **[**https://open-metadata.org/schema/entity/data/topic.json**](https://open-metadata.org/schema/entity/data/topic.json)
**$id:**[**https://open-metadata.org/schema/entity/data/topic.json**](https://open-metadata.org/schema/entity/data/topic.json)
Type: `object`
## Properties
* **id** `required`
* Unique identifier that identifies this topic instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* Name that identifies the topic.
* $ref: [#/definitions/topicName](topic.md#topicname)
* **fullyQualifiedName**
* Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'.
* Type: `string`
* **displayName**
* Display Name that identifies this topic. It could be title or label from the source services.
* Type: `string`
* **description**
* Description of the topic instance.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **service** `required`
* Link to the messaging cluster/service where this topic is hosted in.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **partitions** `required`
* Number of partitions into which the topic is divided.
* Type: `integer`
* Range: ≥ 1
* **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](topic.md#schematype)
* **cleanupPolicies**
* Topic clean up policies. For Kafka - `cleanup.policy` configuration.
* Type: `array`
* **Items**
* $ref: [#/definitions/cleanupPolicy](topic.md#cleanuppolicy)
* **retentionTime**
* Retention time in milliseconds. For Kafka - `retention.ms` configuration.
* Type: `number`
* **replicationFactor**
* Replication Factor in integer (more than 1).
* Type: `integer`
* **maximumMessageSize**
* Maximum message size in bytes. For Kafka - `max.message.bytes` configuration.
* Type: `integer`
* **minimumInSyncReplicas**
* Minimum number replicas in sync to control durability. For Kafka - `min.insync.replicas` configuration.
* Type: `integer`
* **retentionSize**
* Maximum size of a partition in bytes before old data is discarded. For Kafka - `retention.bytes` configuration.
* Type: `number`
* Default: _"-1"_
* **owner**
* Owner of this topic.
* $ref: [../../type/entityReference.json](../types/entityreference.md)
* **followers**
* Followers of this table.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **tags**
* Tags for this table.
* Type: `array`
* **Items**
* $ref: [../../type/tagLabel.json](../types/taglabel.md)
* **href**
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **id** `required`
- Unique identifier that identifies this topic instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- Name that identifies the topic.
- $ref: [#/definitions/topicName](#topicname)
- **fullyQualifiedName**
- Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'.
- Type: `string`
- **displayName**
- Display Name that identifies this topic. It could be title or label from the source services.
- Type: `string`
- **description**
- Description of the topic 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`
- **service** `required`
- Link to the messaging cluster/service where this topic is hosted in.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **partitions** `required`
- Number of partitions into which the topic is divided.
- Type: `integer`
- Range: &ge; 1
- **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)
- **cleanupPolicies**
- Topic clean up policies. For Kafka - `cleanup.policy` configuration.
- Type: `array`
- **Items**
- $ref: [#/definitions/cleanupPolicy](#cleanuppolicy)
- **retentionTime**
- Retention time in milliseconds. For Kafka - `retention.ms` configuration.
- Type: `number`
- **replicationFactor**
- Replication Factor in integer (more than 1).
- Type: `integer`
- **maximumMessageSize**
- Maximum message size in bytes. For Kafka - `max.message.bytes` configuration.
- Type: `integer`
- **minimumInSyncReplicas**
- Minimum number replicas in sync to control durability. For Kafka - `min.insync.replicas` configuration.
- Type: `integer`
- **retentionSize**
- Maximum size of a partition in bytes before old data is discarded. For Kafka - `retention.bytes` configuration.
- Type: `number`
- Default: _"-1"_
- **owner**
- Owner of this topic.
- $ref: [../../type/entityReference.json](../types/entityreference.md)
- **followers**
- Followers of this table.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **tags**
- Tags for this table.
- Type: `array`
- **Items**
- $ref: [../../type/tagLabel.json](../types/taglabel.md)
- **href**
- Link to the resource corresponding to this entity.
- $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)
## Type definitions in this schema
### topicName
* Name that identifies a topic.
* Type: `string`
* The value must match this pattern: `^[^.]*$`
* Length: between 1 and 64
- Name that identifies a topic.
- Type: `string`
- The value must match this pattern: `^[^.]*$`
- Length: between 1 and 64
### schemaType
* Schema type used for the message.
* The value is restricted to the following:
- Schema type used for the message.
- The value is restricted to the following:
1. _"Avro"_
2. _"Protobuf"_
3. _"JSON"_
@ -101,9 +103,9 @@ Type: `object`
### cleanupPolicy
* Topic clean up policy. For Kafka - `cleanup.policy` configuration.
* The value is restricted to the following:
- Topic clean up policy. For Kafka - `cleanup.policy` configuration.
- The value is restricted to the following:
1. _"delete"_
2. _"compact"_
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,69 +2,75 @@
This schema defines the User entity. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner of zero or more data assets. A user can also follow zero or more data assets.
**$id: **[**https://open-metadata.org/schema/entity/teams/user.json**](https://open-metadata.org/schema/entity/teams/user.json)
**$id:**[**https://open-metadata.org/schema/entity/teams/user.json**](https://open-metadata.org/schema/entity/teams/user.json)
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
* **id** `required`
* Unique identifier that identifies a user entity instance.
* $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
* $ref: [#/definitions/userName](user.md#username)
* **displayName**
* Name used for display purposes. Example 'FirstName LastName'.
* Type: `string`
* **version**
* Metadata version of the entity.
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.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`
* **email** `required`
* Email address of the user.
* $ref: [../../type/basic.json#/definitions/email](../types/basic.md#email)
* **href** `required`
* Link to the resource corresponding to this entity.
* $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
* **timezone**
* Timezone of the user.
* Type: `string`
* String format must be a "timezone"
* **deactivated**
* When true indicates the user has been deactivated. Users are deactivated instead of deleted.
* Type: `boolean`
* **isBot**
* When true indicates a special type of user called Bot.
* Type: `boolean`
* **isAdmin**
* When true indicates user is an administrator for the system with superuser privileges.
* Type: `boolean`
* **profile**
* Profile of the user.
* $ref: [../../type/profile.json](../types/profile.md)
* **teams**
* Teams that the user belongs to.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **owns**
* List of entities owned by the user.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
* **follows**
* List of entities followed by the user.
* $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **id** `required`
- Unique identifier that identifies a user entity instance.
- $ref: [../../type/basic.json#/definitions/uuid](../types/basic.md#uuid)
- **name** `required`
- $ref: [#/definitions/userName](#username)
- **description**
- Used for user biography.
- Type: `string`
- **displayName**
- Name used for display purposes. Example 'FirstName LastName'.
- 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`
- **email** `required`
- Email address of the user.
- $ref: [../../type/basic.json#/definitions/email](../types/basic.md#email)
- **href** `required`
- Link to the resource corresponding to this entity.
- $ref: [../../type/basic.json#/definitions/href](../types/basic.md#href)
- **timezone**
- Timezone of the user.
- Type: `string`
- String format must be a "timezone"
- **deactivated**
- When true indicates the user has been deactivated. Users are deactivated instead of deleted.
- Type: `boolean`
- Default: _false_
- **isBot**
- When true indicates a special type of user called Bot.
- Type: `boolean`
- **isAdmin**
- When true indicates user is an administrator for the system with superuser privileges.
- Type: `boolean`
- **profile**
- Profile of the user.
- $ref: [../../type/profile.json](../types/profile.md)
- **teams**
- Teams that the user belongs to.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **owns**
- List of entities owned by the user.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **follows**
- List of entities followed by the user.
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](../types/entityreference.md#entityreferencelist)
- **changeDescription**
- Change that lead to this version of the entity.
- $ref: [../../type/entityHistory.json#/definitions/changeDescription](../types/entityhistory.md#changedescription)
## Type definitions in this schema
### userName
* A unique name of the user, typically the user ID from an identity provider. Example - uuid from LDAP.
* Type: `string`
* Length: between 1 and 64
- A unique name of the user, typically the user ID from an identity provider. Example - uid from LDAP.
- Type: `string`
- Length: between 1 and 64
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

8
docs/openmetadata-apis/schemas/types/README.md
View File

@ -10,10 +10,18 @@ OpenMetadata supports many common types reused across different schemas. Definin
[basic.md](basic.md)
{% endcontent-ref %}
{% content-ref url="changeevent.md" %}
[changeevent.md](changeevent.md)
{% endcontent-ref %}
{% content-ref url="dailycount.md" %}
[dailycount.md](dailycount.md)
{% endcontent-ref %}
{% content-ref url="entityhistory.md" %}
[entityhistory.md](entityhistory.md)
{% endcontent-ref %}
{% content-ref url="entitylineage.md" %}
[entitylineage.md](entitylineage.md)
{% endcontent-ref %}

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

@ -2,37 +2,36 @@
This schema defines the Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations.
**$id: **[**https://open-metadata.org/schema/type/auditLog.json**](https://open-metadata.org/schema/type/auditLog.json)
**$id:**[**https://open-metadata.org/schema/type/auditLog.json**](https://open-metadata.org/schema/type/auditLog.json)
Type: `object`
## Properties
* **method** `required`
* HTTP Method used in a call.
* Type: `string`
* The value is restricted to the following:
- **method** `required`
- HTTP Method used in a call.
- Type: `string`
- The value is restricted to the following:
1. _"POST"_
2. _"PUT"_
3. _"PATCH"_
4. _"DELETE"_
* **responseCode** `required`
* HTTP response code for the api requested.
* Type: `integer`
* **path** `required`
* Requested API Path.
* Type: `string`
* **userName** `required`
* Name of the user who made the API request.
* Type: `string`
* **dateTime**
* Date when the API call is made.
* $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
* **entityId** `required`
* Identifier of entity that was modified by the operation.
* $ref: [basic.json#/definitions/uuid](basic.md#uuid)
* **entityType** `required`
* Type of Entity that is modified by the operation.
* Type: `string`
- **responseCode** `required`
- HTTP response code for the api requested.
- Type: `integer`
- **path** `required`
- Requested API Path.
- Type: `string`
- **userName** `required`
- Name of the user who made the API request.
- Type: `string`
- **entityId** `required`
- Identifier of entity that was modified by the operation.
- $ref: [basic.json#/definitions/uuid](basic.md#uuid)
- **entityType** `required`
- Type of Entity that is modified by the operation.
- Type: `string`
- **dateTime**
- Date when the API call is made.
- $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -8,82 +8,68 @@ This schema defines basic common types that are used by other schemas.
### uuid
* Unique id used to identify an entity.
* Type: `string`
* String format must be a "uuid"
- Unique id used to identify an entity.
- Type: `string`
- String format must be a "uuid"
### email
* Email address of a user or other entities.
* Type: `string`
* String format must be an "email"
* The value must match this pattern: `^\S+@\S+\.\S+$`
* Length: between 6 and 127
### entityLink
* Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
* Type: `string`
* The value must match this pattern: `^<#E/\S+/\S+>$`
- Email address of a user or other entities.
- Type: `string`
- String format must be a "email"
- The value must match this pattern: `^\S+@\S+\.\S+$`
- Length: between 6 and 127
### timestamp
* Timestamp in unixTimeMillis.
* Type: `string`
* String format must be a "utc-millisec"
- Timestamp in unixTimeMillis.
- Type: `string`
- String format must be a "utc-millisec"
### href
* URI that points to a resource.
* Type: `string`
* String format must be a "uri"
- URI that points to a resource.
- Type: `string`
- String format must be a "uri"
### timeInterval
* Time interval in unixTimeMillis.
* Type: `object`
* **Properties**
* **start**
* Start time in unixTimeMillis.
* Type: `integer`
* **end**
* End time in unixTimeMillis.
* Type: `integer`
- Time interval in unixTimeMillis.
- Type: `object`
- **Properties**
- **start**
- Start time in unixTimeMillis.
- Type: `integer`
- **end**
- End time in unixTimeMillis.
- Type: `integer`
### duration
* Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.
* Type: `string`
- Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.
- Type: `string`
### date
* Date in ISO 8601 format in UTC. Example - '2018-11-13'.
* Type: `string`
* String format must be a "date"
- Date in ISO 8601 format in UTC. Example - '2018-11-13'.
- Type: `string`
- String format must be a "date"
### dateTime
* Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
* Type: `string`
* String format must be a "date-time"
### entityVersion
* Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.
* Type: `number`
* Default: `0.1`
* Range: ≥ 0.1
* The value must be a multiple of `0.1`
- Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
- Type: `string`
- String format must be a "date-time"
### entityLink
* Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
* Type: `string`
* The value must match this pattern: `^<#E/\S+/\S+>$`
- Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
- Type: `string`
- The value must match this pattern: `^<#E/\S+/\S+>$`
### sqlQuery
* SQL query statement. Example - 'select \* from orders'.
* Type: `string`
- SQL query statement. Example - 'select * from orders'.
- Type: `string`
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

64
docs/openmetadata-apis/schemas/types/changeevent.md Normal file
View File

@ -0,0 +1,64 @@
# ChangeEvent
This schema defines the change event type to capture the changes to entities. Entities change due to user activity, such as updating description of a dataset, changing ownership, or adding new tags. Entity also changes due to activities at the metadata sources, such as a new dataset was created, a datasets was deleted, or schema of a dataset is modified. When state of entity changes, an event is produced. These events can be used to build apps and bots that respond to the change from activities.
**$id: [https://open-metadata.org/schema/type/auditLog.json](https://open-metadata.org/schema/type/auditLog.json)**
Type: `object`
This schema <u>does not</u> accept additional properties.
## Properties
- **eventType** `required`
- $ref: [#/definitions/eventType](#eventtype)
- **entityType** `required`
- Entity type that changed. Use the schema of this entity to process the entity attribute.
- Type: `string`
- **entityId** `required`
- Identifier of entity that was modified by the operation.
- $ref: [basic.json#/definitions/uuid](basic.md#uuid)
- **previousVersion**
- Version of the entity before this change. Note that not all changes result in entity version change. When entity version is not changed, `previousVersion` is same as `currentVersion`.
- $ref: [entityHistory.json#/definitions/entityVersion](entityhistory.md#entityversion)
- **currentVersion**
- Current version of the entity after this change. Note that not all changes result in entity version change. When entity version is not changed, `previousVersion` is same as `currentVersion`.
- $ref: [entityHistory.json#/definitions/entityVersion](entityhistory.md#entityversion)
- **userName**
- Name of the user whose activity resulted in the change.
- Type: `string`
- **dateTime** `required`
- Date and time when the change was made.
- $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
- **changeDescription**
- For `eventType` `entityUpdated` this field captures details about what fields were added/updated/deleted. For `eventType` `entityCreated` or `entityDeleted` this field is null.
- $ref: [entityHistory.json#/definitions/changeDescription](entityhistory.md#changedescription)
- **entity**
- For `eventType` `entityCreated`, this field captures JSON coded string of the entity using the schema corresponding to `entityType`.
## Type definitions in this schema
### eventType
- Type of event.
- Type: `string`
- The value is restricted to the following:
1. _"entityCreated"_
2. _"entityUpdated"_
3. _"entityDeleted"_
### eventFilter
- Type: `object`
- **Properties**
- **eventType** `required`
- Event type that is being requested.
- $ref: [#/definitions/eventType](#eventtype)
- **entities**
- Entities for which the events are needed. Example - `table`, `topic`, etc. **When not set, events for all the entities will be provided**.
- Type: `array`
- **Items**
- Type: `string`
_This document was updated on: Monday, November 15, 2021_

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

@ -1,20 +1,19 @@
# Daily Count
# Daily count of some measurement
This schema defines the type for reporting the daily count of some measurement. For example, you might use this schema for the number of times a table is queried each day.
**$id: **[**https://open-metadata.org/schema/type/dailyCount.json**](https://open-metadata.org/schema/type/dailyCount.json)
**$id:**[**https://open-metadata.org/schema/type/dailyCount.json**](https://open-metadata.org/schema/type/dailyCount.json)
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
- **count** `required`
- Daily count of a measurement on the given date.
- Type: `integer`
- Range: &ge; 0
- **date** `required`
- $ref: [basic.json#/definitions/date](basic.md#date)
* **count** `required`
* Daily count of a measurement on the given date.
* Type: `integer`
* Range: ≥ 0
* **date** `required`
* $ref: [basic.json#/definitions/date](basic.md#date)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

75
docs/openmetadata-apis/schemas/types/entityhistory.md Normal file
View File

@ -0,0 +1,75 @@
# Entity Version History
This schema defines the type used for capturing version of history of entity.
**$id:**[**https://open-metadata.org/schema/type/entityHistory.json**](https://open-metadata.org/schema/type/entityHistory.json)
Type: `object`
This schema <u>does not</u> accept additional properties.
## Properties
- **entityType** `required`
- Entity type, such as `database`, `table`, `dashboard`, for which this version history is produced.
- Type: `string`
- **versions** `required`
- Type: `array`
## Type definitions in this schema
### entityVersion
- Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.
- Type: `number`
- Default: `0.1`
- Range: &ge; 0.1
- The value must be a multiple of `0.1`
### fieldName
- Name of the field of an entity.
- Type: `string`
### fieldChange
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **name**
- Name of the entity field that changed.
- $ref: [#/definitions/fieldName](#fieldname)
- **oldValue**
- Previous value of the field. Note that this is a JSON string and use the corresponding field type to deserialize it.
- **newValue**
- New value of the field. Note that this is a JSON string and use the corresponding field type to deserialize it.
### changeDescription
- Description of the change.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **fieldsAdded**
- Names of fields added during the version changes.
- Type: `array`
- **Items**
- $ref: [#/definitions/fieldChange](#fieldchange)
- **fieldsUpdated**
- Fields modified during the version changes with old and new values.
- Type: `array`
- **Items**
- $ref: [#/definitions/fieldChange](#fieldchange)
- **fieldsDeleted**
- Fields deleted during the version changes with old value before deleted.
- Type: `array`
- **Items**
- $ref: [#/definitions/fieldChange](#fieldchange)
- **previousVersion**
- When a change did not result in change, this could be same as the current version.
- $ref: [#/definitions/entityVersion](#entityversion)
_This document was updated on: Monday, November 15, 2021_

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

@ -2,58 +2,58 @@
This schema defines the type used for lineage of an entity.
**$id: https://open-metadata.org/schema/type/entitylineage.json**
**$id: [https://open-metadata.org/schema/type/entitylineage.json](https://open-metadata.org/schema/type/entitylineage.json)**
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
* **entity** `required`
* Primary entity for which this lineage graph is created.
* $ref: [entityReference.json](entityreference.md)
* **nodes**
* Type: `array`
* **Items**
* $ref: [entityReference.json](entityreference.md)
* **upstreamEdges**
* Type: `array`
* **Items**
* $ref: [#/definitions/edge](entitylineage.md#edge)
* **downstreamEdges**
* Type: `array`
* **Items**
* $ref: [#/definitions/edge](entitylineage.md#edge)
- **entity** `required`
- Primary entity for which this lineage graph is created.
- $ref: [entityReference.json](entityreference.md)
- **nodes**
- Type: `array`
- **Items**
- $ref: [entityReference.json](entityreference.md)
- **upstreamEdges**
- Type: `array`
- **Items**
- $ref: [#/definitions/edge](#edge)
- **downstreamEdges**
- Type: `array`
- **Items**
- $ref: [#/definitions/edge](#edge)
## Type definitions in this schema
### edge
* Edge in the lineage graph from one entity to another by entity IDs.
* Type: `object`
* **Properties**
* **fromEntity**
* From entity that is upstream of lineage edge.
* $ref: [basic.json#/definitions/uuid](basic.md#uuid)
* **toEntity**
* To entity that is downstream of lineage edge.
* $ref: [basic.json#/definitions/uuid](basic.md#uuid)
* **description**
* Type: `string`
- Edge in the lineage graph from one entity to another by entity IDs.
- Type: `object`
- **Properties**
- **fromEntity**
- From entity that is upstream of lineage edge.
- $ref: [basic.json#/definitions/uuid](basic.md#uuid)
- **toEntity**
- To entity that is downstream of lineage edge.
- $ref: [basic.json#/definitions/uuid](basic.md#uuid)
- **description**
- Type: `string`
### entitiesEdge
* Edge in the lineage graph from one entity to another using entity references.
* Type: `object`
* **Properties**
* **fromEntity**
* From entity that is upstream of lineage edge.
* $ref: [entityReference.json](entityreference.md)
* **toEntity**
* To entity that is downstream of lineage edge.
* $ref: [entityReference.json](entityreference.md)
* **description**
* Type: `string`
- Edge in the lineage graph from one entity to another using entity references.
- Type: `object`
- **Properties**
- **fromEntity**
- From entity that is upstream of lineage edge.
- $ref: [entityReference.json](entityreference.md)
- **toEntity**
- To entity that is downstream of lineage edge.
- $ref: [entityReference.json](entityreference.md)
- **description**
- Type: `string`
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,39 +2,39 @@
This schema defines the EntityReference type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
**$id: **[**https://open-metadata.org/schema/type/entityReference.json**](https://open-metadata.org/schema/type/entityReference.json)
**$id:**[**https://open-metadata.org/schema/type/entityReference.json**](https://open-metadata.org/schema/type/entityReference.json)
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
- **id** `required`
- Unique identifier that identifies an entity instance.
- $ref: [basic.json#/definitions/uuid](basic.md#uuid)
- **type** `required`
- Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
- Type: `string`
- **name**
- Name of the entity instance. For entities such as tables, databases where the name is not unique, fullyQualifiedName is returned in this field.
- Type: `string`
- **description**
- Optional description of entity.
- Type: `string`
- **displayName**
- Display Name that identifies this entity.
- Type: `string`
- **href**
- Link to the entity resource.
- $ref: [basic.json#/definitions/href](basic.md#href)
* **id** `required`
* Unique identifier that identifies an entity instance.
* $ref: [basic.json#/definitions/uuid](basic.md#uuid)
* **type** `required`
* Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
* Type: `string`
* **name**
* Name of the entity instance. For entities such as tables, databases where the name is not unique, fullyQualifiedName is returned in this field.
* Type: `string`
* **description**
* Optional description of entity.
* Type: `string`
* **displayName**
* Display Name that identifies this entity.
* Type: `string`
* **href**
* Link to the entity resource.
* $ref: [basic.json#/definitions/href](basic.md#href)
## Type definitions in this schema
### entityReferenceList
* Type: `array`
* **Items**
* $ref: [entityReference.json](entityreference.md)
- Type: `array`
- **Items**
- $ref: [entityReference.json](entityreference.md)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,19 +2,18 @@
This schema defines the type used for capturing usage details of an entity.
**$id: **[**https://open-metadata.org/schema/type/entityUsage.json**](https://open-metadata.org/schema/type/entityUsage.json)
**$id:**[**https://open-metadata.org/schema/type/entityUsage.json**](https://open-metadata.org/schema/type/entityUsage.json)
Type: `object`
## Properties
- **entity** `required`
- Entity for which usage is returned.
- $ref: [entityReference.json](entityreference.md)
- **usage** `required`
- List usage details per day.
- Type: `array`
- **Items**
- $ref: [usageDetails.json](usagedetails.md)
* **entity** `required`
* Entity for which usage is returned.
* $ref: [entityReference.json](entityreference.md)
* **usage** `required`
* List usage details per day.
* Type: `array`
* **Items**
* $ref: [usageDetails.json](usagedetails.md)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,46 +1,46 @@
# Jdbc Connection
# JDBC connection
This schema defines the type used for JDBC connection information.
**$id: **[**https://open-metadata.org/schema/type/jdbcConnection.json**](https://open-metadata.org/schema/type/jdbcConnection.json)
**$id:**[**https://open-metadata.org/schema/type/jdbcConnection.json**](https://open-metadata.org/schema/type/jdbcConnection.json)
Type: `object`
## Properties
- **driverClass** `required`
- JDBC driver class.
- $ref: [#/definitions/driverClass](#driverclass)
- **connectionUrl** `required`
- JDBC connection URL.
- $ref: [#/definitions/connectionUrl](#connectionurl)
- **userName** `required`
- Login user name.
- Type: `string`
- **password** `required`
- Login password.
- Type: `string`
* **driverClass** `required`
* JDBC driver class.
* $ref: [#/definitions/driverClass](jdbcconnection.md#driverclass)
* **connectionUrl** `required`
* JDBC connection URL.
* $ref: [#/definitions/connectionUrl](jdbcconnection.md#connectionurl)
* **userName** `required`
* Login user name.
* Type: `string`
* **password** `required`
* Login password.
* Type: `string`
## Type definitions in this schema
### driverClass
* Type used for JDBC driver class.
* Type: `string`
- Type used for JDBC driver class.
- Type: `string`
### connectionUrl
* Type used for JDBC connection URL of format `url_scheme://<username>:<password>@<host>:<port>/<db_name>`.
* Type: `string`
- Type used for JDBC connection URL of format `url_scheme://<username>:<password>@<host>:<port>/<db_name>`.
- Type: `string`
### jdbcInfo
* Type for capturing JDBC connector information.
* Type: `object`
* **Properties**
* **driverClass** `required`
* $ref: [#/definitions/driverClass](jdbcconnection.md#driverclass)
* **connectionUrl** `required`
* $ref: [#/definitions/connectionUrl](jdbcconnection.md#connectionurl)
- Type for capturing JDBC connector information.
- Type: `object`
- **Properties**
- **driverClass** `required`
- $ref: [#/definitions/driverClass](#driverclass)
- **connectionUrl** `required`
- $ref: [#/definitions/connectionUrl](#connectionurl)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,21 +1,20 @@
# Paging
The Type used for cursor-based pagination information in GET list responses.
Type used for cursor based pagination information in GET list responses.
**$id: **[**https://open-metadata.org/schema/type/paging.json**](https://open-metadata.org/schema/type/paging.json)
**$id:**[**https://open-metadata.org/schema/type/paging.json**](https://open-metadata.org/schema/type/paging.json)
Type: `object`
## Properties
- **before**
- Before cursor used for getting the previous page (see API pagination for details).
- Type: `string`
- **after**
- After cursor used for getting the next page (see API pagination for details).
- Type: `string`
- **total** `required`
- Total number of entries available to page through.
- Type: `integer`
* **before**
* Before cursor used for getting the previous page (see API pagination for details).
* Type: `string`
* **after**
* After cursor used for getting the next page (see API pagination for details).
* Type: `string`
* **total** `required`
* Total number of entries available to page through.
* Type: `integer`
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -2,42 +2,41 @@
This schema defines the type for a profile of a user, team, or organization.
**$id: **[**https://open-metadata.org/schema/type/profile.json**](https://open-metadata.org/schema/type/profile.json)
**$id:**[**https://open-metadata.org/schema/type/profile.json**](https://open-metadata.org/schema/type/profile.json)
Type: `object`
## Properties
* **images**
* $ref: [#/definitions/imageList](profile.md#imagelist)
- **images**
- $ref: [#/definitions/imageList](#imagelist)
## Type definitions in this schema
### imageList
* Links to a list of images of varying resolutions/sizes.
* Type: `object`
* **Properties**
* **image**
* Type: `string`
* String format must be a "uri"
* **image24**
* Type: `string`
* String format must be a "uri"
* **image32**
* Type: `string`
* String format must be a "uri"
* **image48**
* Type: `string`
* String format must be a "uri"
* **image72**
* Type: `string`
* String format must be a "uri"
* **image192**
* Type: `string`
* String format must be a "uri"
* **image512**
* Type: `string`
* String format must be a "uri"
- Links to a list of images of varying resolutions/sizes.
- Type: `object`
- **Properties**
- **image**
- Type: `string`
- String format must be a "uri"
- **image24**
- Type: `string`
- String format must be a "uri"
- **image32**
- Type: `string`
- String format must be a "uri"
- **image48**
- Type: `string`
- String format must be a "uri"
- **image72**
- Type: `string`
- String format must be a "uri"
- **image192**
- Type: `string`
- String format must be a "uri"
- **image512**
- Type: `string`
- String format must be a "uri"
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,18 +1,17 @@
# Schedule
This schema defines the type used for the schedule. The schedule has a start time and repeats frequency.
This schema defines the type used for the schedule. The schedule has a start time and repeat frequency.
**$id: **[**https://open-metadata.org/schema/type/schedule.json**](https://open-metadata.org/schema/type/schedule.json)
**$id:**[**https://open-metadata.org/schema/type/schedule.json**](https://open-metadata.org/schema/type/schedule.json)
Type: `object`
## Properties
- **startDate**
- Start date and time of the schedule.
- $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
- **repeatFrequency**
- Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'.
- $ref: [basic.json#/definitions/duration](basic.md#duration)
* **startDate**
* Start date and time of the schedule.
* $ref: [basic.json#/definitions/dateTime](basic.md#datetime)
* **repeatFrequency**
* Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'.
* $ref: [basic.json#/definitions/duration](basic.md#duration)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,36 +1,38 @@
# Tag Label
This schema defines the type for labelling 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)
**$id:**[**https://open-metadata.org/schema/type/tagLabel.json**](https://open-metadata.org/schema/type/tagLabel.json)
Type: `object`
This schema does not accept additional properties.
This schema <u>does not</u> accept additional properties.
## Properties
* **tagFQN**
* Type: `string`
* Length: ≤ 45
* **labelType**
* 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`
* The value is restricted to the following:
- **tagFQN** `required`
- Type: `string`
- Length: &le; 45
- **description**
- Unique name of the tag category.
- Type: `string`
- **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`
- The value is restricted to the following:
1. _"Manual"_
2. _"Propagated"_
3. _"Automated"_
4. _"Derived"_
* Default: _"Manual"_
* **state**
* 'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'.
* Type: `string`
* The value is restricted to the following:
- Default: _"Manual"_
- **state** `required`
- 'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'.
- Type: `string`
- The value is restricted to the following:
1. _"Suggested"_
2. _"Confirmed"_
* Default: _"Confirmed"_
* **href**
* Link to the tag resource.
* $ref: [basic.json#/definitions/href](basic.md#href)
- Default: _"Confirmed"_
- **href**
- Link to the tag resource.
- $ref: [basic.json#/definitions/href](basic.md#href)
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_

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

@ -1,41 +1,40 @@
# Usage Details
# Type used to return usage details of an entity
This schema defines the type for usage details. Daily, weekly, and monthly aggregation of usage is computed along with the percentile rank based on the usage for a given day.
**$id: **[**https://open-metadata.org/schema/type/usageDetails.json**](https://open-metadata.org/schema/type/usageDetails.json)
**$id:**[**https://open-metadata.org/schema/type/usageDetails.json**](https://open-metadata.org/schema/type/usageDetails.json)
Type: `object`
## Properties
* **dailyStats** `required`
* Daily usage stats of a data asset on the start date.
* $ref: [#/definitions/usageStats](usagedetails.md#usagestats)
* **weeklyStats**
* Weekly (last 7 days) rolling usage stats of a data asset on the start date.
* $ref: [#/definitions/usageStats](usagedetails.md#usagestats)
* **monthlyStats**
* Monthly (last 30 days) rolling usage stats of a data asset on the start date.
* $ref: [#/definitions/usageStats](usagedetails.md#usagestats)
* **date** `required`
* Date in UTC.
* $ref: [basic.json#/definitions/date](basic.md#date)
- **dailyStats** `required`
- Daily usage stats of a data asset on the start date.
- $ref: [#/definitions/usageStats](#usagestats)
- **weeklyStats**
- Weekly (last 7 days) rolling usage stats of a data asset on the start date.
- $ref: [#/definitions/usageStats](#usagestats)
- **monthlyStats**
- Monthly (last 30 days) rolling usage stats of a data asset on the start date.
- $ref: [#/definitions/usageStats](#usagestats)
- **date** `required`
- Date in UTC.
- $ref: [basic.json#/definitions/date](basic.md#date)
## Type definitions in this schema
### usageStats
* Type used to return usage statistics.
* Type: `object`
* This schema does not accept additional properties.
* **Properties**
* **count** `required`
* Usage count of a data asset on the start date.
* Type: `integer`
* Range: ≥ 0
* **percentileRank**
* Optional daily percentile rank data asset use when relevant.
* Type: `number`
* Range: between 0 and 100
- Type used to return usage statistics.
- Type: `object`
- This schema <u>does not</u> accept additional properties.
- **Properties**
- **count** `required`
- Usage count of a data asset on the start date.
- Type: `integer`
- Range: &ge; 0
- **percentileRank**
- Optional daily percentile rank data asset use when relevant.
- Type: `number`
- Range: between 0 and 100
_This document was updated on: Monday, October 18, 2021_
_This document was updated on: Monday, November 15, 2021_