yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-30 01:23:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Governance Workflow jsonschemas (#19779)

Browse Source 
Co-authored-by: Karan Hotchandani <33024356+karanh37@users.noreply.github.com>
This commit is contained in:
IceS2 2025-02-18 14:29:45 +01:00 committed by GitHub
parent fce358eaa2
commit 7d1ab75bc9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 76 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.json
View File

@ -18,21 +18,27 @@
"default": "checkEntityAttributesTask"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
},
"config": {
"title": "Node Configuration",
"type": "object",
"properties": {
"rules": {
"title": "Rules to Check",
"description": "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.",
"type": "string",
"outputType": "jsonlogic",
"format": "queryBuilder"

6
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.json
View File

@ -25,9 +25,12 @@
]
},
"certificationConfiguration": {
"title": "Node Configuration",
"type": "object",
"properties": {
"certification": {
"title": "Certification",
"description": "Choose which Certification to apply to the Data Asset",
"$ref": "#/definitions/certificationEnum"
}
},
@ -45,14 +48,17 @@
"default": "setEntityCertificationTask"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
},

8
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.json
View File

@ -18,25 +18,31 @@
"default": "setGlossaryTermStatusTask"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
},
"config": {
"title": "Node Configuration",
"type": "object",
"properties": {
"glossaryTermStatus": {
"title": "Glossary Term Status",
"description": "Choose which Status to apply to the Glossary Term",
"$ref": "../../../../../entity/data/glossaryTerm.json#/definitions/status"
}
},
"required": [],
"required": ["glossaryTermStatus"],
"additionalProperties": false
},
"input": {

3
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/endEvent/endEvent.json
View File

@ -18,14 +18,17 @@
"default": "endEvent"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
}

3
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/startEvent/startEvent.json
View File

@ -18,14 +18,17 @@
"default": "startEvent"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
}

5
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/userTask/userApprovalTask.json
View File

@ -18,21 +18,26 @@
"default": "userApprovalTask"
},
"name": {
"title": "Name",
"description": "Name that identifies this Node.",
"$ref": "../../../../../type/basic.json#/definitions/entityName"
},
"displayName": {
"title": "Display Name",
"description": "Display Name that identifies this Node.",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description of the Node.",
"$ref": "../../../../../type/basic.json#/definitions/markdown"
},
"config": {
"title": "Node Configuration",
"type": "object",
"properties": {
"assignees": {
"title": "Assignees",
"description": "People/Teams assigned to the Task.",
"type": "object",
"properties": {

6
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/eventBasedEntityTrigger.json
View File

@ -18,6 +18,7 @@
]
},
"config": {
"title": "Trigger Configuration",
"description": "Entity Event Trigger Configuration.",
"type": "object",
"properties": {
@ -26,6 +27,8 @@
"type": "string"
},
"events": {
"title": "Events",
"descriptions": "Select the events that should trigger this workflow",
"type": "array",
"items": {
"$ref": "#/definitions/event"
@ -33,7 +36,8 @@
"uniqueItems": true
},
"exclude": {
"description": "Exclude events that only modify given attributes.",
"title": "Exclude Fields",
"description": "Select fields that should not trigger the workflow if only them are modified.",
"type": "array",
"items": {
"type": "string"

6
openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json
View File

@ -10,6 +10,7 @@
"type": "object",
"definitions": {
"config": {
"title": "Trigger Configuration",
"description": "Entity Event Trigger Configuration.",
"type": "object",
"properties": {
@ -18,14 +19,17 @@
"description": "Defines the schedule of the Periodic Trigger."
},
"entityType": {
"title": "Entity Type",
"description": "Entity Type for which it should be triggered.",
"type": "string"
},
"filters": {
"description": "Search Filters to filter down the entities fetched.",
"title": "Filters",
"description": "Select the Search Filters to filter down the entities fetched.",
"type": "string"
},
"batchSize": {
"title": "Batch Size",
"description": "Number of Entities to process at once.",
"type": "integer",
"default": 500

9
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.ts
View File

@ -15,7 +15,7 @@
*/
export interface CheckEntityAttributesTask {
branches?: string[];
config?: Config;
config?: NodeConfiguration;
/**
* Description of the Node.
*/
@ -35,7 +35,12 @@ export interface CheckEntityAttributesTask {
[property: string]: any;
}
export interface Config {
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;
}

10
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.ts
View File

@ -14,7 +14,7 @@
* Sets the Entity Certification to the configured value.
*/
export interface SetEntityCertificationTask {
config?: CertificationConfiguration;
config?: NodeConfiguration;
/**
* Description of the Node.
*/
@ -34,10 +34,16 @@ export interface SetEntityCertificationTask {
[property: string]: any;
}
export interface CertificationConfiguration {
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",

12
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.ts
View File

@ -14,7 +14,7 @@
* Sets the GlossaryTerm Status to the configured value.
*/
export interface SetGlossaryTermStatusTask {
config?: Config;
config?: NodeConfiguration;
/**
* Description of the Node.
*/
@ -34,10 +34,16 @@ export interface SetGlossaryTermStatusTask {
[property: string]: any;
}
export interface Config {
glossaryTermStatus?: Status;
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",

6
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/endEvent/endEvent.ts
View File

@ -1,5 +1,5 @@
/*
* Copyright 2024 Collate.
* 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
@ -10,9 +10,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
/**
* EndEvent.
*/
export interface EndEvent {

6
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/startEvent/startEvent.ts
View File

@ -1,5 +1,5 @@
/*
* Copyright 2024 Collate.
* 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
@ -10,9 +10,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
/**
* StartEvent.
*/
export interface StartEvent {

4
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/userTask/userApprovalTask.ts
View File

@ -15,7 +15,7 @@
*/
export interface UserApprovalTask {
branches?: string[];
config?: Config;
config?: NodeConfiguration;
/**
* Description of the Node.
*/
@ -36,7 +36,7 @@ export interface UserApprovalTask {
[property: string]: any;
}
export interface Config {
export interface NodeConfiguration {
/**
* People/Teams assigned to the Task.
*/

6
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/eventBasedEntityTrigger.ts
View File

@ -14,7 +14,7 @@
* Event Based Entity Trigger.
*/
export interface EventBasedEntityTrigger {
config?: Config;
config?: TriggerConfiguration;
output?: string[];
type?: string;
}
@ -22,14 +22,14 @@ export interface EventBasedEntityTrigger {
/**
* Entity Event Trigger Configuration.
*/
export interface Config {
export interface TriggerConfiguration {
/**
* Entity Type for which it should be triggered.
*/
entityType: string;
events: Event[];
/**
* Exclude events that only modify given attributes.
* Select fields that should not trigger the workflow if only them are modified.
*/
exclude?: string[];
}

6
openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/periodicBatchEntityTrigger.ts
View File

@ -14,7 +14,7 @@
* Periodic Batch Entity Trigger.
*/
export interface PeriodicBatchEntityTrigger {
config?: Config;
config?: TriggerConfiguration;
output?: string[];
type?: string;
}
@ -22,7 +22,7 @@ export interface PeriodicBatchEntityTrigger {
/**
* Entity Event Trigger Configuration.
*/
export interface Config {
export interface TriggerConfiguration {
/**
* Number of Entities to process at once.
*/
@ -32,7 +32,7 @@ export interface Config {
*/
entityType: string;
/**
* Search Filters to filter down the entities fetched.
* Select the Search Filters to filter down the entities fetched.
*/
filters: string;
/**