From 7d1ab75bc9272c470fea8d33eea6619f9e700d76 Mon Sep 17 00:00:00 2001 From: IceS2 Date: Tue, 18 Feb 2025 14:29:45 +0100 Subject: [PATCH] Update Governance Workflow jsonschemas (#19779) Co-authored-by: Karan Hotchandani <33024356+karanh37@users.noreply.github.com> --- .../automatedTask/checkEntityAttributesTask.json | 6 ++++++ .../automatedTask/setEntityCertificationTask.json | 6 ++++++ .../automatedTask/setGlossaryTermStatusTask.json | 8 +++++++- .../workflows/elements/nodes/endEvent/endEvent.json | 3 +++ .../elements/nodes/startEvent/startEvent.json | 3 +++ .../elements/nodes/userTask/userApprovalTask.json | 5 +++++ .../elements/triggers/eventBasedEntityTrigger.json | 6 +++++- .../triggers/periodicBatchEntityTrigger.json | 6 +++++- .../nodes/automatedTask/checkEntityAttributesTask.ts | 9 +++++++-- .../automatedTask/setEntityCertificationTask.ts | 10 ++++++++-- .../nodes/automatedTask/setGlossaryTermStatusTask.ts | 12 +++++++++--- .../workflows/elements/nodes/endEvent/endEvent.ts | 6 ++---- .../elements/nodes/startEvent/startEvent.ts | 6 ++---- .../elements/nodes/userTask/userApprovalTask.ts | 4 ++-- .../elements/triggers/eventBasedEntityTrigger.ts | 6 +++--- .../elements/triggers/periodicBatchEntityTrigger.ts | 6 +++--- 16 files changed, 76 insertions(+), 26 deletions(-) diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.json index 89521bf6dcd..a881cc80fa8 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.json @@ -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" diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.json index c5e43fc8815..c01d8763a31 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.json @@ -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" }, diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.json index c83ef1bd447..3b43c13d587 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.json @@ -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": { diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/endEvent/endEvent.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/endEvent/endEvent.json index 88a63306a53..14fdbea15d7 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/endEvent/endEvent.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/endEvent/endEvent.json @@ -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" } diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/startEvent/startEvent.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/startEvent/startEvent.json index 09627f0d3a5..8c366186bd1 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/startEvent/startEvent.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/startEvent/startEvent.json @@ -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" } diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/userTask/userApprovalTask.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/userTask/userApprovalTask.json index 3d834f259dd..3d9d3f5b7df 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/userTask/userApprovalTask.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/nodes/userTask/userApprovalTask.json @@ -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": { diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/eventBasedEntityTrigger.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/eventBasedEntityTrigger.json index 65bf7f099b1..7f0d61bd637 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/eventBasedEntityTrigger.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/eventBasedEntityTrigger.json @@ -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" diff --git a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json index e0817dfc8be..58843c9a431 100644 --- a/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json +++ b/openmetadata-spec/src/main/resources/json/schema/governance/workflows/elements/triggers/periodicBatchEntityTrigger.json @@ -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 diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.ts index c0f6448802f..1c40cb2391f 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/checkEntityAttributesTask.ts @@ -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; } diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.ts index 7fe8f8ce237..19d463e13d5 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setEntityCertificationTask.ts @@ -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", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.ts index 56cd8663a81..cf1ed4d0e15 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/automatedTask/setGlossaryTermStatusTask.ts @@ -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", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/endEvent/endEvent.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/endEvent/endEvent.ts index d8fe36f365d..0872ea8b4bc 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/endEvent/endEvent.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/endEvent/endEvent.ts @@ -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 { diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/startEvent/startEvent.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/startEvent/startEvent.ts index 02f234cf1de..c2948ee0864 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/startEvent/startEvent.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/startEvent/startEvent.ts @@ -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 { diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/userTask/userApprovalTask.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/userTask/userApprovalTask.ts index e4965f7e75b..00da3a2ae12 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/userTask/userApprovalTask.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/nodes/userTask/userApprovalTask.ts @@ -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. */ diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/eventBasedEntityTrigger.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/eventBasedEntityTrigger.ts index bba1461d61e..f6feeca6e7c 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/eventBasedEntityTrigger.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/eventBasedEntityTrigger.ts @@ -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[]; } diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/periodicBatchEntityTrigger.ts b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/periodicBatchEntityTrigger.ts index e538874252f..60f8c7bc1ec 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/periodicBatchEntityTrigger.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/governance/workflows/elements/triggers/periodicBatchEntityTrigger.ts @@ -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; /**