mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-17 10:35:08 +00:00
Update generated TypeScript types
This commit is contained in:
parent
666b666d63
commit
c7cdabadb9
@ -1,370 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright 2025 Collate.
|
|
||||||
* Licensed 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.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* Create Workflow Definition entity request
|
|
||||||
*/
|
|
||||||
export interface CreateWorkflowDefinition {
|
|
||||||
/**
|
|
||||||
* Configuration for the Workflow Definition
|
|
||||||
*/
|
|
||||||
config?: WorkflowConfiguration;
|
|
||||||
/**
|
|
||||||
* Description of the Workflow Definition. What it has and how to use it.
|
|
||||||
*/
|
|
||||||
description: string;
|
|
||||||
/**
|
|
||||||
* Display Name that identifies this Workflow Definition.
|
|
||||||
*/
|
|
||||||
displayName?: string;
|
|
||||||
/**
|
|
||||||
* List of edges that connect the workflow elements and guide its flow.
|
|
||||||
*/
|
|
||||||
edges?: EdgeDefinition[];
|
|
||||||
/**
|
|
||||||
* Name that identifies this Workflow Definition.
|
|
||||||
*/
|
|
||||||
name: string;
|
|
||||||
/**
|
|
||||||
* List of processes used on the workflow.
|
|
||||||
*/
|
|
||||||
nodes?: Definition[];
|
|
||||||
/**
|
|
||||||
* Owners of this API Collection
|
|
||||||
*/
|
|
||||||
owners?: EntityReference[];
|
|
||||||
trigger?: EntityTriggerDefinition;
|
|
||||||
type?: Type;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configuration for the Workflow Definition
|
|
||||||
*/
|
|
||||||
export interface WorkflowConfiguration {
|
|
||||||
/**
|
|
||||||
* If True, all the stage status will be stored in the database.
|
|
||||||
*/
|
|
||||||
storeStageStatus: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Governance Workflow Edge.
|
|
||||||
*/
|
|
||||||
export interface EdgeDefinition {
|
|
||||||
/**
|
|
||||||
* Defines if the edge will follow a path depending on the source node result.
|
|
||||||
*/
|
|
||||||
condition?: string;
|
|
||||||
/**
|
|
||||||
* Element from which the edge will start.
|
|
||||||
*/
|
|
||||||
from: string;
|
|
||||||
/**
|
|
||||||
* Element on which the edge will end.
|
|
||||||
*/
|
|
||||||
to: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if an Entity attributes fit given rules.
|
|
||||||
*
|
|
||||||
* Sets any Entity attribute field to the configured value.
|
|
||||||
*
|
|
||||||
* Sets the GlossaryTerm Status to the configured value.
|
|
||||||
*
|
|
||||||
* Sets the Entity Certification to the configured value.
|
|
||||||
*
|
|
||||||
* EndEvent.
|
|
||||||
*
|
|
||||||
* StartEvent.
|
|
||||||
*
|
|
||||||
* Defines a Task for a given User to approve.
|
|
||||||
*/
|
|
||||||
export interface Definition {
|
|
||||||
branches?: string[];
|
|
||||||
config?: NodeConfiguration;
|
|
||||||
/**
|
|
||||||
* Description of the Node.
|
|
||||||
*/
|
|
||||||
description?: string;
|
|
||||||
/**
|
|
||||||
* Display Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
displayName?: string;
|
|
||||||
input?: string[];
|
|
||||||
inputNamespaceMap?: InputNamespaceMap;
|
|
||||||
/**
|
|
||||||
* Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
name?: string;
|
|
||||||
subType?: string;
|
|
||||||
type?: string;
|
|
||||||
output?: string[];
|
|
||||||
[property: string]: any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface NodeConfiguration {
|
|
||||||
/**
|
|
||||||
* Define certain set of rules that you would like to check. If all the rules apply, this
|
|
||||||
* will be set as 'True' and will continue through the positive flow. Otherwise it will be
|
|
||||||
* set to 'False' and continue through the negative flow.
|
|
||||||
*/
|
|
||||||
rules?: string;
|
|
||||||
/**
|
|
||||||
* Entity field name to set (e.g., 'status', 'description', 'displayName')
|
|
||||||
*/
|
|
||||||
fieldName?: string;
|
|
||||||
/**
|
|
||||||
* Value to set for the field
|
|
||||||
*/
|
|
||||||
fieldValue?: string;
|
|
||||||
/**
|
|
||||||
* Choose which Status to apply to the Glossary Term
|
|
||||||
*/
|
|
||||||
glossaryTermStatus?: Status;
|
|
||||||
/**
|
|
||||||
* Choose which Certification to apply to the Data Asset
|
|
||||||
*/
|
|
||||||
certification?: CertificationEnum;
|
|
||||||
/**
|
|
||||||
* Number of reviewers that must approve for the task to be completed. Default is 1 (any
|
|
||||||
* single reviewer can approve).
|
|
||||||
*/
|
|
||||||
approvalThreshold?: number;
|
|
||||||
/**
|
|
||||||
* People/Teams assigned to the Task.
|
|
||||||
*/
|
|
||||||
assignees?: Assignees;
|
|
||||||
/**
|
|
||||||
* Number of reviewers that must reject for the task to be rejected. Default is 1 (any
|
|
||||||
* single reviewer can reject). This allows for scenarios where you want multiple approvals
|
|
||||||
* but a single rejection can veto.
|
|
||||||
*/
|
|
||||||
rejectionThreshold?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* People/Teams assigned to the Task.
|
|
||||||
*/
|
|
||||||
export interface Assignees {
|
|
||||||
/**
|
|
||||||
* Add the Reviewers to the assignees List.
|
|
||||||
*/
|
|
||||||
addReviewers?: boolean;
|
|
||||||
/**
|
|
||||||
* Additional assignees with optional users and teams.
|
|
||||||
*/
|
|
||||||
extraAssignees?: ExtraAssignees;
|
|
||||||
/**
|
|
||||||
* List of team names to assign the task to.
|
|
||||||
*/
|
|
||||||
teams?: string[];
|
|
||||||
/**
|
|
||||||
* List of user names to assign the task to.
|
|
||||||
*/
|
|
||||||
users?: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Additional assignees with optional users and teams.
|
|
||||||
*/
|
|
||||||
export interface ExtraAssignees {
|
|
||||||
/**
|
|
||||||
* List of additional team names to assign the task to.
|
|
||||||
*/
|
|
||||||
teams?: string[];
|
|
||||||
/**
|
|
||||||
* List of additional user names to assign the task to.
|
|
||||||
*/
|
|
||||||
users?: string[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Choose which Certification to apply to the Data Asset
|
|
||||||
*/
|
|
||||||
export enum CertificationEnum {
|
|
||||||
CertificationBronze = "Certification.Bronze",
|
|
||||||
CertificationGold = "Certification.Gold",
|
|
||||||
CertificationSilver = "Certification.Silver",
|
|
||||||
Empty = "",
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Choose which Status to apply to the Glossary Term
|
|
||||||
*/
|
|
||||||
export enum Status {
|
|
||||||
Approved = "Approved",
|
|
||||||
Deprecated = "Deprecated",
|
|
||||||
Draft = "Draft",
|
|
||||||
InReview = "In Review",
|
|
||||||
Rejected = "Rejected",
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface InputNamespaceMap {
|
|
||||||
relatedEntity: string;
|
|
||||||
updatedBy?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Owners of this API Collection
|
|
||||||
*
|
|
||||||
* This schema defines the EntityReferenceList type used for referencing an entity.
|
|
||||||
* EntityReference is used for capturing relationships from one entity to another. For
|
|
||||||
* example, a table has an attribute called database of type EntityReference that captures
|
|
||||||
* the relationship of a table `belongs to a` database.
|
|
||||||
*
|
|
||||||
* This schema defines the EntityReference type used for referencing an entity.
|
|
||||||
* EntityReference is used for capturing relationships from one entity to another. For
|
|
||||||
* example, a table has an attribute called database of type EntityReference that captures
|
|
||||||
* the relationship of a table `belongs to a` database.
|
|
||||||
*/
|
|
||||||
export interface EntityReference {
|
|
||||||
/**
|
|
||||||
* If true the entity referred to has been soft-deleted.
|
|
||||||
*/
|
|
||||||
deleted?: boolean;
|
|
||||||
/**
|
|
||||||
* Optional description of entity.
|
|
||||||
*/
|
|
||||||
description?: string;
|
|
||||||
/**
|
|
||||||
* Display Name that identifies this entity.
|
|
||||||
*/
|
|
||||||
displayName?: string;
|
|
||||||
/**
|
|
||||||
* Fully qualified name of the entity instance. For entities such as tables, databases
|
|
||||||
* fullyQualifiedName is returned in this field. For entities that don't have name hierarchy
|
|
||||||
* such as `user` and `team` this will be same as the `name` field.
|
|
||||||
*/
|
|
||||||
fullyQualifiedName?: string;
|
|
||||||
/**
|
|
||||||
* Link to the entity resource.
|
|
||||||
*/
|
|
||||||
href?: string;
|
|
||||||
/**
|
|
||||||
* Unique identifier that identifies an entity instance.
|
|
||||||
*/
|
|
||||||
id: string;
|
|
||||||
/**
|
|
||||||
* If true the relationship indicated by this entity reference is inherited from the parent
|
|
||||||
* entity.
|
|
||||||
*/
|
|
||||||
inherited?: boolean;
|
|
||||||
/**
|
|
||||||
* Name of the entity instance.
|
|
||||||
*/
|
|
||||||
name?: string;
|
|
||||||
/**
|
|
||||||
* Entity type/class name - Examples: `database`, `table`, `metrics`, `databaseService`,
|
|
||||||
* `dashboardService`...
|
|
||||||
*/
|
|
||||||
type: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Event Based Entity Trigger.
|
|
||||||
*
|
|
||||||
* Periodic Batch Entity Trigger.
|
|
||||||
*/
|
|
||||||
export interface EntityTriggerDefinition {
|
|
||||||
config?: TriggerConfiguration;
|
|
||||||
output?: string[];
|
|
||||||
type?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Entity Event Trigger Configuration.
|
|
||||||
*/
|
|
||||||
export interface TriggerConfiguration {
|
|
||||||
/**
|
|
||||||
* Deprecated: Single entity type for which workflow should be triggered. Use 'entityTypes'
|
|
||||||
* for multiple types.
|
|
||||||
*/
|
|
||||||
entityType?: string;
|
|
||||||
/**
|
|
||||||
* Array of Entity Types for which this workflow should be triggered. Supports multiple
|
|
||||||
* entity types in one workflow.
|
|
||||||
*/
|
|
||||||
entityTypes?: string[];
|
|
||||||
/**
|
|
||||||
* Select the events that should trigger this workflow
|
|
||||||
*/
|
|
||||||
events?: Event[];
|
|
||||||
/**
|
|
||||||
* Select fields that should not trigger the workflow if only them are modified.
|
|
||||||
*/
|
|
||||||
exclude?: string[];
|
|
||||||
/**
|
|
||||||
* JSON Logic expression to determine if the workflow should be triggered. The expression
|
|
||||||
* has access to: entity (current entity), changeDescription (what changed), updatedBy (user
|
|
||||||
* who made the change), changedFields (array of field names that changed).
|
|
||||||
*/
|
|
||||||
filter?: string;
|
|
||||||
/**
|
|
||||||
* Number of Entities to process at once.
|
|
||||||
*/
|
|
||||||
batchSize?: number;
|
|
||||||
/**
|
|
||||||
* Search filters for entities. Can be a string (applied to all entity types) or an object
|
|
||||||
* mapping entity types to their specific filters.
|
|
||||||
*/
|
|
||||||
filters?: FiltersObject | string;
|
|
||||||
/**
|
|
||||||
* Defines the schedule of the Periodic Trigger.
|
|
||||||
*/
|
|
||||||
schedule?: any[] | boolean | AppScheduleClass | number | number | null | string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Event for which it should be triggered.
|
|
||||||
*/
|
|
||||||
export enum Event {
|
|
||||||
Created = "Created",
|
|
||||||
Updated = "Updated",
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Entity-specific filters with optional default
|
|
||||||
*/
|
|
||||||
export interface FiltersObject {
|
|
||||||
/**
|
|
||||||
* Default filter for entity types not explicitly configured
|
|
||||||
*/
|
|
||||||
default?: string;
|
|
||||||
[property: string]: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface AppScheduleClass {
|
|
||||||
/**
|
|
||||||
* Cron Expression in case of Custom scheduled Trigger
|
|
||||||
*/
|
|
||||||
cronExpression?: string;
|
|
||||||
scheduleTimeline: ScheduleTimeline;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This schema defines the Application ScheduleTimeline Options
|
|
||||||
*/
|
|
||||||
export enum ScheduleTimeline {
|
|
||||||
Custom = "Custom",
|
|
||||||
Daily = "Daily",
|
|
||||||
Hourly = "Hourly",
|
|
||||||
Monthly = "Monthly",
|
|
||||||
None = "None",
|
|
||||||
Weekly = "Weekly",
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum Type {
|
|
||||||
EventBasedEntity = "eventBasedEntity",
|
|
||||||
NoOp = "noOp",
|
|
||||||
PeriodicBatchEntity = "periodicBatchEntity",
|
|
||||||
}
|
|
||||||
@ -23,8 +23,6 @@ export enum NodeSubType {
|
|||||||
RollbackEntityTask = "rollbackEntityTask",
|
RollbackEntityTask = "rollbackEntityTask",
|
||||||
RunAppTask = "runAppTask",
|
RunAppTask = "runAppTask",
|
||||||
SetEntityAttributeTask = "setEntityAttributeTask",
|
SetEntityAttributeTask = "setEntityAttributeTask",
|
||||||
SetEntityCertificationTask = "setEntityCertificationTask",
|
|
||||||
SetGlossaryTermStatusTask = "setGlossaryTermStatusTask",
|
|
||||||
StartEvent = "startEvent",
|
StartEvent = "startEvent",
|
||||||
UserApprovalTask = "userApprovalTask",
|
UserApprovalTask = "userApprovalTask",
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,57 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright 2025 Collate.
|
|
||||||
* Licensed 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.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* Sets the Entity Certification to the configured value.
|
|
||||||
*/
|
|
||||||
export interface SetEntityCertificationTask {
|
|
||||||
config?: NodeConfiguration;
|
|
||||||
/**
|
|
||||||
* Description of the Node.
|
|
||||||
*/
|
|
||||||
description?: string;
|
|
||||||
/**
|
|
||||||
* Display Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
displayName?: string;
|
|
||||||
input?: string[];
|
|
||||||
inputNamespaceMap?: InputNamespaceMap;
|
|
||||||
/**
|
|
||||||
* Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
name?: string;
|
|
||||||
subType?: string;
|
|
||||||
type?: string;
|
|
||||||
[property: string]: any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface NodeConfiguration {
|
|
||||||
/**
|
|
||||||
* Choose which Certification to apply to the Data Asset
|
|
||||||
*/
|
|
||||||
certification: CertificationEnum;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Choose which Certification to apply to the Data Asset
|
|
||||||
*/
|
|
||||||
export enum CertificationEnum {
|
|
||||||
CertificationBronze = "Certification.Bronze",
|
|
||||||
CertificationGold = "Certification.Gold",
|
|
||||||
CertificationSilver = "Certification.Silver",
|
|
||||||
Empty = "",
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface InputNamespaceMap {
|
|
||||||
relatedEntity: string;
|
|
||||||
updatedBy?: string;
|
|
||||||
}
|
|
||||||
@ -1,58 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright 2025 Collate.
|
|
||||||
* Licensed 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.
|
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* Sets the GlossaryTerm Status to the configured value.
|
|
||||||
*/
|
|
||||||
export interface SetGlossaryTermStatusTask {
|
|
||||||
config?: NodeConfiguration;
|
|
||||||
/**
|
|
||||||
* Description of the Node.
|
|
||||||
*/
|
|
||||||
description?: string;
|
|
||||||
/**
|
|
||||||
* Display Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
displayName?: string;
|
|
||||||
input?: string[];
|
|
||||||
inputNamespaceMap?: InputNamespaceMap;
|
|
||||||
/**
|
|
||||||
* Name that identifies this Node.
|
|
||||||
*/
|
|
||||||
name?: string;
|
|
||||||
subType?: string;
|
|
||||||
type?: string;
|
|
||||||
[property: string]: any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface NodeConfiguration {
|
|
||||||
/**
|
|
||||||
* Choose which Status to apply to the Glossary Term
|
|
||||||
*/
|
|
||||||
glossaryTermStatus: Status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Choose which Status to apply to the Glossary Term
|
|
||||||
*/
|
|
||||||
export enum Status {
|
|
||||||
Approved = "Approved",
|
|
||||||
Deprecated = "Deprecated",
|
|
||||||
Draft = "Draft",
|
|
||||||
InReview = "In Review",
|
|
||||||
Rejected = "Rejected",
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface InputNamespaceMap {
|
|
||||||
relatedEntity: string;
|
|
||||||
updatedBy?: string;
|
|
||||||
}
|
|
||||||
Loading…
x
Reference in New Issue
Block a user