From d96da13d86e4e64095cc52954f0012ef244744dd Mon Sep 17 00:00:00 2001 From: parthp2107 <83201188+parthp2107@users.noreply.github.com> Date: Tue, 12 Oct 2021 12:28:07 +0530 Subject: [PATCH] minor changes in json schema descriptions (#742) Co-authored-by: Parth Panchal --- .../resources/json/schema/entity/data/model.json | 4 ++-- .../resources/json/schema/entity/data/pipeline.json | 8 ++++---- .../resources/json/schema/entity/data/table.json | 2 +- .../main/resources/json/schema/entity/data/task.json | 12 ++++++------ .../json/schema/entity/services/pipelineService.json | 2 +- .../resources/json/schema/type/entityLineage.json | 2 +- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/model.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/model.json index a693cfe35af..39c5e6a5dd2 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/model.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/model.json @@ -31,11 +31,11 @@ "type": "string" }, "algorithm": { - "description": "Algorithm used to train the model", + "description": "Algorithm used to train the model.", "type": "string" }, "dashboard" : { - "description": "Performance Dashboard URL to track metric evolution", + "description": "Performance Dashboard URL to track metric evolution.", "$ref" : "../../type/entityReference.json" }, "href": { 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 aee490e1702..3c2734de27d 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 @@ -30,20 +30,20 @@ "type": "string" }, "pipelineUrl" : { - "description": "Pipeline URL to visit/manage. This URL points to respective pipeline service UI", + "description": "Pipeline URL to visit/manage. This URL points to respective pipeline service UI.", "type": "string", "format": "uri" }, "concurrency": { - "description": "Concurrency of the Pipeline", + "description": "Concurrency of the Pipeline.", "type": "integer" }, "pipelineLocation": { - "description": "Pipeline Code Location", + "description": "Pipeline Code Location.", "type": "string" }, "startDate": { - "description": "Start date of the workflow", + "description": "Start date of the workflow.", "$ref": "../../type/basic.json#/definitions/dateTime" }, "tasks": { 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 4b7db76e408..d5dd2f202b0 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 @@ -111,7 +111,7 @@ } }, "columnName": { - "description": "Local name (not fully qualified name) of the column. ColumnName is `-` when the column is not named in struct dataType. For example, BigQuery supports struct with unnamed fields", + "description": "Local name (not fully qualified name) of the column. ColumnName is `-` when the column is not named in struct dataType. For example, BigQuery supports struct with unnamed fields.", "type": "string", "minLength": 1, "maxLength": 64, diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/data/task.json b/catalog-rest-service/src/main/resources/json/schema/entity/data/task.json index f62c7492a1e..8bb7afd19fc 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/data/task.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/data/task.json @@ -2,7 +2,7 @@ "$id": "https://open-metadata.org/schema/entity/data/task.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Task", - "description": "This schema defines the Task entity. A task is a unit of computation in a Pipeline. ", + "description": "This schema defines the Task entity. A task is a unit of computation in a Pipeline.", "type": "object", "javaType": "org.openmetadata.catalog.entity.data.Task", "properties" : { @@ -31,7 +31,7 @@ "type": "string" }, "taskUrl" : { - "description": "Task URL to visit/manage. This URL points to respective pipeline service UI", + "description": "Task URL to visit/manage. This URL points to respective pipeline service UI.", "type": "string", "format": "uri" }, @@ -46,19 +46,19 @@ "default": null }, "taskType": { - "description": "Type of the Task. Usually refers to the class it implements", + "description": "Type of the Task. Usually refers to the class it implements.", "type": "string" }, "taskSQL": { - "description": "SQL used in the task. Can be used to determine the lineage", + "description": "SQL used in the task. Can be used to determine the lineage.", "type": "string" }, "startDate": { - "description": "Start date of the task", + "description": "Start date of the task.", "$ref": "../../type/basic.json#/definitions/dateTime" }, "endDate": { - "description": "End date of the task", + "description": "End date of the task.", "$ref": "../../type/basic.json#/definitions/dateTime" }, "tags": { 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 31865d7ea59..b7db1ee11c8 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 @@ -42,7 +42,7 @@ "type": "string" }, "pipelineUrl": { - "description": "Pipeline Service Management/UI URL", + "description": "Pipeline Service Management/UI URL.", "type": "string", "format": "uri" }, 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 c9eae9877cc..40a3fc42cd3 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 @@ -45,7 +45,7 @@ }, "properties": { "entity" : { - "description": "Primary entity for which this lineage graph is created", + "description": "Primary entity for which this lineage graph is created.", "$ref": "entityReference.json" }, "nodes": {