From 6f60a019fe85eb1cff71287879d734f2fca91b77 Mon Sep 17 00:00:00 2001 From: Suresh Srinivas Date: Sat, 21 May 2022 21:56:12 -0700 Subject: [PATCH] Fixes #4664 - Introduce a type for markdown text (#4666) --- .../main/resources/json/schema/api/data/createChart.json | 2 +- .../resources/json/schema/api/data/createDashboard.json | 2 +- .../resources/json/schema/api/data/createDatabase.json | 2 +- .../json/schema/api/data/createDatabaseSchema.json | 2 +- .../resources/json/schema/api/data/createGlossary.json | 2 +- .../json/schema/api/data/createGlossaryTerm.json | 2 +- .../resources/json/schema/api/data/createLocation.json | 2 +- .../resources/json/schema/api/data/createMlModel.json | 2 +- .../resources/json/schema/api/data/createPipeline.json | 2 +- .../main/resources/json/schema/api/data/createTable.json | 2 +- .../main/resources/json/schema/api/data/createTopic.json | 2 +- .../resources/json/schema/api/events/createWebhook.json | 2 +- .../resources/json/schema/api/lineage/addLineage.json | 2 +- .../resources/json/schema/api/policies/createPolicy.json | 2 +- .../json/schema/api/services/createDashboardService.json | 2 +- .../json/schema/api/services/createDatabaseService.json | 2 +- .../json/schema/api/services/createMessagingService.json | 2 +- .../json/schema/api/services/createPipelineService.json | 2 +- .../json/schema/api/services/createStorageService.json | 2 +- .../ingestionPipelines/createIngestionPipeline.json | 2 +- .../main/resources/json/schema/api/tags/createTag.json | 2 +- .../resources/json/schema/api/tags/createTagCategory.json | 2 +- .../main/resources/json/schema/api/teams/createRole.json | 2 +- .../main/resources/json/schema/api/teams/createTeam.json | 2 +- .../main/resources/json/schema/api/teams/createUser.json | 2 +- .../resources/json/schema/api/tests/createColumnTest.json | 2 +- .../json/schema/api/tests/createCustomMetric.json | 2 +- .../resources/json/schema/api/tests/createTableTest.json | 2 +- .../src/main/resources/json/schema/entity/bot.json | 2 +- .../src/main/resources/json/schema/entity/data/chart.json | 2 +- .../main/resources/json/schema/entity/data/dashboard.json | 2 +- .../main/resources/json/schema/entity/data/database.json | 2 +- .../resources/json/schema/entity/data/databaseSchema.json | 2 +- .../main/resources/json/schema/entity/data/glossary.json | 2 +- .../resources/json/schema/entity/data/glossaryTerm.json | 2 +- .../main/resources/json/schema/entity/data/location.json | 2 +- .../main/resources/json/schema/entity/data/metrics.json | 2 +- .../main/resources/json/schema/entity/data/mlmodel.json | 8 ++++---- .../main/resources/json/schema/entity/data/pipeline.json | 4 ++-- .../main/resources/json/schema/entity/data/report.json | 2 +- .../src/main/resources/json/schema/entity/data/table.json | 6 +++--- .../src/main/resources/json/schema/entity/data/topic.json | 2 +- .../main/resources/json/schema/entity/events/webhook.json | 2 +- .../resources/json/schema/entity/policies/policy.json | 2 +- .../json/schema/entity/services/dashboardService.json | 2 +- .../json/schema/entity/services/databaseService.json | 2 +- .../services/ingestionPipelines/ingestionPipeline.json | 2 +- .../json/schema/entity/services/messagingService.json | 2 +- .../json/schema/entity/services/metadataService.json | 2 +- .../json/schema/entity/services/pipelineService.json | 2 +- .../json/schema/entity/services/storageService.json | 2 +- .../resources/json/schema/entity/tags/tagCategory.json | 4 ++-- .../src/main/resources/json/schema/entity/teams/role.json | 2 +- .../src/main/resources/json/schema/entity/teams/team.json | 2 +- .../src/main/resources/json/schema/entity/teams/user.json | 2 +- .../src/main/resources/json/schema/tests/columnTest.json | 2 +- .../main/resources/json/schema/tests/customMetric.json | 2 +- .../src/main/resources/json/schema/tests/tableTest.json | 2 +- .../main/resources/json/schema/type/entityLineage.json | 4 ++-- .../main/resources/json/schema/type/entityReference.json | 2 +- .../src/main/resources/json/schema/type/tagLabel.json | 2 +- .../catalog/resources/EntityResourceTest.java | 2 +- 62 files changed, 70 insertions(+), 70 deletions(-) diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createChart.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createChart.json index 284c75da7fc..daf86c0f730 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createChart.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createChart.json @@ -17,7 +17,7 @@ }, "description": { "description": "Description of the chart instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "chartType": { "$ref": "../../entity/data/chart.json#/definitions/chartType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createDashboard.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createDashboard.json index 07c9a4fd09d..e27c4495db3 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createDashboard.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createDashboard.json @@ -17,7 +17,7 @@ }, "description": { "description": "Description of the database instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "dashboardUrl": { "description": "Dashboard URL", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabase.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabase.json index 62664caa99f..bb42d4574bb 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabase.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabase.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the database instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "owner": { "description": "Owner of this database", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabaseSchema.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabaseSchema.json index c0637c078b5..b34c8d2c724 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabaseSchema.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createDatabaseSchema.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the schema instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "owner": { "description": "Owner of this schema", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossary.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossary.json index 9d72b80ba1c..4b7dc54d72a 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossary.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossary.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the glossary instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "reviewers": { "description": "User references of the reviewers for this glossary.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossaryTerm.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossaryTerm.json index d68c8ca1605..04148622284 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossaryTerm.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createGlossaryTerm.json @@ -26,7 +26,7 @@ }, "description": { "description": "Description of the glossary term.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "synonyms": { "description": "Alternate names that are synonyms or near-synonyms for the glossary term.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createLocation.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createLocation.json index 1f47ac8888a..b028d05c388 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createLocation.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createLocation.json @@ -22,7 +22,7 @@ }, "description": { "description": "Description of the location instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "locationType": { "$ref": "../../entity/data/location.json#/definitions/locationType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createMlModel.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createMlModel.json index bd0b59a2f20..2870a70521b 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createMlModel.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createMlModel.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the ML model instance. How it was trained and for what it is used.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "algorithm": { "description": "Algorithm used to train the ML Model", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createPipeline.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createPipeline.json index f2a205df058..e64979eae83 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createPipeline.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createPipeline.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the pipeline instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "pipelineUrl": { "description": "Pipeline URL to visit/manage. This URL points to respective pipeline service UI", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json index 4c97ab13a43..0af58784fa4 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createTable.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of entity instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "tableType": { "$ref": "../../entity/data/table.json#/definitions/tableType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/data/createTopic.json b/catalog-rest-service/src/main/resources/json/schema/api/data/createTopic.json index f715cc2c8ed..dd38a1b17c2 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/data/createTopic.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/data/createTopic.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the topic instance. What it has and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "service": { "description": "Link to the messaging service where this topic is hosted in", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/events/createWebhook.json b/catalog-rest-service/src/main/resources/json/schema/api/events/createWebhook.json index d7a173af689..35ed4efb7d9 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/events/createWebhook.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/events/createWebhook.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of the application", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "endpoint": { "description": "Endpoint to receive the webhook events over POST requests.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/lineage/addLineage.json b/catalog-rest-service/src/main/resources/json/schema/api/lineage/addLineage.json index d785aab2f1c..d25695b5900 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/lineage/addLineage.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/lineage/addLineage.json @@ -7,7 +7,7 @@ "properties": { "description": { "description": "User provided description of the lineage details.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "edge": { "description": "Lineage edge details.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/policies/createPolicy.json b/catalog-rest-service/src/main/resources/json/schema/api/policies/createPolicy.json index b6475326ba3..8dabdcb9b7d 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/policies/createPolicy.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/policies/createPolicy.json @@ -18,7 +18,7 @@ }, "description": { "description": "A short description of the Policy, comprehensible to regular users.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "owner": { "description": "Owner of this Policy.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/createDashboardService.json b/catalog-rest-service/src/main/resources/json/schema/api/services/createDashboardService.json index f86fcf3fdee..59adaea9428 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/createDashboardService.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/createDashboardService.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of dashboard service entity.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "serviceType": { "$ref": "../../entity/services/dashboardService.json#/definitions/dashboardServiceType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/createDatabaseService.json b/catalog-rest-service/src/main/resources/json/schema/api/services/createDatabaseService.json index 19715d2dec2..6ef99437700 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/createDatabaseService.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/createDatabaseService.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of Database entity.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "serviceType": { "$ref": "../../entity/services/databaseService.json#/definitions/databaseServiceType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/createMessagingService.json b/catalog-rest-service/src/main/resources/json/schema/api/services/createMessagingService.json index 0917122dde0..98e6d03e66b 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/createMessagingService.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/createMessagingService.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of messaging service entity.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "serviceType": { "$ref": "../../entity/services/messagingService.json#/definitions/messagingServiceType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/createPipelineService.json b/catalog-rest-service/src/main/resources/json/schema/api/services/createPipelineService.json index 73ccefbacb6..895e0fad57a 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/createPipelineService.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/createPipelineService.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of pipeline service entity.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "serviceType": { "$ref": "../../entity/services/pipelineService.json#/definitions/pipelineServiceType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/createStorageService.json b/catalog-rest-service/src/main/resources/json/schema/api/services/createStorageService.json index 4ca04de42a0..f2504bfa44d 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/createStorageService.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/createStorageService.json @@ -18,7 +18,7 @@ }, "description": { "description": "Description of Storage entity.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "serviceType": { "$ref": "../../type/storage.json#/definitions/storageServiceType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/services/ingestionPipelines/createIngestionPipeline.json b/catalog-rest-service/src/main/resources/json/schema/api/services/ingestionPipelines/createIngestionPipeline.json index 839ed746734..e54894602c0 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/services/ingestionPipelines/createIngestionPipeline.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/services/ingestionPipelines/createIngestionPipeline.json @@ -17,7 +17,7 @@ }, "description": { "description": "Description of the pipeline.", - "type": "string" + "$ref": "../../../type/basic.json#/definitions/markdown" }, "pipelineType": { "$ref": "../../../entity/services/ingestionPipelines/ingestionPipeline.json#/definitions/pipelineType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/tags/createTag.json b/catalog-rest-service/src/main/resources/json/schema/api/tags/createTag.json index f0dda780dd9..986e64b02b4 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/tags/createTag.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/tags/createTag.json @@ -17,7 +17,7 @@ }, "description": { "description": "Unique name of the tag category", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "associatedTags": { "description": "Fully qualified names of tags associated with this tag", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/tags/createTagCategory.json b/catalog-rest-service/src/main/resources/json/schema/api/tags/createTagCategory.json index 0cedff6c17c..33b283e1288 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/tags/createTagCategory.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/tags/createTagCategory.json @@ -17,7 +17,7 @@ }, "description": { "description": "Description of the tag category", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "categoryType": { "$ref": "../../entity/tags/tagCategory.json#/definitions/tagCategoryType" diff --git a/catalog-rest-service/src/main/resources/json/schema/api/teams/createRole.json b/catalog-rest-service/src/main/resources/json/schema/api/teams/createRole.json index 1ad3fcd777c..6e16cbe3703 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/teams/createRole.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/teams/createRole.json @@ -17,7 +17,7 @@ }, "description": { "description": "Optional description of the role", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "policies": { "description": "Policies that is attached to this role. At least one policy is required.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/teams/createTeam.json b/catalog-rest-service/src/main/resources/json/schema/api/teams/createTeam.json index 7ea739bb0b4..a64c6f033a2 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/teams/createTeam.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/teams/createTeam.json @@ -17,7 +17,7 @@ }, "description": { "description": "Optional description of the team.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "profile": { "description": "Optional team profile information.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json b/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json index 07d68807b57..f5ffad32895 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/teams/createUser.json @@ -13,7 +13,7 @@ }, "description": { "description": "Used for user biography.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "displayName": { "description": "Name used for display purposes. Example 'FirstName LastName'", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/tests/createColumnTest.json b/catalog-rest-service/src/main/resources/json/schema/api/tests/createColumnTest.json index 057078c5608..df5c8dc5937 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/tests/createColumnTest.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/tests/createColumnTest.json @@ -7,7 +7,7 @@ "properties": { "description": { "description": "Description of the testcase.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "columnName": { "description": "Name of the column in a table.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/tests/createCustomMetric.json b/catalog-rest-service/src/main/resources/json/schema/api/tests/createCustomMetric.json index 6b79263ede4..a28e89b8f92 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/tests/createCustomMetric.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/tests/createCustomMetric.json @@ -7,7 +7,7 @@ "properties": { "description": { "description": "Description of the custom metric.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "name": { "description": "Name that identifies this Custom Metric.", diff --git a/catalog-rest-service/src/main/resources/json/schema/api/tests/createTableTest.json b/catalog-rest-service/src/main/resources/json/schema/api/tests/createTableTest.json index d636a5a97db..c3048219726 100644 --- a/catalog-rest-service/src/main/resources/json/schema/api/tests/createTableTest.json +++ b/catalog-rest-service/src/main/resources/json/schema/api/tests/createTableTest.json @@ -7,7 +7,7 @@ "properties": { "description": { "description": "Description of the testcase.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "testCase": { "$ref": "../../tests/tableTest.json#/definitions/tableTestCase" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/bot.json b/catalog-rest-service/src/main/resources/json/schema/entity/bot.json index 51a5706e5d9..4cb712aa182 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/bot.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/bot.json @@ -26,7 +26,7 @@ }, "description": { "description": "Description of the bot.", - "type": "string" + "$ref": "../type/basic.json#/definitions/markdown" }, "botUser" : { "description": "Bot user created for this bot on behalf of which the bot performs all the operations, such as updating description, responding on the conversation threads, etc.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/chart.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/chart.json index 4e341a226cd..f9bc4edd03f 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/chart.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/chart.json @@ -76,7 +76,7 @@ }, "description": { "description": "Description of the dashboard, what it is, and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json index d03e1e67efb..de952ccc7d2 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of the dashboard, what it is, and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json index 132b4bbf079..5c945928ced 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of the database instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/databaseSchema.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/databaseSchema.json index 02e9b452e3d..4eab0a3813c 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/databaseSchema.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/databaseSchema.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of the schema instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossary.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossary.json index c4789ace05d..9b32b8f8fe0 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossary.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossary.json @@ -32,7 +32,7 @@ }, "description": { "description": "Description of the glossary.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json index 0db381dd8a3..4113e026488 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/glossaryTerm.json @@ -47,7 +47,7 @@ }, "description": { "description": "Description of the glossary term.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "fullyQualifiedName": { "description": "A unique name that identifies a glossary term. It captures name hierarchy of glossary of terms in the form of `glossaryName.parentTerm.childTerm`.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/location.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/location.json index bd8f6880d1b..847769f845a 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/location.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/location.json @@ -54,7 +54,7 @@ }, "description": { "description": "Description of a location.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json index 92850c2c432..c5f94dc9c7b 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of metrics instance, what it is, and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json index c2707ade963..ab6d8e55f85 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/mlmodel.json @@ -51,7 +51,7 @@ }, "description": { "description": "Description of the feature source.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "fullyQualifiedName": { "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName" @@ -85,7 +85,7 @@ }, "description": { "description": "Description of the ML Feature.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "fullyQualifiedName": { "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName" @@ -128,7 +128,7 @@ }, "description": { "description": "Description of the Hyper Parameter.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" } } }, @@ -168,7 +168,7 @@ }, "description": { "description": "Description of the ML Model, what it is, and how to use it.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "algorithm": { "description": "Algorithm used to train the ML Model.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json index b372871c38b..40ed35ec91b 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json @@ -58,7 +58,7 @@ }, "description": { "description": "Description of this Task.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "taskUrl": { "description": "Task URL to visit/manage. This URL points to respective pipeline service UI.", @@ -144,7 +144,7 @@ }, "description": { "description": "Description of this Pipeline.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json index c014a25a4c0..382dc2b7ab5 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of this report instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json index 56c2f67c3c8..9925c1af011 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json @@ -190,7 +190,7 @@ }, "description": { "description": "Description of the column.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "fullyQualifiedName": { "$ref": "#/definitions/fullyQualifiedColumnName" @@ -531,7 +531,7 @@ }, "description": { "description": "Description of the Table from the model.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "path": { "description": "Path to sql definition file.", @@ -587,7 +587,7 @@ }, "description": { "description": "Description of a table.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json index 071c351ec2c..34ed95670ca 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json @@ -71,7 +71,7 @@ }, "description": { "description": "Description of the topic instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json b/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json index 29324c26d2f..754e45173b4 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json @@ -25,7 +25,7 @@ }, "description": { "description": "Description of the application.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "endpoint": { "description": "Endpoint to receive the webhook events over POST requests.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/policies/policy.json b/catalog-rest-service/src/main/resources/json/schema/entity/policies/policy.json index c5c696ad5db..73c49c87087 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/policies/policy.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/policies/policy.json @@ -55,7 +55,7 @@ }, "description": { "description": "A short description of the Policy, comprehensible to regular users.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "owner": { "description": "Owner of this Policy.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/dashboardService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/dashboardService.json index 666f615bd29..b129946e9c9 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/dashboardService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/dashboardService.json @@ -93,7 +93,7 @@ }, "description": { "description": "Description of a dashboard service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "connection": { "$ref": "#/definitions/dashboardConnection" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json index 34bb4542f01..44d0d5eac2d 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json @@ -232,7 +232,7 @@ }, "description": { "description": "Description of a database service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "connection": { "$ref": "#/definitions/databaseConnection" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/ingestionPipelines/ingestionPipeline.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/ingestionPipelines/ingestionPipeline.json index 21d9cd326ea..3d19ff89c4a 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/ingestionPipelines/ingestionPipeline.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/ingestionPipelines/ingestionPipeline.json @@ -133,7 +133,7 @@ }, "description": { "description": "Description of the Pipeline.", - "type": "string" + "$ref": "../../../type/basic.json#/definitions/markdown" }, "pipelineType": { "$ref": "#/definitions/pipelineType" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json index 69ed82b1e5e..d3d08f2bbcc 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json @@ -66,7 +66,7 @@ }, "description": { "description": "Description of a messaging service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "displayName": { "description": "Display Name that identifies this messaging service. It could be title or label from the source services.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/metadataService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/metadataService.json index eba9f9aed87..dfff3a257c6 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/metadataService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/metadataService.json @@ -65,7 +65,7 @@ }, "description": { "description": "Description of a database service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "connection": { "$ref": "#/definitions/metadataConnection" diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/pipelineService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/pipelineService.json index 47932b6137d..0ccf25c63a0 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/pipelineService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/pipelineService.json @@ -47,7 +47,7 @@ }, "description": { "description": "Description of a pipeline service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "displayName": { "description": "Display Name that identifies this pipeline service. It could be title or label from the source services.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/services/storageService.json b/catalog-rest-service/src/main/resources/json/schema/entity/services/storageService.json index 4679f700946..93d4d455698 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/services/storageService.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/services/storageService.json @@ -29,7 +29,7 @@ }, "description": { "description": "Description of a storage service instance.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json b/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json index 4dbea4e38fd..0208de8e1af 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json @@ -50,7 +50,7 @@ }, "description": { "description": "Unique name of the tag category.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", @@ -116,7 +116,7 @@ }, "description": { "description": "Description of the tag category.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/teams/role.json b/catalog-rest-service/src/main/resources/json/schema/entity/teams/role.json index 31e98afb9fa..7e5df8e6008 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/teams/role.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/teams/role.json @@ -29,7 +29,7 @@ }, "description": { "description": "Description of the role.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json b/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json index 21f587cec6f..242f23154e9 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json @@ -24,7 +24,7 @@ }, "description": { "description": "Description of the team.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "version": { "description": "Metadata version of the entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json b/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json index 835ddcec614..11575884489 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json @@ -43,7 +43,7 @@ }, "description": { "description": "Used for user biography.", - "type": "string" + "$ref": "../../type/basic.json#/definitions/markdown" }, "displayName": { "description": "Name used for display purposes. Example 'FirstName LastName'.", diff --git a/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json b/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json index 65c34ef57fa..cea7fe45bdc 100644 --- a/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json +++ b/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json @@ -62,7 +62,7 @@ }, "description": { "description": "Description of the testcase.", - "type": "string" + "$ref": "../type/basic.json#/definitions/markdown" }, "columnName": { "description": "Name of the column in a table.", diff --git a/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json b/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json index 12b2cbf68e5..a823ad19e44 100644 --- a/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json +++ b/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json @@ -16,7 +16,7 @@ }, "description": { "description": "Description of the Metric.", - "type": "string" + "$ref": "../type/basic.json#/definitions/markdown" }, "columnName": { "description": "Name of the column in a table.", diff --git a/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json b/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json index 92a51c03b36..669857281e6 100644 --- a/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json +++ b/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json @@ -46,7 +46,7 @@ }, "description": { "description": "Description of the testcase.", - "type": "string" + "$ref": "../type/basic.json#/definitions/markdown" }, "testCase": { "$ref": "#/definitions/tableTestCase" diff --git a/catalog-rest-service/src/main/resources/json/schema/type/entityLineage.json b/catalog-rest-service/src/main/resources/json/schema/type/entityLineage.json index ecf8c6fcc2c..89e41a1dece 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/entityLineage.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/entityLineage.json @@ -20,7 +20,7 @@ "$ref": "basic.json#/definitions/uuid" }, "description": { - "type": "string" + "$ref": "basic.json#/definitions/markdown" } }, "additionalProperties": false @@ -39,7 +39,7 @@ "$ref": "entityReference.json" }, "description": { - "type": "string" + "$ref": "basic.json#/definitions/markdown" } }, "additionalProperties": false diff --git a/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json b/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json index 8a490259402..1bfa2d638c8 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json @@ -33,7 +33,7 @@ }, "description": { "description": "Optional description of entity.", - "type": "string" + "$ref": "basic.json#/definitions/markdown" }, "displayName": { "description": "Display Name that identifies this entity.", diff --git a/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json b/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json index 0c079aa16ff..6140f86f843 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json @@ -17,7 +17,7 @@ }, "description": { "description": "Unique name of the tag category.", - "type": "string" + "$ref": "../type/basic.json#/definitions/markdown" }, "source": { "description": "Label is from Tags or Glossary.", diff --git a/catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/EntityResourceTest.java b/catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/EntityResourceTest.java index d7d1f8a456b..69562e30963 100644 --- a/catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/EntityResourceTest.java +++ b/catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/EntityResourceTest.java @@ -1167,7 +1167,7 @@ public abstract class EntityResourceTest createEntity(createRequest(test, 1).withExtension(jsonNode), ADMIN_AUTH_HEADERS),