docs: Generate Types from Json Schema. (#971)

This commit is contained in:
Sachin Chaurasiya 2021-10-28 15:32:37 +05:30 committed by GitHub
parent d59d45550e
commit b4fc16f2e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
32 changed files with 908 additions and 1 deletions

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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;
/**

View File

@ -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;
}

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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;
}
/**

View File

@ -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;
}
/**

View File

@ -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;
}
/**

View File

@ -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;
}
/**

View File

@ -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;
}

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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[];
}

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/