diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createChart.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createChart.ts index ff469a29850..d60068c2bd6 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createChart.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createChart.ts @@ -89,6 +89,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDashboard.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDashboard.ts index 27e221c0607..0140067abba 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDashboard.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDashboard.ts @@ -70,6 +70,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDatabase.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDatabase.ts index 7744c21f423..69b46d3ab04 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDatabase.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createDatabase.ts @@ -53,6 +53,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createModel.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createModel.ts index 40c9333bb90..514a7b4bbb1 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createModel.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createModel.ts @@ -66,6 +66,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createPipeline.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createPipeline.ts index 2acf076480e..f12034d37f5 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createPipeline.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createPipeline.ts @@ -82,6 +82,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTable.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTable.ts index 149dbec1b2f..92db53bad4c 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTable.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTable.ts @@ -221,6 +221,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTask.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTask.ts index 0f5f60cd58a..22921d450b9 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTask.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTask.ts @@ -86,6 +86,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTopic.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTopic.ts index 445f8114659..4b9637c26e7 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTopic.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/data/createTopic.ts @@ -104,6 +104,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/lineage/addLineage.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/lineage/addLineage.ts index b54757d7862..74ad4e710f5 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/lineage/addLineage.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/lineage/addLineage.ts @@ -62,6 +62,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/api/teams/createUser.ts b/catalog-rest-service/src/main/resources/ui/src/generated/api/teams/createUser.ts index a0882dbe680..73d7c427ba8 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/api/teams/createUser.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/api/teams/createUser.ts @@ -20,13 +20,17 @@ * Request to create User entity */ export interface CreateUser { + /** + * Used for user biography. + */ + description?: string; /** * Name used for display purposes. Example 'FirstName LastName' */ displayName?: string; email: string; /** - * When true indicates user is an adiministrator for the sytem with superuser privileges + * When true indicates user is an administrator for the system with superuser privileges */ isAdmin?: boolean; /** diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/bots.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/bots.ts index 04f9a0e96dc..cd393f6e4a9 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/bots.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/bots.ts @@ -21,6 +21,10 @@ * identifying the importance of data. It runs as a special user in the system. */ export interface Bots { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of the bot. */ @@ -41,4 +45,37 @@ export interface Bots { * Name of the bot. */ name?: string; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/chart.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/chart.ts index 68ce7d63710..12c18505340 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/chart.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/chart.ts @@ -21,6 +21,10 @@ * analyzing the data. Charts can be part of Dashboard. */ export interface Chart { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; chartType?: ChartType; /** * Chart URL, pointing to its own Service URL. @@ -71,10 +75,43 @@ export interface Chart { * Tags for this chart. */ tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this database. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -110,6 +147,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/dashboard.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/dashboard.ts index eaa95c0391f..40c63fc4742 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/dashboard.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/dashboard.ts @@ -22,6 +22,10 @@ * exploration. */ export interface Dashboard { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * All the charts included in this Dashboard. */ @@ -71,10 +75,43 @@ export interface Dashboard { * Tags for this dashboard. */ tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this database. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -94,6 +131,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/database.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/database.ts index 48b86dca437..81d29295a3a 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/database.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/database.ts @@ -21,10 +21,18 @@ * is a collection of tables. */ export interface Database { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of the database instance. */ description?: string; + /** + * Display Name that identifies this database. + */ + displayName?: string; /** * Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. */ @@ -53,10 +61,43 @@ export interface Database { * References to tables in the database. */ tables?: EntityReference[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this database. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -76,6 +117,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/metrics.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/metrics.ts index c3ecd1db5d7..f36f3f8d0d4 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/metrics.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/metrics.ts @@ -23,10 +23,18 @@ * `User Retention`. */ export interface Metrics { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of metrics instance, what it is, and how to use it. */ description?: string; + /** + * Display Name that identifies this metric. + */ + displayName?: string; /** * A unique name that identifies a metric in the format 'ServiceName.MetricName'. */ @@ -51,10 +59,47 @@ export interface Metrics { * Link to service where this metrics is hosted in. */ service: EntityReference; + /** + * Tags for this chart. + */ + tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this database. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -72,6 +117,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ @@ -92,6 +141,53 @@ export interface EntityReference { type: string; } +/** + * This schema defines the type for labeling an entity with a Tag. + */ +export interface TagLabel { + /** + * Link to the tag resource. + */ + href?: string; + /** + * 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. + */ + labelType?: LabelType; + /** + * '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'. + */ + state?: State; + tagFQN?: string; +} + +/** + * 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. + */ +export enum LabelType { + Automated = 'Automated', + Derived = 'Derived', + Manual = 'Manual', + Propagated = 'Propagated', +} + +/** + * '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'. + */ +export enum State { + Confirmed = 'Confirmed', + Suggested = 'Suggested', +} + /** * Latest usage information for this database. * diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/model.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/model.ts index 595f0e95e8d..31d7d27e79c 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/model.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/model.ts @@ -25,6 +25,10 @@ export interface Model { * Algorithm used to train the model. */ algorithm: string; + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Performance Dashboard URL to track metric evolution. */ @@ -65,10 +69,43 @@ export interface Model { * Tags for this model. */ tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this model. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -88,6 +125,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/pipeline.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/pipeline.ts index 180b4eafe95..877ba7c2e3b 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/pipeline.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/pipeline.ts @@ -22,6 +22,10 @@ * series of steps Extract, Transform and Load the data. */ export interface Pipeline { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Concurrency of the Pipeline. */ @@ -83,6 +87,39 @@ export interface Pipeline { * All the tasks that are part of pipeline. */ tasks?: EntityReference[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -102,6 +139,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/report.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/report.ts index 185480e9183..4951689c49a 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/report.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/report.ts @@ -21,10 +21,19 @@ * periodically that includes data in text, table, and visual form. */ export interface Report { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of this report instance. */ description?: string; + /** + * Display Name that identifies this report. It could be title or label from the source + * services. + */ + displayName?: string; /** * A unique name that identifies a report in the format 'ServiceName.ReportName'. */ @@ -49,10 +58,43 @@ export interface Report { * Link to service where this report is hosted in. */ service: EntityReference; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this database. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -70,6 +112,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/table.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/table.ts index 029ba714949..36741263d4a 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/table.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/table.ts @@ -22,6 +22,10 @@ * Table and Schema are captured in this entity. */ export interface Table { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Columns in this table. */ @@ -34,6 +38,11 @@ export interface Table { * Description of a table. */ description?: string; + /** + * Display Name that identifies this table. It could be title or label from the source + * services. + */ + displayName?: string; /** * Followers of this table. */ @@ -79,16 +88,49 @@ export interface Table { * Tags for this table. */ tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Latest usage information for this table. */ usageSummary?: TypeUsedToReturnUsageDetailsOfAnEntity; + /** + * Metadata version of the entity. + */ + version?: number; /** * View Definition in SQL. Applies to TableType.View only. */ viewDefinition?: string; } +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; +} + /** * This schema defines the type for a column in a table. */ @@ -261,6 +303,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/task.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/task.ts index d86d656fca2..e7291b21873 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/task.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/task.ts @@ -20,6 +20,10 @@ * This schema defines the Task entity. A task is a unit of computation in a Pipeline. */ export interface Task { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of this Task. */ @@ -82,6 +86,39 @@ export interface Task { * Task URL to visit/manage. This URL points to respective pipeline service UI. */ taskUrl?: string; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -99,6 +136,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/topic.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/topic.ts index a569f76de70..bf2ccb7f0e7 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/topic.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/data/topic.ts @@ -21,6 +21,10 @@ * to by publishers and read from by consumers in a messaging service. */ export interface Topic { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Topic clean up policies. For Kafka - `cleanup.policy` configuration. */ @@ -29,6 +33,11 @@ export interface Topic { * Description of the topic instance. */ description?: string; + /** + * Display Name that identifies this topic. It could be title or label from the source + * services. + */ + displayName?: string; /** * Followers of this table. */ @@ -96,6 +105,39 @@ export interface Topic { * Tags for this table. */ tags?: TagLabel[]; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -123,6 +165,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/dashboardService.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/dashboardService.ts index faca632966d..4af15ebd1e0 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/dashboardService.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/dashboardService.ts @@ -20,6 +20,10 @@ * This schema defines the Dashboard Service entity, such as Looker and Superset. */ export interface DashboardService { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Dashboard Service URL. This will be used to make REST API calls to Dashboard Service. */ @@ -28,6 +32,10 @@ export interface DashboardService { * Description of a dashboard service instance. */ description?: string; + /** + * Display Name that identifies this dashboard service. + */ + displayName?: string; /** * Link to the resource corresponding to this dashboard service. */ @@ -52,10 +60,43 @@ export interface DashboardService { * Type of dashboard service such as Looker or Superset... */ serviceType: DashboardServiceType; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Username to log-into Dashboard Service. */ username?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/databaseService.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/databaseService.ts index 885d2ac921f..2b1de0bcf91 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/databaseService.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/databaseService.ts @@ -22,10 +22,18 @@ * instance are also used for database service. */ export interface DatabaseService { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of a database service instance. */ description?: string; + /** + * Display Name that identifies this database service. + */ + displayName?: string; /** * Link to the resource corresponding to this database service. */ @@ -50,6 +58,39 @@ export interface DatabaseService { * Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... */ serviceType: DatabaseServiceType; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/messagingService.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/messagingService.ts index 5840ac2899a..06f0042d171 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/messagingService.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/messagingService.ts @@ -24,10 +24,19 @@ export interface MessagingService { * Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar. */ brokers: string[]; + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of a messaging service instance. */ description?: string; + /** + * Display Name that identifies this messaging service. It could be title or label from the + * source services. + */ + displayName?: string; /** * Link to the resource corresponding to this messaging service. */ @@ -52,6 +61,39 @@ export interface MessagingService { * Type of messaging service such as Kafka or Pulsar... */ serviceType: MessagingServiceType; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/pipelineService.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/pipelineService.ts index d7715d72479..e00741c4921 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/pipelineService.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/services/pipelineService.ts @@ -20,10 +20,19 @@ * This schema defines the Pipeline Service entity, such as Airflow and Prefect. */ export interface PipelineService { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Description of a pipeline service instance. */ description?: string; + /** + * Display Name that identifies this pipeline service. It could be title or label from the + * source services. + */ + displayName?: string; /** * Link to the resource corresponding to this pipeline service. */ @@ -48,6 +57,39 @@ export interface PipelineService { * Type of pipeline service such as Airflow or Prefect... */ serviceType?: PipelineServiceType; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/tags/tagCategory.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/tags/tagCategory.ts index 9a8cf0facff..90d5914148f 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/tags/tagCategory.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/tags/tagCategory.ts @@ -23,6 +23,10 @@ */ export interface TagCategory { categoryType: TagCategoryType; + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * Tags under this category. */ @@ -33,15 +37,31 @@ export interface TagCategory { * Description of the tag category. */ description: string; + /** + * Display Name that identifies this tag category. + */ + displayName?: string; /** * Link to the resource corresponding to the tag category. */ href?: string; name: string; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Count of how many times the tags from this tag category are used. */ usageCount?: number; + /** + * Metadata version of the entity. + */ + version?: number; } /** @@ -52,6 +72,27 @@ export enum TagCategoryType { Descriptive = 'Descriptive', } +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; +} + export interface TagClass { /** * Fully qualified names of tags associated with this tag. Associated tags captures @@ -87,8 +128,20 @@ export interface TagClass { * Name of the tag. */ name: string; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Count of how many times this tag and children tags are used. */ usageCount?: number; + /** + * Metadata version of the entity. + */ + version?: number; } diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/team.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/team.ts index 363cb3b4dfc..b77ab8518f0 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/team.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/team.ts @@ -21,6 +21,10 @@ * own zero or more data assets. */ export interface Team { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * When true the team has been deleted. */ @@ -47,10 +51,43 @@ export interface Team { * Team profile information. */ profile?: Profile; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; /** * Users that are part of the team. */ users?: EntityReference[]; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -66,6 +103,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/user.ts b/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/user.ts index a6fceeb8bbf..a7503fc5570 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/user.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/entity/teams/user.ts @@ -22,11 +22,19 @@ * data assets. A user can also follow zero or more data assets. */ export interface User { + /** + * Change that lead to this version of the entity. + */ + changeDescription?: ChangeDescription; /** * When true indicates the user has been deactivated. Users are deactivated instead of * deleted. */ deactivated?: boolean; + /** + * Used for user biography. + */ + description?: string; /** * Name used for display purposes. Example 'FirstName LastName'. */ @@ -72,6 +80,39 @@ export interface User { * Timezone of the user. */ timezone?: string; + /** + * Last update time corresponding to the new version of the entity. + */ + updatedAt?: Date; + /** + * User who made the update. + */ + updatedBy?: string; + /** + * Metadata version of the entity. + */ + version?: number; +} + +/** + * Change that lead to this version of the entity. + * + * Description of the change. + */ +export interface ChangeDescription { + /** + * Fields added during the version changes. + */ + fieldsAdded?: string[]; + /** + * Fields deleted during the version changes. + */ + fieldsDeleted?: string[]; + /** + * Fields modified during the version changes. + */ + fieldsUpdated?: string[]; + previousVersion?: number; } /** @@ -87,6 +128,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityHistory.ts b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityHistory.ts new file mode 100644 index 00000000000..9cfb7980446 --- /dev/null +++ b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityHistory.ts @@ -0,0 +1,29 @@ +/* eslint-disable @typescript-eslint/no-explicit-any */ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * This schema defines the type used for capturing version of history of entity. + */ +export interface EntityHistory { + /** + * Entity type, such as `database`, `table`, `dashboard`, for which this version history is + * produced. + */ + entityType: string; + versions: any[]; +} diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityLineage.ts b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityLineage.ts index 0605011a8a2..e3b02c0bcce 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityLineage.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityLineage.ts @@ -57,6 +57,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityReference.ts b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityReference.ts index 16510fa463f..c3f3cda8214 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityReference.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityReference.ts @@ -27,6 +27,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */ diff --git a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityUsage.ts b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityUsage.ts index cd866a237cc..7cbc2650796 100644 --- a/catalog-rest-service/src/main/resources/ui/src/generated/type/entityUsage.ts +++ b/catalog-rest-service/src/main/resources/ui/src/generated/type/entityUsage.ts @@ -43,6 +43,10 @@ export interface EntityReference { * Optional description of entity. */ description?: string; + /** + * Display Name that identifies this entity. + */ + displayName?: string; /** * Link to the entity resource. */