Fix #737 - Add version information to entity schemas

catalog-rest-service/src/main/resources/json/schema/entity/data/chart.json

@@ -80,6 +80,18 @@
       "description": "Description of the dashboard, what it is, and how to use it.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "chartType": {
       "$ref": "#/definitions/chartType"
     },

catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json

@@ -30,6 +30,18 @@
       "description": "Description of the dashboard, what it is, and how to use it.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "dashboardUrl" : {
       "description": "Dashboard URL.",
       "type": "string",

catalog-rest-service/src/main/resources/json/schema/entity/data/database.json

@@ -35,6 +35,18 @@
       "description": "Description of the database instance.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to the resource corresponding to this entity.",
       "$ref": "../../type/basic.json#/definitions/href"

catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json

@@ -30,6 +30,18 @@
       "description": "Description of metrics instance, what it is, and how to use it.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to the resource corresponding to this entity.",
       "$ref": "../../type/basic.json#/definitions/href"

catalog-rest-service/src/main/resources/json/schema/entity/data/model.json

@@ -26,6 +26,18 @@
       "description": "Display Name that identifies this model.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "description": {
       "description": "Description of the model, what it is, and how to use it.",
       "type": "string"

catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json

@@ -29,6 +29,18 @@
       "description": "Description of this Pipeline.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "pipelineUrl" : {
       "description": "Pipeline  URL to visit/manage. This URL points to respective pipeline service UI.",
       "type": "string",

catalog-rest-service/src/main/resources/json/schema/entity/data/report.json

@@ -30,6 +30,18 @@
       "description": "Description of this report instance.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to the resource corresponding to this report.",
       "$ref": "../../type/basic.json#/definitions/href"

catalog-rest-service/src/main/resources/json/schema/entity/data/table.json

@@ -355,10 +355,26 @@
       "description": "Display Name that identifies this table. It could be title or label from the source services.",
       "type": "string"
     },
+    "fullyQualifiedName": {
+      "description": "Fully qualified name of a table in the form `serviceName.databaseName.tableName`.",
+      "type": "string"
+    },
     "description": {
       "description": "Description of a table.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to this table resource.",
       "$ref": "../../type/basic.json#/definitions/href"
@@ -366,10 +382,6 @@
     "tableType": {
       "$ref": "#/definitions/tableType"
     },
-    "fullyQualifiedName": {
-      "description": "Fully qualified name of a table in the form `serviceName.databaseName.tableName`.",
-      "type": "string"
-    },
     "columns": {
       "description": "Columns in this table.",
       "type": "array",
@@ -386,20 +398,11 @@
       },
       "default": null
     },
-    "usageSummary": {
-      "description": "Latest usage information for this table.",
-      "$ref": "../../type/usageDetails.json",
-      "default": null
-    },
     "owner": {
       "description": "Owner of this table.",
       "$ref": "../../type/entityReference.json",
       "default": null
     },
-    "followers": {
-      "description": "Followers of this table.",
-      "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
-    },
     "database": {
       "description": "Reference to Database that contains this table.",
       "$ref": "../../type/entityReference.json"
@@ -416,6 +419,15 @@
       },
       "default": null
     },
