Fixes #3722 Use entityName type from basic.json for entity names (#3723)

2025-12-02 10:36:29 +00:00 · 2022-03-30 01:40:47 -07:00 · 2022-03-30 01:40:47 -07:00 · 9fb78ed2c1
commit 9fb78ed2c1
parent c22381fdc8
31 changed files with 31 additions and 90 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
@ -7,9 +7,7 @@
  "properties": {
    "name": {
      "description": "Name that identifies this Chart.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Chart. It could be title or label from the source services",
--- 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
@ -7,9 +7,7 @@
  "properties": {
    "name": {
      "description": "Name that identifies this dashboard.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Dashboard. It could be title or label from the source services",
--- 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
@ -7,9 +7,7 @@
  "properties": {
    "name": {
      "description": "Name that identifies this ML model.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this ML model. It could be title or label from the source services",
--- 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
@ -8,9 +8,7 @@
  "properties": {
    "name": {
      "description": "Name that identifies this pipeline instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Pipeline. It could be title or label from the source services.",
--- 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
@ -7,9 +7,7 @@
  "properties": {
    "name": {
      "description": "Unique name of the application receiving webhook events.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the application",
--- a/catalog-rest-service/src/main/resources/json/schema/api/operations/pipelines/createAirflowPipeline.json
+++ b/catalog-rest-service/src/main/resources/json/schema/api/operations/pipelines/createAirflowPipeline.json
@ -7,9 +7,7 @@
  "properties": {
    "name": {
      "description": "Name that identifies this pipeline instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this pipeline.",
--- 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
@ -11,9 +11,7 @@
    },
    "name": {
      "description": "Name that identifies this Custom Metric.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "columnName": {
      "description": "Name of the column in a table.",
--- a/catalog-rest-service/src/main/resources/json/schema/entity/bots.json
+++ b/catalog-rest-service/src/main/resources/json/schema/entity/bots.json
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Name of the bot.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Name used for display purposes. Example 'FirstName LastName'.",
--- 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
@ -62,9 +62,7 @@
    },
    "name": {
      "description": "Name that identifies this Chart.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Chart. It could be title or label from the source services.",
--- 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
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Name that identifies this dashboard.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Dashboard. It could be title or label from the source services.",
--- 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
@ -8,9 +8,7 @@
  "definitions": {
    "databaseName": {
      "description": "Name that identifies the database.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    }
  },
  "properties": {
--- 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
@ -7,9 +7,7 @@
  "definitions": {
    "name": {
      "description": "Name that identifies a glossary term.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    }
  },
  "properties": {
--- 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
@ -7,9 +7,7 @@
  "definitions": {
    "name": {
      "description": "Name that identifies a glossary term.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "termReference": {
      "type": "object",
--- 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
@ -8,9 +8,7 @@
  "definitions": {
    "locationName": {
      "description": "Local name (not fully qualified name) of a location.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "locationType": {
      "javaType": "org.openmetadata.catalog.type.LocationType",
--- 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
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Name that identifies this metrics instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "A unique name that identifies a metric in the format 'ServiceName.MetricName'.",
--- 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
@ -155,9 +155,7 @@
    },
    "name": {
      "description": "Name that identifies this ML Model.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "A unique name that identifies an 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
@ -130,9 +130,7 @@
    },
    "name": {
      "description": "Name that identifies this pipeline instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Pipeline. It could be title or label from the source services.",
--- 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
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Name that identifies this report instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "A unique name that identifies a report in the format 'ServiceName.ReportName'.",
--- 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
@ -118,9 +118,7 @@
    },
    "tableName": {
      "description": "Local name (not fully qualified name) of a table. Dots will be escaped automatically.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedColumnName": {
      "description": "Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName[.nestedColumnName]`. When columnName is null for dataType struct fields, `field_#` where `#` is field index is used. For map dataType, for key the field name `key` is used and for the value field `value` is used.",
--- 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
@ -7,10 +7,7 @@
  "definitions": {
    "topicName": {
      "description": "Name that identifies a topic.",
-      "type": "string",
-      "javaType": "org.openmetadata.catalog.type.topic.TopicName",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "schemaType": {
      "description": "Schema type used for the message.",
--- 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
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Unique name of the application receiving webhook events.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this webhook.",
--- 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
@ -7,9 +7,7 @@
  "definitions": {
    "policyName": {
      "description": "Name that identifies this Policy.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "policyType": {
      "javaType": "org.openmetadata.catalog.type.PolicyType",
--- 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
@ -7,9 +7,7 @@
  "definitions": {
    "roleName": {
      "description": "A unique name for the role.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    }
  },
  "properties": {
--- 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
@ -7,9 +7,7 @@
  "definitions": {
    "teamName": {
      "description": "A unique name of the team typically the team ID from an identity provider. Example - group Id from LDAP.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    }
  },
  "properties": {
--- 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
@ -8,9 +8,7 @@
  "definitions": {
    "userName": {
      "description": "A unique name of the user, typically the user ID from an identity provider. Example - uid from LDAP.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    }
  },

--- a/catalog-rest-service/src/main/resources/json/schema/operations/pipelines/airflowPipeline.json
+++ b/catalog-rest-service/src/main/resources/json/schema/operations/pipelines/airflowPipeline.json
@ -58,9 +58,7 @@
    },
    "name": {
      "description": "Name that identifies this pipeline instance uniquely.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this Pipeline.",
--- a/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json
+++ b/catalog-rest-service/src/main/resources/json/schema/tests/columnTest.json
@ -58,9 +58,7 @@
    },
    "name": {
      "description": "Name that identifies this test case. Name passed by client will be  overridden by  auto generating based on table/column name and test name",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the testcase.",
--- a/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json
+++ b/catalog-rest-service/src/main/resources/json/schema/tests/customMetric.json
@ -12,9 +12,7 @@
    },
    "name": {
      "description": "Name that identifies this Custom Metric.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the Metric.",
--- a/catalog-rest-service/src/main/resources/json/schema/tests/table/tableColumnCountToEqual.json
+++ b/catalog-rest-service/src/main/resources/json/schema/tests/table/tableColumnCountToEqual.json
@ -2,7 +2,7 @@
  "$id": "https://open-metadata.org/schema/tests/tableColumnCountToEqual.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TableColumnCountToEqual",
-  "description": "This scheam defines the test TableColumnCountToEqual. Test the number of columns equal to a value.",
+  "description": "This schema defines the test TableColumnCountToEqual. Test the number of columns equal to a value.",
  "type": "object",
  "javaType": "org.openmetadata.catalog.tests.table.TableColumnCountToEqual",
  "properties": {
--- a/catalog-rest-service/src/main/resources/json/schema/tests/table/tableRowCountToBeBetween.json
+++ b/catalog-rest-service/src/main/resources/json/schema/tests/table/tableRowCountToBeBetween.json
@ -2,7 +2,7 @@
  "$id": "https://open-metadata.org/schema/tests/tableRowCountToBeBetween.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TableRowCountToBeBetween",
-  "description": "This scheam defines the test TableRowCountToBeBetween. Test the number of rows to between to two values.",
+  "description": "This schema defines the test TableRowCountToBeBetween. Test the number of rows to between to two values.",
  "type": "object",
  "javaType": "org.openmetadata.catalog.tests.table.TableRowCountToBeBetween",
  "properties": {
--- a/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json
+++ b/catalog-rest-service/src/main/resources/json/schema/tests/tableTest.json
@ -42,9 +42,7 @@
    },
    "name": {
      "description": "Name that identifies this test case.",
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 128
+      "$ref": "../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the testcase.",