mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-20 15:57:49 +00:00
Merge pull request #146 from open-metadata/docUpdate.part11
Fix json documentation - documentation update part11
This commit is contained in:
commit
e1faee1ba2
@ -1,2 +1,25 @@
|
||||
# Bot
|
||||
|
||||
This schema defines Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It runs as a special user in the system.
|
||||
|
||||
<b id="httpsopen-metadata.orgschemaentitybots.json">$id: https://open-metadata.org/schema/entity/bots.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/bots.json/properties/id">id</b>
|
||||
- Unique identifier of a bot instance.
|
||||
- $ref: [../type/basic.json#/definitions/uuid](#..typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/bots.json/properties/name">name</b>
|
||||
- Name of the bot.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/bots.json/properties/displayName">displayName</b>
|
||||
- Name used for display purposes. Example 'FirstName LastName'.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/bots.json/properties/description">description</b>
|
||||
- Description of the bot.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/bots.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this bot.
|
||||
- $ref: [../type/basic.json#/definitions/href](#..typebasic.jsondefinitionshref)
|
||||
|
@ -1,37 +1,35 @@
|
||||
# Dashboard
|
||||
|
||||
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.
|
||||
This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KIPs. They are updated in real-time and allow interactive data exploration.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatadashboard.json">$id: https://open-metadata.org/schema/entity/data/dashboard.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies a dashboard instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](dashboard.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name that identifies this dashboard.
|
||||
* Type: `string`
|
||||
* Length: between 1 and 64
|
||||
* **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`
|
||||
* **href**
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](dashboard.md#....typebasic.jsondefinitionshref)
|
||||
* **owner**
|
||||
* Owner of this dashboard.
|
||||
* $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json)
|
||||
* **service** `required`
|
||||
* Link to service where this dashboard is hosted in.
|
||||
* $ref: [../../type/entityReference.json](dashboard.md#....typeentityreference.json)
|
||||
* **usageSummary**
|
||||
* Latest usage information for this database.
|
||||
* $ref: [../../type/usageDetails.json](dashboard.md#....typeusagedetails.json)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies a dashboard instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/name">name</b> `required`
|
||||
- Name that identifies this dashboard.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/description">description</b>
|
||||
- Description of the dashboard, what it is, and how to use it.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/owner">owner</b>
|
||||
- Owner of this dashboard.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/service">service</b> `required`
|
||||
- Link to service where this dashboard is hosted in.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/dashboard.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|
||||
|
@ -2,42 +2,41 @@
|
||||
|
||||
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.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json)
|
||||
<b id="httpsopen-metadata.orgschemaentityservicesdatabaseservice.json">$id: https://open-metadata.org/schema/entity/services/databaseService.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/id">id</b> `required`
|
||||
- Unique identifier of this database service instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/name">name</b> `required`
|
||||
- Name that identifies this database service.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/serviceType">serviceType</b> `required`
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- $ref: [#/definitions/databaseServiceType](#/definitions/databaseServiceType)
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/description">description</b>
|
||||
- Description of a database service instance.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/href">href</b> `required`
|
||||
- Link to the resource corresponding to this database service.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/jdbc">jdbc</b> `required`
|
||||
- JDBC connection information
|
||||
- $ref: [../../type/jdbcConnection.json#/definitions/jdbcInfo](#....typejdbcconnection.jsondefinitionsjdbcinfo)
|
||||
- <b id="#https://open-metadata.org/schema/entity/services/databaseService.json/properties/ingestionSchedule">ingestionSchedule</b>
|
||||
- Schedule for running metadata ingestion jobs.
|
||||
- $ref: [../../type/schedule.json](#....typeschedule.json)
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier of this database service instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](database-service.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name that identifies this database service.
|
||||
* Type: `string`
|
||||
* Length: between 1 and 64
|
||||
* **serviceType** `required`
|
||||
* Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
* $ref: [\#/definitions/databaseServiceType](database-service.md#/definitions/databaseServiceType)
|
||||
* **description**
|
||||
* Description of a database service instance.
|
||||
* Type: `string`
|
||||
* **href** `required`
|
||||
* Link to the resource corresponding to this database service.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](database-service.md#....typebasic.jsondefinitionshref)
|
||||
* **jdbc** `required`
|
||||
* JDBC connection information
|
||||
* $ref: [../../type/jdbcConnection.json\#/definitions/jdbcInfo](database-service.md#....typejdbcconnection.jsondefinitionsjdbcinfo)
|
||||
* **ingestionSchedule**
|
||||
* Schedule for running metadata ingestion jobs.
|
||||
* $ref: [../../type/schedule.json](database-service.md#....typeschedule.json)
|
||||
|
||||
## Types 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"_
|
||||
@ -46,3 +45,4 @@ Type: `object`
|
||||
6. _"MSSQL"_
|
||||
7. _"Hive"_
|
||||
|
||||
|
||||
|
@ -2,46 +2,46 @@
|
||||
|
||||
This schema defines the Database entity. A database also referred to as Database Catalog is a collection tables.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatadatabase.json">$id: https://open-metadata.org/schema/entity/data/database.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/id">id</b>
|
||||
- Unique identifier that identifies this database instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/name">name</b> `required`
|
||||
- Name that identifies the database.
|
||||
- $ref: [#/definitions/databaseName](#/definitions/databaseName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/description">description</b>
|
||||
- Description of the database instance.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/owner">owner</b>
|
||||
- Owner of this database.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/service">service</b> `required`
|
||||
- Link to the database cluster/service where this database is hosted in.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/database.json/properties/tables">tables</b>
|
||||
- References to tables in the database.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
* **id**
|
||||
* Unique identifier that identifies this database instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](database.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name that identifies the database.
|
||||
* $ref: [\#/definitions/databaseName](database.md#/definitions/databaseName)
|
||||
* **fullyQualifiedName**
|
||||
* Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.
|
||||
* Type: `string`
|
||||
* **description**
|
||||
* Description of the database instance.
|
||||
* Type: `string`
|
||||
* **href**
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](database.md#....typebasic.jsondefinitionshref)
|
||||
* **owner**
|
||||
* Owner of this database.
|
||||
* $ref: [../../type/entityReference.json](database.md#....typeentityreference.json)
|
||||
* **service** `required`
|
||||
* Link to the database cluster/service where this database is hosted in.
|
||||
* $ref: [../../type/entityReference.json](database.md#....typeentityreference.json)
|
||||
* **usageSummary**
|
||||
* Latest usage information for this database.
|
||||
* $ref: [../../type/usageDetails.json](database.md#....typeusagedetails.json)
|
||||
* **tables**
|
||||
* References to tables in the database.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](database.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
## Types 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
|
||||
|
||||
|
||||
|
@ -2,36 +2,34 @@
|
||||
|
||||
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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatametrics.json">$id: https://open-metadata.org/schema/entity/data/metrics.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies this metrics instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](metrics.md#....typebasic.jsondefinitionsuuid)
|
||||
* **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
|
||||
* **description**
|
||||
* Description of metrics instance, what it is, and how to use it.
|
||||
* Type: `string`
|
||||
* **href**
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](metrics.md#....typebasic.jsondefinitionshref)
|
||||
* **owner**
|
||||
* Owner of this metrics.
|
||||
* $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json)
|
||||
* **service** `required`
|
||||
* Link to service where this metrics is hosted in.
|
||||
* $ref: [../../type/entityReference.json](metrics.md#....typeentityreference.json)
|
||||
* **usageSummary**
|
||||
* Latest usage information for this database.
|
||||
* $ref: [../../type/usageDetails.json](metrics.md#....typeusagedetails.json)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies this metrics instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/name">name</b> `required`
|
||||
- Name that identifies this metrics instance uniquely.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- A unique name that identifies a metric in the format 'ServiceName.MetricName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/description">description</b>
|
||||
- Description of metrics instance, what it is, and how to use it.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/owner">owner</b>
|
||||
- Owner of this metrics.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/service">service</b> `required`
|
||||
- Link to service where this metrics is hosted in.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/metrics.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|
||||
|
@ -2,33 +2,31 @@
|
||||
|
||||
This schema defines the Pipeline entity. A pipeline enables 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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatapipeline.json">$id: https://open-metadata.org/schema/entity/data/pipeline.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies a pipeline instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](pipeline.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name that identifies this pipeline instance uniquely.
|
||||
* Type: `string`
|
||||
* Length: between 1 and 64
|
||||
* **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`
|
||||
* **href**
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](pipeline.md#....typebasic.jsondefinitionshref)
|
||||
* **owner**
|
||||
* Owner of this pipeline.
|
||||
* $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json)
|
||||
* **service** `required`
|
||||
* Link to service where this pipeline is hosted in.
|
||||
* $ref: [../../type/entityReference.json](pipeline.md#....typeentityreference.json)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies a pipeline instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/name">name</b> `required`
|
||||
- Name that identifies this pipeline instance uniquely.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/description">description</b>
|
||||
- Description of this pipeline.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/owner">owner</b>
|
||||
- Owner of this pipeline.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/pipeline.json/properties/service">service</b> `required`
|
||||
- Link to service where this pipeline is hosted in.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
|
@ -2,36 +2,34 @@
|
||||
|
||||
This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and in visual form.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatareport.json">$id: https://open-metadata.org/schema/entity/data/report.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies this report.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](report.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name that identifies the 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
|
||||
* **description**
|
||||
* Description of this report instance.
|
||||
* Type: `string`
|
||||
* **href**
|
||||
* Link to the resource corresponding to this report.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](report.md#....typebasic.jsondefinitionshref)
|
||||
* **owner**
|
||||
* Owner of this pipeline.
|
||||
* $ref: [../../type/entityReference.json](report.md#....typeentityreference.json)
|
||||
* **service** `required`
|
||||
* Link to service where this report is hosted in.
|
||||
* $ref: [../../type/entityReference.json](report.md#....typeentityreference.json)
|
||||
* **usageSummary**
|
||||
* Latest usage information for this database.
|
||||
* $ref: [../../type/usageDetails.json](report.md#....typeusagedetails.json)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies this report.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/name">name</b> `required`
|
||||
- Name that identifies the this report instance uniquely.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- A unique name that identifies a report in the format 'ServiceName.ReportName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/description">description</b>
|
||||
- Description of this report instance.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this report.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/owner">owner</b>
|
||||
- Owner of this pipeline.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/service">service</b> `required`
|
||||
- Link to service where this report is hosted in.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/report.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this database.
|
||||
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|
||||
|
@ -2,81 +2,81 @@
|
||||
|
||||
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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitydatatable.json">$id: https://open-metadata.org/schema/entity/data/table.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/id">id</b> `required`
|
||||
- Unique identifier of this table instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/name">name</b> `required`
|
||||
- Name of a table. Expected to be unique within a database.
|
||||
- $ref: [#/definitions/tableName](#/definitions/tableName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/description">description</b>
|
||||
- Description of a table.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/href">href</b>
|
||||
- Link to this table resource.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/tableType">tableType</b>
|
||||
- $ref: [#/definitions/tableType](#/definitions/tableType)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/columns">columns</b> `required`
|
||||
- Columns in this table.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/column](#/definitions/column)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/tableConstraints">tableConstraints</b>
|
||||
- Table constraints.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/tableConstraint](#/definitions/tableConstraint)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this table.
|
||||
- $ref: [../../type/usageDetails.json](#....typeusagedetails.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/owner">owner</b>
|
||||
- Owner of this table.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/followers">followers</b>
|
||||
- Followers of this table.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/database">database</b>
|
||||
- Reference to Database that contains this table.
|
||||
- $ref: [../../type/entityReference.json](#....typeentityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/tags">tags</b>
|
||||
- Tags for this table.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](#....typetaglabel.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/joins">joins</b>
|
||||
- Details of other tables this table is frequently joined with.
|
||||
- $ref: [#/definitions/tableJoins](#/definitions/tableJoins)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/properties/sampleData">sampleData</b>
|
||||
- Sample data for a table.
|
||||
- $ref: [#/definitions/tableData](#/definitions/tableData)
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier of this table instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](table.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* Name of a table. Expected to be unique within a database.
|
||||
* $ref: [\#/definitions/tableName](table.md#/definitions/tableName)
|
||||
* **description**
|
||||
* Description of a table.
|
||||
* Type: `string`
|
||||
* **href**
|
||||
* Link to this table resource.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](table.md#....typebasic.jsondefinitionshref)
|
||||
* **tableType**
|
||||
* $ref: [\#/definitions/tableType](table.md#/definitions/tableType)
|
||||
* **fullyQualifiedName**
|
||||
* Fully qualified name of a table in the form `serviceName.databaseName.tableName`.
|
||||
* Type: `string`
|
||||
* **columns** `required`
|
||||
* Columns in this table.
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [\#/definitions/column](table.md#/definitions/column)
|
||||
* **tableConstraints**
|
||||
* Table constraints.
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [\#/definitions/tableConstraint](table.md#/definitions/tableConstraint)
|
||||
* **usageSummary**
|
||||
* Latest usage information for this table.
|
||||
* $ref: [../../type/usageDetails.json](table.md#....typeusagedetails.json)
|
||||
* **owner**
|
||||
* Owner of this table.
|
||||
* $ref: [../../type/entityReference.json](table.md#....typeentityreference.json)
|
||||
* **followers**
|
||||
* Followers of this table.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](table.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
* **database**
|
||||
* Reference to Database that contains this table.
|
||||
* $ref: [../../type/entityReference.json](table.md#....typeentityreference.json)
|
||||
* **tags**
|
||||
* Tags for this table.
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json)
|
||||
* **joins**
|
||||
* Details of other tables this table is frequently joined with.
|
||||
* $ref: [\#/definitions/tableJoins](table.md#/definitions/tableJoins)
|
||||
* **sampleData**
|
||||
* Sample data for a table.
|
||||
* $ref: [\#/definitions/tableData](table.md#/definitions/tableData)
|
||||
|
||||
## Types 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"_
|
||||
4. _"SecureView"_
|
||||
5. _"MaterializedView"_
|
||||
|
||||
|
||||
**columnDataType**
|
||||
|
||||
* 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"_
|
||||
@ -111,132 +111,142 @@ Type: `object`
|
||||
32. _"ENUM"_
|
||||
33. _"JSON"_
|
||||
|
||||
|
||||
**columnConstraint**
|
||||
|
||||
* 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"_
|
||||
* Default: _"NULL"_
|
||||
4. _"PRIMARY_KEY"_
|
||||
- Default: _"NULL"_
|
||||
|
||||
|
||||
**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**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableConstraint/properties/constraintType">constraintType</b>
|
||||
- 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"_
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableConstraint/properties/columns">columns</b>
|
||||
- List of column names corresponding to the constraint.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- Type: `string`
|
||||
|
||||
|
||||
**columnName**
|
||||
|
||||
* Local name \(not fully qualified name\) of the column.
|
||||
* Type: `string`
|
||||
* The value must match this pattern: `^[^.]*$`
|
||||
* Length: between 1 and 64
|
||||
- Local name (not fully qualified name) of the column.
|
||||
- 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`.
|
||||
* Type: `string`
|
||||
* Length: between 1 and 256
|
||||
- Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 256
|
||||
|
||||
|
||||
**column**
|
||||
|
||||
* This schema defines the type for a column in a table.
|
||||
* Type: `object`
|
||||
* **Properties**
|
||||
* **name** `required`
|
||||
* $ref: [\#/definitions/columnName](table.md#/definitions/columnName)
|
||||
* **columnDataType** `required`
|
||||
* Data type of the column \(int, date etc.\).
|
||||
* $ref: [\#/definitions/columnDataType](table.md#/definitions/columnDataType)
|
||||
* **description**
|
||||
* Description of the column.
|
||||
* Type: `string`
|
||||
* **fullyQualifiedName**
|
||||
* $ref: [\#/definitions/fullyQualifiedColumnName](table.md#/definitions/fullyQualifiedColumnName)
|
||||
* **tags**
|
||||
* Tags associated with the column.
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [../../type/tagLabel.json](table.md#....typetaglabel.json)
|
||||
* **columnConstraint**
|
||||
* Column level constraint.
|
||||
* $ref: [\#/definitions/columnConstraint](table.md#/definitions/columnConstraint)
|
||||
* **ordinalPosition**
|
||||
* Ordinal position of the column.
|
||||
* Type: `integer`
|
||||
- This schema defines the type for a column in a table.
|
||||
- Type: `object`
|
||||
- **Properties**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/name">name</b> `required`
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/columnDataType">columnDataType</b> `required`
|
||||
- Data type of the column (int, date etc.).
|
||||
- $ref: [#/definitions/columnDataType](#/definitions/columnDataType)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/description">description</b>
|
||||
- Description of the column.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/tags">tags</b>
|
||||
- Tags associated with the column.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](#....typetaglabel.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/columnConstraint">columnConstraint</b>
|
||||
- Column level constraint.
|
||||
- $ref: [#/definitions/columnConstraint](#/definitions/columnConstraint)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/column/properties/ordinalPosition">ordinalPosition</b>
|
||||
- Ordinal position of the column.
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
**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#/definitions/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#/definitions/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**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/columnJoins/properties/columnName">columnName</b>
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith">joinedWith</b>
|
||||
- Fully qualified names of the columns that this column is joined with.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- Type: `object`
|
||||
- **Properties**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith/items/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith/items/properties/joinCount">joinCount</b>
|
||||
- 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](table.md#....typebasic.jsondefinitionsdate)
|
||||
* **dayCount**
|
||||
* Type: `integer`
|
||||
* Default: `1`
|
||||
* **columnJoins**
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [\#/definitions/columnJoins](table.md#/definitions/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**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableJoins/properties/startDate">startDate</b>
|
||||
- Date can be only from today going back to last 29 days.
|
||||
- $ref: [../../type/basic.json#/definitions/date](#....typebasic.jsondefinitionsdate)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableJoins/properties/dayCount">dayCount</b>
|
||||
- Type: `integer`
|
||||
- Default: `1`
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableJoins/properties/columnJoins">columnJoins</b>
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/columnJoins](#/definitions/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#/definitions/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**
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableData/properties/columns">columns</b>
|
||||
- List of local column names (not fully qualified column names) of the table.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/data/table.json/definitions/tableData/properties/rows">rows</b>
|
||||
- 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`
|
||||
|
||||
|
||||
|
@ -2,48 +2,51 @@
|
||||
|
||||
This schema defines the Tag Category entity. A Tag Category has one more children tags called Primary Tags. Primary Tags can further have children Tags called Secondary Tags. Only two levels of tags are supported currently.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json)
|
||||
<b id="httpsopen-metadata.orgschemaentitytagstagcategory.json">$id: https://open-metadata.org/schema/entity/tags/tagCategory.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema does not accept additional properties.
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/name">name</b> `required`
|
||||
- $ref: [#/definitions/tagName](#/definitions/tagName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/description">description</b> `required`
|
||||
- Description of the tag category.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/categoryType">categoryType</b> `required`
|
||||
- $ref: [#/definitions/tagCategoryType](#/definitions/tagCategoryType)
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to the tag category.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/usageCount">usageCount</b>
|
||||
- Count of how many times the tags from this tag category are used.
|
||||
- Type: `integer`
|
||||
- <b id="#https://open-metadata.org/schema/entity/tags/tagCategory.json/properties/children">children</b>
|
||||
- Tags under this category.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/tag](#/definitions/tag)
|
||||
|
||||
* **name** `required`
|
||||
* $ref: [\#/definitions/tagName](tag-category.md#/definitions/tagName)
|
||||
* **description** `required`
|
||||
* Description of the tag category.
|
||||
* Type: `string`
|
||||
* **categoryType** `required`
|
||||
* $ref: [\#/definitions/tagCategoryType](tag-category.md#/definitions/tagCategoryType)
|
||||
* **href**
|
||||
* Link to the resource corresponding to the tag category.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](tag-category.md#....typebasic.jsondefinitionshref)
|
||||
* **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-category.md#/definitions/tag)
|
||||
|
||||
## Types 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**
|
||||
|
||||
|
||||
|
||||
|
@ -2,43 +2,43 @@
|
||||
|
||||
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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json)
|
||||
<b id="httpsopen-metadata.orgschemaentityteamsteam.json">$id: https://open-metadata.org/schema/entity/teams/team.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/id">id</b> `required`
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/name">name</b> `required`
|
||||
- $ref: [#/definitions/teamName](#/definitions/teamName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/displayName">displayName</b>
|
||||
- Name used for display purposes. Example 'Data Science team'.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/description">description</b>
|
||||
- Description of the team.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/href">href</b> `required`
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/profile">profile</b>
|
||||
- Team profile information.
|
||||
- $ref: [../../type/profile.json](#....typeprofile.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/deleted">deleted</b>
|
||||
- When true the team has been deleted.
|
||||
- Type: `boolean`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/users">users</b>
|
||||
- Users that are part of the team.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/team.json/properties/owns">owns</b>
|
||||
- List of entities owned by the team.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
* **id** `required`
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](team.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* $ref: [\#/definitions/teamName](team.md#/definitions/teamName)
|
||||
* **displayName**
|
||||
* Name used for display purposes. Example 'Data Science team'.
|
||||
* Type: `string`
|
||||
* **description**
|
||||
* Description of the team.
|
||||
* Type: `string`
|
||||
* **href** `required`
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](team.md#....typebasic.jsondefinitionshref)
|
||||
* **profile**
|
||||
* Team profile information.
|
||||
* $ref: [../../type/profile.json](team.md#....typeprofile.json)
|
||||
* **deleted**
|
||||
* When true the team has been deleted.
|
||||
* Type: `boolean`
|
||||
* **users**
|
||||
* Users that are part of the team.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
* **owns**
|
||||
* List of entities owned by the team.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](team.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
## Types 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
|
||||
|
||||
|
||||
|
@ -1,47 +1,47 @@
|
||||
# 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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json)
|
||||
<b id="httpsopen-metadata.orgschemaentityfeedthread.json">$id: https://open-metadata.org/schema/entity/feed/thread.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies an entity instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/threadTs">threadTs</b>
|
||||
- Timestamp of the when the first post created the thread.
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/about">about</b> `required`
|
||||
- Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}.
|
||||
- $ref: [../../type/basic.json#/definitions/entityLink](#....typebasic.jsondefinitionsentitylink)
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/addressedTo">addressedTo</b>
|
||||
- User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}.
|
||||
- $ref: [../../type/basic.json#/definitions/entityLink](#....typebasic.jsondefinitionsentitylink)
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/properties/posts">posts</b> `required`
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [#/definitions/post](#/definitions/post)
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies an entity instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](thread.md#....typebasic.jsondefinitionsuuid)
|
||||
* **href**
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](thread.md#....typebasic.jsondefinitionshref)
|
||||
* **threadTs**
|
||||
* Timestamp of the when the first post created the thread.
|
||||
* **about** `required`
|
||||
* Data asset about which this thread is created for with format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
|
||||
* $ref: [../../type/basic.json\#/definitions/entityLink](thread.md#....typebasic.jsondefinitionsentitylink)
|
||||
* **addressedTo**
|
||||
* User or team this thread is addressed to in format <\#E/{enties}/{entityName}/{field}/{fieldValue}.
|
||||
* $ref: [../../type/basic.json\#/definitions/entityLink](thread.md#....typebasic.jsondefinitionsentitylink)
|
||||
* **posts** `required`
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [\#/definitions/post](thread.md#/definitions/post)
|
||||
|
||||
## Types 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](thread.md#....typebasic.jsondefinitionsuuid)
|
||||
- Post within a feed.
|
||||
- Type: `object`
|
||||
- **Properties**
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/definitions/post/properties/message">message</b> `required`
|
||||
- Message in markdown format. See markdown support for more details.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/definitions/post/properties/postTs">postTs</b>
|
||||
- Timestamp of the post.
|
||||
- Type: `string`
|
||||
- String format must be a "date-time"
|
||||
- <b id="#https://open-metadata.org/schema/entity/feed/thread.json/definitions/post/properties/from">from</b> `required`
|
||||
- ID of User (regular user or a bot) posting the message.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
|
||||
|
||||
|
@ -2,59 +2,59 @@
|
||||
|
||||
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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json)
|
||||
<b id="httpsopen-metadata.orgschemaentityteamsuser.json">$id: https://open-metadata.org/schema/entity/teams/user.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema does not accept additional properties.
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies a user entity instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/name">name</b> `required`
|
||||
- $ref: [#/definitions/userName](#/definitions/userName)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/displayName">displayName</b>
|
||||
- Name used for display purposes. Example 'FirstName LastName'.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/email">email</b> `required`
|
||||
- Email address of the user.
|
||||
- $ref: [../../type/basic.json#/definitions/email](#....typebasic.jsondefinitionsemail)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/href">href</b> `required`
|
||||
- Link to the resource corresponding to this entity.
|
||||
- $ref: [../../type/basic.json#/definitions/href](#....typebasic.jsondefinitionshref)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/timezone">timezone</b>
|
||||
- Timezone of the user.
|
||||
- Type: `string`
|
||||
- String format must be a "timezone"
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/deactivated">deactivated</b>
|
||||
- When true indicates the user has been deactivated. Users are deactivated instead of deleted.
|
||||
- Type: `boolean`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/isBot">isBot</b>
|
||||
- When true indicates a special type of user called Bot.
|
||||
- Type: `boolean`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/isAdmin">isAdmin</b>
|
||||
- When true indicates user is an administrator for the system with superuser privileges.
|
||||
- Type: `boolean`
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/profile">profile</b>
|
||||
- Profile of the user.
|
||||
- $ref: [../../type/profile.json](#....typeprofile.json)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/teams">teams</b>
|
||||
- Teams that the user belongs to.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/owns">owns</b>
|
||||
- List of entities owned by the user.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
- <b id="#https://open-metadata.org/schema/entity/teams/user.json/properties/follows">follows</b>
|
||||
- List of entities followed by the user.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies a user entity instance.
|
||||
* $ref: [../../type/basic.json\#/definitions/uuid](user.md#....typebasic.jsondefinitionsuuid)
|
||||
* **name** `required`
|
||||
* $ref: [\#/definitions/userName](user.md#/definitions/userName)
|
||||
* **displayName**
|
||||
* Name used for display purposes. Example 'FirstName LastName'.
|
||||
* Type: `string`
|
||||
* **email** `required`
|
||||
* Email address of the user.
|
||||
* $ref: [../../type/basic.json\#/definitions/email](user.md#....typebasic.jsondefinitionsemail)
|
||||
* **href** `required`
|
||||
* Link to the resource corresponding to this entity.
|
||||
* $ref: [../../type/basic.json\#/definitions/href](user.md#....typebasic.jsondefinitionshref)
|
||||
* **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](user.md#....typeprofile.json)
|
||||
* **teams**
|
||||
* Teams that the user belongs to.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
* **owns**
|
||||
* List of entities owned by the user.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
* **follows**
|
||||
* List of entities followed by the user.
|
||||
* $ref: [../../type/entityReference.json\#/definitions/entityReferenceList](user.md#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
## Types definitions in this schema
|
||||
|
||||
**userName**
|
||||
|
||||
* 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
|
||||
- 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
|
||||
|
||||
|
||||
|
@ -2,36 +2,34 @@
|
||||
|
||||
This schema defines Audit Log type to capture the audit trail of POST, PUT, and PATCH API operations.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json)
|
||||
<b id="httpsopen-metadata.orgschematypeauditlog.json">$id: https://open-metadata.org/schema/type/auditLog.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **method** `required`
|
||||
* HTTP Method used in a call.
|
||||
* Type: `string`
|
||||
* The value is restricted to the following:
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/method">method</b> `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 requested for the API.
|
||||
* Type: `string`
|
||||
* **dateTime**
|
||||
* Date which the api call is made.
|
||||
* $ref: [basic.json\#/definitions/dateTime](audit-log.md#basic.jsondefinitionsdatetime)
|
||||
* **entityId** `required`
|
||||
* Entity Id that was modified by the operation.
|
||||
* $ref: [basic.json\#/definitions/uuid](audit-log.md#basic.jsondefinitionsuuid)
|
||||
* **entityType** `required`
|
||||
* Entity Type that modified by the operation.
|
||||
* Type: `string`
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/responseCode">responseCode</b> `required`
|
||||
- HTTP response code for the api requested.
|
||||
- Type: `integer`
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/path">path</b> `required`
|
||||
- Requested API Path.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/userName">userName</b> `required`
|
||||
- Name of the user who requested for the API.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/dateTime">dateTime</b>
|
||||
- Date which the api call is made.
|
||||
- $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime)
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/entityId">entityId</b> `required`
|
||||
- Entity Id that was modified by the operation.
|
||||
- $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/type/auditLog.json/properties/entityType">entityType</b> `required`
|
||||
- Entity Type that modified by the operation.
|
||||
- Type: `string`
|
||||
|
@ -2,67 +2,77 @@
|
||||
|
||||
This schema defines basic common types that are used by other schemas.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json)
|
||||
<b id="httpsopen-metadata.orgschematypebasic.json">$id: https://open-metadata.org/schema/type/basic.json</b>
|
||||
|
||||
|
||||
|
||||
## Types definitions in this schema
|
||||
|
||||
**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 a "email"
|
||||
* The value must match this pattern: `^\S+@\S+\.\S+$`
|
||||
* Length: between 6 and 127
|
||||
- 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
|
||||
|
||||
|
||||
**entityLink**
|
||||
|
||||
* Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
|
||||
* Type: `string`
|
||||
* The value must match this pattern: `^<#E/\S+/\S+>$`
|
||||
- Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^<#E/\S+/\S+>$`
|
||||
|
||||
|
||||
**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**
|
||||
|
||||
* href that points to a resource.
|
||||
* Type: `string`
|
||||
* String format must be a "uri"
|
||||
- href that points to a resource.
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
**timeInterval**
|
||||
|
||||
* Type: `object`
|
||||
* **Properties**
|
||||
* **start**
|
||||
* Start time in unixTimeMillis.
|
||||
* Type: `integer`
|
||||
* **end**
|
||||
* End time in unixTimeMillis.
|
||||
* Type: `integer`
|
||||
- Type: `object`
|
||||
- **Properties**
|
||||
- <b id="#https://open-metadata.org/schema/type/basic.json/definitions/timeInterval/properties/start">start</b>
|
||||
- Start time in unixTimeMillis.
|
||||
- Type: `integer`
|
||||
- <b id="#https://open-metadata.org/schema/type/basic.json/definitions/timeInterval/properties/end">end</b>
|
||||
- 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"
|
||||
- Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
|
||||
- Type: `string`
|
||||
- String format must be a "date-Time"
|
||||
|
||||
|
||||
|
@ -1,17 +1,17 @@
|
||||
# Daily Count
|
||||
# Daily count of some measurement
|
||||
|
||||
This schema defines the type for reporting the daily count of some measurement. Example - number of times a table was used in queries per day.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json)
|
||||
<b id="httpsopen-metadata.orgschematypedailycount.json">$id: https://open-metadata.org/schema/type/dailyCount.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
This schema <u>does not</u> accept additional properties.
|
||||
|
||||
## Properties
|
||||
|
||||
* **count** `required`
|
||||
* Daily count of a measurement on the given date.
|
||||
* Type: `integer`
|
||||
* Range: ≥ 0
|
||||
* **date** `required`
|
||||
* $ref: [basic.json\#/definitions/date](daily-count.md#basic.jsondefinitionsdate)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/type/dailyCount.json/properties/count">count</b> `required`
|
||||
- Daily count of a measurement on the given date.
|
||||
- Type: `integer`
|
||||
- Range: ≥ 0
|
||||
- <b id="#https://open-metadata.org/schema/type/dailyCount.json/properties/date">date</b> `required`
|
||||
- $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate)
|
||||
|
@ -2,33 +2,33 @@
|
||||
|
||||
This schema defines EntityReference type used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json)
|
||||
<b id="httpsopen-metadata.orgschematypeentityreference.json">$id: https://open-metadata.org/schema/type/entityReference.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/type/entityReference.json/properties/id">id</b> `required`
|
||||
- Unique identifier that identifies an entity instance.
|
||||
- $ref: [basic.json#/definitions/uuid](#basic.jsondefinitionsuuid)
|
||||
- <b id="#https://open-metadata.org/schema/type/entityReference.json/properties/type">type</b> `required`
|
||||
- Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/entityReference.json/properties/name">name</b>
|
||||
- Name of the entity instance. For entities such as tables, database where name is not unique, fullyQualifiedName is returned in this field.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/entityReference.json/properties/description">description</b>
|
||||
- Optional description of entity.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/entityReference.json/properties/href">href</b>
|
||||
- Link to the entity resource.
|
||||
- $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref)
|
||||
|
||||
* **id** `required`
|
||||
* Unique identifier that identifies an entity instance.
|
||||
* $ref: [basic.json\#/definitions/uuid](entity-reference.md#basic.jsondefinitionsuuid)
|
||||
* **type** `required`
|
||||
* Entity type/class name - Examples: `database`, `table`, `metrics`, `redshift`, `mysql`, `bigquery`, `snowflake`...
|
||||
* Type: `string`
|
||||
* **name**
|
||||
* Name of the entity instance.
|
||||
* Type: `string`
|
||||
* **description**
|
||||
* Optional description of entity.
|
||||
* Type: `string`
|
||||
* **href**
|
||||
* Link to the entity resource.
|
||||
* $ref: [basic.json\#/definitions/href](entity-reference.md#basic.jsondefinitionshref)
|
||||
|
||||
## Types definitions in this schema
|
||||
|
||||
**entityReferenceList**
|
||||
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [entityReference.json](entity-reference.md#entityreference.json)
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [entityReference.json](#entityreference.json)
|
||||
|
||||
|
||||
|
@ -1,19 +1,17 @@
|
||||
# Entity Usage
|
||||
# Usage details of an entity
|
||||
|
||||
This schema defines the type used for capturing usage details of an entity.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json)
|
||||
<b id="httpsopen-metadata.orgschematypeentityusage.json">$id: https://open-metadata.org/schema/type/entityUsage.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **entity** `required`
|
||||
* Entity for which usage is returned.
|
||||
* $ref: [entityReference.json](entity-usage.md#entityreference.json)
|
||||
* **usage** `required`
|
||||
* List usage details per day.
|
||||
* Type: `array`
|
||||
* **Items**
|
||||
* $ref: [usageDetails.json](entity-usage.md#usagedetails.json)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/type/entityUsage.json/properties/entity">entity</b> `required`
|
||||
- Entity for which usage is returned.
|
||||
- $ref: [entityReference.json](#entityreference.json)
|
||||
- <b id="#https://open-metadata.org/schema/type/entityUsage.json/properties/usage">usage</b> `required`
|
||||
- List usage details per day.
|
||||
- Type: `array`
|
||||
- **Items**
|
||||
- $ref: [usageDetails.json](#usagedetails.json)
|
||||
|
@ -1,47 +1,49 @@
|
||||
# Jdbc Connection
|
||||
# JDBC connection
|
||||
|
||||
JDBC connection information
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json)
|
||||
<b id="httpsopen-metadata.orgschematypejdbcconnection.json">$id: https://open-metadata.org/schema/type/jdbcConnection.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/properties/driverClass">driverClass</b> `required`
|
||||
- JDBC driver class
|
||||
- $ref: [#/definitions/driverClass](#/definitions/driverClass)
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/properties/connectionUrl">connectionUrl</b> `required`
|
||||
- JDBC connection URL
|
||||
- $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl)
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/properties/userName">userName</b> `required`
|
||||
- Login user name.
|
||||
- Type: `string`
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/properties/password">password</b> `required`
|
||||
- Login password.
|
||||
- Type: `string`
|
||||
|
||||
* **driverClass** `required`
|
||||
* JDBC driver class
|
||||
* $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass)
|
||||
* **connectionUrl** `required`
|
||||
* JDBC connection URL
|
||||
* $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl)
|
||||
* **userName** `required`
|
||||
* Login user name.
|
||||
* Type: `string`
|
||||
* **password** `required`
|
||||
* Login password.
|
||||
* Type: `string`
|
||||
|
||||
## Types 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
|
||||
* Type: `string`
|
||||
* String format must be a "uri"
|
||||
- Type used for JDBC connection URL
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
**jdbcInfo**
|
||||
|
||||
* Type for capturing JDBC connector information
|
||||
* Type: `object`
|
||||
* **Properties**
|
||||
* **driverClass** `required`
|
||||
* $ref: [\#/definitions/driverClass](jdbc-connection.md#/definitions/driverClass)
|
||||
* Default: _"com.amazon.redshift.jdbc42.Driver"_
|
||||
* **connectionUrl** `required`
|
||||
* $ref: [\#/definitions/connectionUrl](jdbc-connection.md#/definitions/connectionUrl)
|
||||
- Type for capturing JDBC connector information
|
||||
- Type: `object`
|
||||
- **Properties**
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/definitions/jdbcInfo/properties/driverClass">driverClass</b> `required`
|
||||
- $ref: [#/definitions/driverClass](#/definitions/driverClass)
|
||||
- Default: _"com.amazon.redshift.jdbc42.Driver"_
|
||||
- <b id="#https://open-metadata.org/schema/type/jdbcConnection.json/definitions/jdbcInfo/properties/connectionUrl">connectionUrl</b> `required`
|
||||
- $ref: [#/definitions/connectionUrl](#/definitions/connectionUrl)
|
||||
|
||||
|
||||
|
@ -2,41 +2,41 @@
|
||||
|
||||
This schema defines the type for profile of a user, team, or an organization.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json)
|
||||
<b id="httpsopen-metadata.orgschematypeprofile.json">$id: https://open-metadata.org/schema/type/profile.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/properties/images">images</b>
|
||||
- $ref: [#/definitions/imageList](#/definitions/imageList)
|
||||
|
||||
* **images**
|
||||
* $ref: [\#/definitions/imageList](profile.md#/definitions/imageList)
|
||||
|
||||
## Types 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**
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image">image</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image24">image24</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image32">image32</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image48">image48</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image72">image72</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image192">image192</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
- <b id="#https://open-metadata.org/schema/type/profile.json/definitions/imageList/properties/image512">image512</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
|
@ -1,17 +1,15 @@
|
||||
# Schedule
|
||||
# Type used for schedule with start time and repeat frequency
|
||||
|
||||
This schema defines the type used for schedule. Schedule has a start time and repeat frequency.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json)
|
||||
<b id="httpsopen-metadata.orgschematypeschedule.json">$id: https://open-metadata.org/schema/type/schedule.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **startDate**
|
||||
* Start date and time of the schedule.
|
||||
* $ref: [basic.json\#/definitions/dateTime](schedule.md#basic.jsondefinitionsdatetime)
|
||||
* **repeatFrequency**
|
||||
* Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'
|
||||
* $ref: [basic.json\#/definitions/duration](schedule.md#basic.jsondefinitionsduration)
|
||||
|
||||
- <b id="#https://open-metadata.org/schema/type/schedule.json/properties/startDate">startDate</b>
|
||||
- Start date and time of the schedule.
|
||||
- $ref: [basic.json#/definitions/dateTime](#basic.jsondefinitionsdatetime)
|
||||
- <b id="#https://open-metadata.org/schema/type/schedule.json/properties/repeatFrequency">repeatFrequency</b>
|
||||
- Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'
|
||||
- $ref: [basic.json#/definitions/duration](#basic.jsondefinitionsduration)
|
||||
|
@ -2,32 +2,30 @@
|
||||
|
||||
This schema defines the type for labeling an entity with a Tag.
|
||||
|
||||
**$id:** [**https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json)
|
||||
<b id="httpsopen-metadata.orgschematypetaglabel.json">$id: https://open-metadata.org/schema/type/tagLabel.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
|
||||
* **tagFQN**
|
||||
* Type: `string`
|
||||
* Length: ≤ 45
|
||||
* **labelType**
|
||||
* Label type describe how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using 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:
|
||||
- <b id="#https://open-metadata.org/schema/type/tagLabel.json/properties/tagFQN">tagFQN</b>
|
||||
- Type: `string`
|
||||
- Length: ≤ 45
|
||||
- <b id="#https://open-metadata.org/schema/type/tagLabel.json/properties/labelType">labelType</b>
|
||||
- Label type describe how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using 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"_
|
||||
- <b id="#https://open-metadata.org/schema/type/tagLabel.json/properties/state">state</b>
|
||||
- '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](tag-label.md#basic.jsondefinitionshref)
|
||||
|
||||
- Default: _"Confirmed"_
|
||||
- <b id="#https://open-metadata.org/schema/type/tagLabel.json/properties/href">href</b>
|
||||
- Link to the tag resource.
|
||||
- $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref)
|
||||
|
@ -1,40 +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://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json**](https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json)
|
||||
<b id="httpsopen-metadata.orgschematypeusagedetails.json">$id: https://open-metadata.org/schema/type/usageDetails.json</b>
|
||||
|
||||
Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/properties/dailyStats">dailyStats</b> `required`
|
||||
- Daily usage stats of a data asset on the start date.
|
||||
- $ref: [#/definitions/usageStats](#/definitions/usageStats)
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/properties/weeklyStats">weeklyStats</b>
|
||||
- Weekly (last 7 days) rolling usage stats of a data asset on the start date.
|
||||
- $ref: [#/definitions/usageStats](#/definitions/usageStats)
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/properties/monthlyStats">monthlyStats</b>
|
||||
- Monthly (last 30 days) rolling usage stats of a data asset on the start date.
|
||||
- $ref: [#/definitions/usageStats](#/definitions/usageStats)
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/properties/date">date</b> `required`
|
||||
- Date in UTC.
|
||||
- $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate)
|
||||
|
||||
* **dailyStats** `required`
|
||||
* Daily usage stats of a data asset on the start date.
|
||||
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats)
|
||||
* **weeklyStats**
|
||||
* Weekly \(last 7 days\) rolling usage stats of a data asset on the start date.
|
||||
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats)
|
||||
* **monthlyStats**
|
||||
* Monthly \(last 30 days\) rolling usage stats of a data asset on the start date.
|
||||
* $ref: [\#/definitions/usageStats](usage-details.md#/definitions/usageStats)
|
||||
* **date** `required`
|
||||
* Date in UTC.
|
||||
* $ref: [basic.json\#/definitions/date](usage-details.md#basic.jsondefinitionsdate)
|
||||
|
||||
## Types 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**
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/definitions/usageStats/properties/count">count</b> `required`
|
||||
- Usage count of a data asset on the start date.
|
||||
- Type: `integer`
|
||||
- Range: ≥ 0
|
||||
- <b id="#https://open-metadata.org/schema/type/usageDetails.json/definitions/usageStats/properties/percentileRank">percentileRank</b>
|
||||
- Optional daily percentile rank data asset use when relevant.
|
||||
- Type: `number`
|
||||
- Range: between 0 and 100
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user