+    "usageSummary": {
+      "description": "Latest usage information for this table.",
+      "$ref": "../../type/usageDetails.json",
+      "default": null
+    },
+    "followers": {
+      "description": "Followers of this table.",
+      "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
+    },
     "joins": {
       "description": "Details of other tables this table is frequently joined with.",
       "$ref": "#/definitions/tableJoins",

catalog-rest-service/src/main/resources/json/schema/entity/data/task.json

@@ -30,6 +30,18 @@
       "description": "Description of this Task.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "taskUrl" : {
       "description": "Task URL to visit/manage. This URL points to respective pipeline service UI.",
       "type": "string",

catalog-rest-service/src/main/resources/json/schema/entity/data/topic.json

@@ -67,6 +67,18 @@
       "description": "Description of the topic instance.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "service": {
       "description": "Link to the messaging cluster/service where this topic is hosted in.",
       "$ref": "../../type/entityReference.json"

catalog-rest-service/src/main/resources/json/schema/entity/services/dashboardService.json

@@ -53,6 +53,18 @@
       "description": "Description of a dashboard service instance.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "dashboardUrl": {
       "description": "Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.",
       "type": "string",

catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json

@@ -85,6 +85,18 @@
       "description": "Description of a database service instance.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to the resource corresponding to this database service.",
       "$ref": "../../type/basic.json#/definitions/href"

catalog-rest-service/src/main/resources/json/schema/entity/services/messagingService.json

@@ -53,6 +53,18 @@
       "description": "Display Name that identifies this messaging service. It could be title or label from the source services.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "brokers": {
       "description": "Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.",
       "$ref" : "#/definitions/brokers"

catalog-rest-service/src/main/resources/json/schema/entity/services/pipelineService.json

@@ -45,6 +45,18 @@
       "description": "Display Name that identifies this pipeline service. It could be title or label from the source services.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "pipelineUrl": {
       "description": "Pipeline Service Management/UI URL.",
       "type": "string",

catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json

@@ -45,6 +45,18 @@
           "description": "Unique name of the tag category.",
           "type": "string"
         },
+        "version" : {
+          "description": "Metadata version of the entity.",
+          "$ref": "../../type/basic.json#/definitions/entityVersion"
+        },
+        "updatedAt" : {
+          "description": "Last update time corresponding to the new version of the entity.",
+          "$ref": "../../type/basic.json#/definitions/dateTime"
+        },
+        "updatedBy" : {
+          "description": "User who made the update.",
+          "type": "string"
+        },
         "href": {
           "description": "Link to the resource corresponding to the tag.",
           "$ref": "../../type/basic.json#/definitions/href"
@@ -92,6 +104,18 @@
       "description": "Description of the tag category.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "categoryType": {
       "$ref": "#/definitions/tagCategoryType"
     },

catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json

@@ -29,6 +29,18 @@
       "description": "Description of the team.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "href": {
       "description": "Link to the resource corresponding to this entity.",
       "$ref": "../../type/basic.json#/definitions/href"

catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json

@@ -26,6 +26,18 @@
       "description": "Name used for display purposes. Example 'FirstName LastName'.",
       "type": "string"
     },
+    "version" : {
+      "description": "Metadata version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/entityVersion"
+    },
+    "updatedAt" : {
+      "description": "Last update time corresponding to the new version of the entity.",
+      "$ref": "../../type/basic.json#/definitions/dateTime"
+    },
+    "updatedBy" : {
+      "description": "User who made the update.",
+      "type": "string"
+    },
     "email": {
       "description": "Email address of the user.",
       "$ref": "../../type/basic.json#/definitions/email"

catalog-rest-service/src/main/resources/json/schema/type/basic.json

@@ -17,11 +17,6 @@
       "minLength": 6,
       "maxLength": 127
     },
-    "entityLink": {
-      "description": "Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.",
-      "type": "string",
-      "pattern": "^<#E/\\S+/\\S+>$"
-    },
     "timestamp": {
       "description": "Timestamp in unixTimeMillis.",
       "type": "string",
@@ -61,6 +56,18 @@
       "type": "string",
       "format": "date-time"
     },
+    "entityVersion": {
+      "description" : "Metadata version of the entity in the form `Major.Minor`. First version always starts from `0.1` when the entity is created. When the backward compatible changes are made to the entity, only the `Minor` version is incremented - example `1.0` is changed to `1.1`. When backward incompatible changes are made the `Major` version is incremented - example `1.1` to `2.0`.",
+      "type" : "number",
+      "multipleOf": 0.1,
+      "default" : 0.1,
+      "minimum": 0.1
+    },
+    "entityLink": {
+      "description": "Link to an entity or field within an entity using this format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.",
+      "type": "string",
+      "pattern": "^<#E/\\S+/\\S+>$"
+    },
     "sqlQuery": {
       "description": "SQL query statement. Example - 'select * from orders'.",
       "type": "string"