Fixes #4664 - Introduce a type for markdown text (#4666)

2025-11-02 11:39:12 +00:00 · 2022-05-21 21:56:12 -07:00 · 2022-05-21 21:56:12 -07:00 · 6f60a019fe
commit 6f60a019fe
parent ec755f1187
62 changed files with 70 additions and 70 deletions
--- 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"
--- 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",
--- 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",
--- 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",
--- 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.",
--- 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.",
--- 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"
--- 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",
--- 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",
--- 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"
--- 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",
--- 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.",
--- 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.",
--- 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.",
--- 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"
--- 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"
--- 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"
--- 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"
--- 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"
--- 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"
--- 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",
--- 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"
--- 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.",
--- 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.",
--- 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'",
--- 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.",
--- 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.",
--- 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"
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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`.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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"
--- 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"
--- 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"
--- 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.",
--- 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"
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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.",
--- 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'.",
--- 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.",
--- 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.",
--- 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"
--- 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
--- 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.",
--- 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.",
--- 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<T extends EntityInterface, K extends Cr
    K create = createRequest(test).withExtension(jsonNode);
    createAndCheckEntity(create, ADMIN_AUTH_HEADERS);

-    // Now set the entity custom field with an unknown field
+    // Now set the entity custom field with an unknown field name
    jsonNode.set("stringC", mapper.convertValue("string", JsonNode.class)); // Unknown field
    assertResponse(
        () -> createEntity(createRequest(test, 1).withExtension(jsonNode), ADMIN_AUTH_HEADERS),