Code cleanup.20230718 (#12493)

* Move setting common patch and updated fields to EntityRepository * Cleanup entityReferenceList.json and references
2026-01-07 21:16:45 +00:00 · 2023-07-18 15:10:22 -07:00 · 2023-07-18 15:10:22 -07:00 · 35154615d4
commit 35154615d4
parent 159b6a2e4f
32 changed files with 61 additions and 65 deletions
--- a/openmetadata-spec/src/main/resources/json/schema/api/data/createQuery.json
+++ b/openmetadata-spec/src/main/resources/json/schema/api/data/createQuery.json
@ -55,7 +55,7 @@
    },
    "queryUsedIn": {
      "description": "list of entities to which the query is joined.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    }
  },
  "required": ["query"],
--- a/openmetadata-spec/src/main/resources/json/schema/api/feed/createThread.json
+++ b/openmetadata-spec/src/main/resources/json/schema/api/feed/createThread.json
@ -15,7 +15,7 @@
        },
        "assignees": {
          "description": "List of users or teams the task is assigned to",
-          "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+          "$ref": "../../type/entityReferenceList.json"
        },
        "oldValue": {
          "description": "The value of old object for which the task is created.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/classification/tag.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/classification/tag.json
@ -46,7 +46,7 @@
    },
    "children": {
      "description": "Children tags under this tag.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "version": {
      "description": "Metadata version of the entity.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/chart.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/chart.json
@ -107,7 +107,7 @@
    },
    "followers": {
      "description": "Followers of this chart.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this chart.",
@ -145,7 +145,7 @@
    },
    "dataProducts" : {
      "description": "List of of data products this entity is part of.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    }
  },
  "required": ["id", "name", "service"],
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/container.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/container.json
@ -109,7 +109,7 @@
    },
    "children": {
      "description": "References to child containers residing under this entity.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "dataModel": {
      "description": "References to the container's data model, if data is structured, or null otherwise",
@ -145,7 +145,7 @@
    },
    "followers": {
      "description": "Followers of this container.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this container.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/dashboard.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/dashboard.json
@ -73,12 +73,12 @@
    },
    "charts": {
      "description": "All the charts included in this Dashboard.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "dataModels": {
      "description": "List of data models used by this dashboard or the charts contained on it.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "href": {
@ -91,7 +91,7 @@
    },
    "followers": {
      "description": "Followers of this dashboard.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this dashboard.",
@ -133,7 +133,7 @@
    },
    "dataProducts" : {
      "description": "List of of data products this entity is part of.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    }
  },
  "required": ["id", "name", "service"],
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/dashboardDataModel.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/dashboardDataModel.json
@ -104,7 +104,7 @@
    },
    "followers": {
      "description": "Followers of this dashboard.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "service": {
      "description": "Link to service where this data model is hosted in.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/database.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/database.json
@ -84,7 +84,7 @@
    },
    "databaseSchemas": {
      "description": "References to schemas in the database.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/databaseSchema.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/databaseSchema.json
@ -71,7 +71,7 @@
    },
    "tables": {
      "description": "References to tables in the schema.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "usageSummary": {
      "description": "Latest usage information for this database.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/glossaryTerm.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/glossaryTerm.json
@ -66,11 +66,11 @@
    },
    "children": {
      "description": "Other glossary terms that are children of this glossary term.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "relatedTerms": {
      "description": "Other glossary terms that are related to this glossary term.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "references": {
      "description": "Link to a reference from an external glossary.",
@ -97,7 +97,7 @@
    },
    "reviewers": {
      "description": "User names of the reviewers for this glossary.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "owner": {
      "description": "Owner of this glossary term.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/mlmodel.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/mlmodel.json
@ -217,7 +217,7 @@
    },
    "followers": {
      "description": "Followers of this ML Model.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this ML Model.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/pipeline.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/pipeline.json
@ -210,7 +210,7 @@
    },
    "followers": {
      "description": "Followers of this Pipeline.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this Pipeline.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/query.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/query.json
@ -66,7 +66,7 @@
    },
    "followers": {
      "description": "Followers of this Query.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "votes" : {
      "$ref": "../../type/votes.json"
@ -93,7 +93,7 @@
    },
    "queryUsedIn": {
      "description": "Entities that are using this query",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "deleted": {
      "description": "When `true` indicates the entity has been soft deleted.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/table.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/table.json
@ -961,7 +961,7 @@
    },
    "followers": {
      "description": "Followers of this table.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "joins": {
      "description": "Details of other tables this table is frequently joined with.",
@ -1017,7 +1017,7 @@
    },
    "dataProducts" : {
      "description": "List of of data products this entity is part of.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    }
  },
  "required": [
--- a/openmetadata-spec/src/main/resources/json/schema/entity/data/topic.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/data/topic.json
@ -126,7 +126,7 @@
    },
    "followers": {
      "description": "Followers of this table.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "tags": {
      "description": "Tags for this table.",
@ -159,7 +159,7 @@
    },
    "dataProducts" : {
      "description": "List of of data products this entity is part of.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    }
  },
  "required": ["id", "name", "partitions", "service"],
--- a/openmetadata-spec/src/main/resources/json/schema/entity/domains/dataProduct.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/domains/dataProduct.json
@ -49,7 +49,7 @@
    },
    "experts": {
      "description": "List of of users who are experts for this Data Product.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../../type/entityReferenceList.json",
      "default" : null
    },
    "domain": {
--- a/openmetadata-spec/src/main/resources/json/schema/entity/domains/domain.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/domains/domain.json
@ -64,7 +64,7 @@
    },
    "children" : {
      "description" : "Children domains or sub-domains.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "owner": {
      "description": "Owner of this Domain.",
@ -72,7 +72,7 @@
    },
    "experts": {
      "description": "List of of users who are experts in this Domain.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../../type/entityReferenceList.json",
      "default" : null
    },
    "changeDescription": {
--- a/openmetadata-spec/src/main/resources/json/schema/entity/feed/thread.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/feed/thread.json
@ -49,7 +49,7 @@
        },
        "assignees": {
          "description": "List of users or teams the task is assigned to",
-          "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+          "$ref": "../../type/entityReferenceList.json"
        },
        "status": {
          "$ref": "#/definitions/threadTaskStatus"
--- a/openmetadata-spec/src/main/resources/json/schema/entity/policies/policy.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/policies/policy.json
@ -72,11 +72,11 @@
    },
    "teams" : {
      "description": "Teams that use this policy directly and not through roles.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "roles" : {
      "description": "Roles that use this policy.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "location": {
      "description": "Location to which a policy is applied. This field is relevant only for `lifeCycle` policies.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/dashboardService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/dashboardService.json
@ -136,7 +136,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this dashboard service.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "testConnectionResult": {
      "description": "Last test connection results for this service",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json
@ -290,7 +290,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this database service to extract metadata, usage, lineage etc..",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "testConnectionResult": {
      "description": "Last test connection results for this service",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/messagingService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/messagingService.json
@ -97,7 +97,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this messaging service to extract topic configs and schemas.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "testConnectionResult": {
      "description": "Last test connection results for this service",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/metadataService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/metadataService.json
@ -89,7 +89,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this database service to extract metadata, usage, lineage etc..",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "version": {
      "description": "Metadata version of the entity.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/mlmodelService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/mlmodelService.json
@ -98,7 +98,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this pipeline service to extract metadata",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "connection": {
      "$ref": "#/definitions/mlModelConnection"
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/pipelineService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/pipelineService.json
@ -159,7 +159,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this pipeline service to extract metadata",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "connection": {
      "$ref": "#/definitions/pipelineConnection"
--- a/openmetadata-spec/src/main/resources/json/schema/entity/services/storageService.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/storageService.json
@ -79,7 +79,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this storage service to extract metadata, usage, lineage etc..",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "testConnectionResult": {
      "description": "Last test connection results for this service",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/teams/role.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/teams/role.json
@ -66,15 +66,15 @@
    },
    "policies": {
      "description": "Policies that is attached to this role.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "users": {
      "description": "Users that have this role assigned to them.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "teams": {
      "description": "Teams that have this role assigned to them.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "provider" : {
      "$ref": "../../type/basic.json#/definitions/providerType"
--- a/openmetadata-spec/src/main/resources/json/schema/entity/teams/team.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/teams/team.json
@ -70,15 +70,15 @@
    },
    "parents" : {
      "description" : "Parent teams. For an `Organization` the `parent` is always null. A `BusinessUnit` always has only one parent of type `BusinessUnit` or an `Organization`. A `Division` can have multiple parents of type `BusinessUnit` or `Division`. A `Department` can have multiple parents of type `Division` or `Department`.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    },
    "children" : {
      "description" : "Children teams. An `Organization` can have `BusinessUnit`, `Division` or `Department` as children. A `BusinessUnit` can have `BusinessUnit`, `Division`, or `Department` as children. A `Division` can have `Division` or `Department` as children. A `Department` can have can have `Department` as children.",
-      "$ref" : "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref" : "../../type/entityReferenceList.json"
    },
    "users": {
      "description": "Users that are part of the team.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "childrenCount": {
@ -91,7 +91,7 @@
    },
    "owns": {
      "description": "List of entities owned by the team.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "owner": {
      "description": "Owner of this team. ",
@ -114,15 +114,15 @@
    },
    "defaultRoles": {
      "description": "Default roles of a team. These roles will be inherited by all the users that are part of this team.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "inheritedRoles": {
      "description": "Roles that a team is inheriting through membership in teams that have set team default roles.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "policies": {
      "description": "Policies that is attached to this team.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "domain" : {
      "description": "Domain the Team belongs to.",
--- a/openmetadata-spec/src/main/resources/json/schema/entity/teams/user.json
+++ b/openmetadata-spec/src/main/resources/json/schema/entity/teams/user.json
@ -102,15 +102,15 @@
    },
    "teams": {
      "description": "Teams that the user belongs to.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "owns": {
      "description": "List of entities owned by the user.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "follows": {
      "description": "List of entities followed by the user.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "changeDescription": {
      "description": "Change that lead to this version of the entity.",
@ -123,11 +123,11 @@
    },
    "roles": {
      "description": "Roles that the user has been assigned.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "inheritedRoles": {
      "description": "Roles that a user is inheriting through membership in teams that have set team default roles.",
-      "$ref": "../../type/entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "../../type/entityReferenceList.json"
    },
    "isEmailVerified": {
      "description": "If the User has verified the mail",
--- a/openmetadata-spec/src/main/resources/json/schema/tests/testSuite.json
+++ b/openmetadata-spec/src/main/resources/json/schema/tests/testSuite.json
@ -57,7 +57,7 @@
    },
    "pipelines": {
      "description": "References to pipelines deployed for this database service to extract metadata, usage, lineage etc..",
-      "$ref": "../type/entityReferenceList.json#/definitions/entityReferenceList",
+      "$ref": "../type/entityReferenceList.json",
      "default": null
    },
    "serviceType": {
--- a/openmetadata-spec/src/main/resources/json/schema/type/entityReferenceList.json
+++ b/openmetadata-spec/src/main/resources/json/schema/type/entityReferenceList.json
@ -3,13 +3,9 @@
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Entity Reference List",
    "description": "This schema defines the EntityReferenceList type used for referencing an entity. EntityReference is used for capturing relationships from one entity to another. For example, a table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.",
-    "definitions": {
-        "entityReferenceList": {
-            "type": "array",
-            "items": {
-                "$ref": "entityReference.json"
-            },
-            "default": null
-        }
-    }
+    "type": "array",
+    "items": {
+        "$ref": "entityReference.json"
+    },
+    "default": null
 }
--- a/openmetadata-spec/src/main/resources/json/schema/type/votes.json
+++ b/openmetadata-spec/src/main/resources/json/schema/type/votes.json
@ -30,11 +30,11 @@
    },
    "upVoters": {
      "description": "List of all the Users who upVoted",
-      "$ref": "./entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "./entityReferenceList.json"
    },
    "downVoters": {
      "description": "List of all the Users who downVoted",
-      "$ref": "./entityReferenceList.json#/definitions/entityReferenceList"
+      "$ref": "./entityReferenceList.json"
    }
  },
  "additionalProperties": false