From a784bc217da2ce504f624be9ceab19c4cecfadd2 Mon Sep 17 00:00:00 2001 From: parthp2107 <83201188+parthp2107@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:55:15 +0530 Subject: [PATCH] added periods to json schema descriptions (#2334) --- .../json/schema/entity/data/table.json | 8 ++++---- .../json/schema/entity/events/webhook.json | 18 +++++++++--------- .../entity/policies/accessControl/rule.json | 8 ++++---- .../json/schema/entity/teams/role.json | 2 +- .../resources/json/schema/type/include.json | 2 +- .../resources/json/schema/type/storage.json | 10 +++++----- 6 files changed, 24 insertions(+), 24 deletions(-) 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 70ec02af043..d633342aebf 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 @@ -343,18 +343,18 @@ "type": "number" }, "variance": { - "description": "Variance of a column", + "description": "Variance of a column.", "type": "number" }, "histogram": { - "description": "Histogram of a column", + "description": "Histogram of a column.", "properties": { "boundaries": { - "description": "Boundaries of Histogram", + "description": "Boundaries of Histogram.", "type": "array" }, "frequencies": { - "description": "Frequencies of Histogram", + "description": "Frequencies of Histogram.", "type": "array" } } diff --git 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 index 63fc9ee643d..7ca16180632 100644 --- 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 @@ -2,7 +2,7 @@ "$id": "https://open-metadata.org/schema/type/webhook.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "ChangeEvent", - "description": "This schema defines webhook for receiving events from OpenMetadata", + "description": "This schema defines webhook for receiving events from OpenMetadata.", "type": "object", "javaType": "org.openmetadata.catalog.type.Webhook", "properties": { @@ -17,7 +17,7 @@ "maxLength": 128 }, "description": { - "description": "Description of the application", + "description": "Description of the application.", "type": "string" }, "endpoint": { @@ -38,12 +38,12 @@ "default": 10 }, "timeout": { - "description": "Connection timeout in seconds. (Default 10s)", + "description": "Connection timeout in seconds. (Default 10s).", "type": "integer", "default": 10 }, "enabled": { - "description": "When set to `true`, the webhook event notification is enabled. Set it to `false` to disable the subscription. (Default `true`)", + "description": "When set to `true`, the webhook event notification is enabled. Set it to `false` to disable the subscription. (Default `true`).", "type": "boolean", "default": true }, @@ -75,23 +75,23 @@ ] }, "failureDetails": { - "description": "Failure details are set only when `status` is not `success`", + "description": "Failure details are set only when `status` is not `success`.", "type": "object", "properties": { "lastSuccessfulAt": { - "description": "Last non-successful callback time in UNIX UTC epoch time in milliseconds", + "description": "Last non-successful callback time in UNIX UTC epoch time in milliseconds.", "$ref": "../../type/basic.json#/definitions/timestamp" }, "lastFailedAt": { - "description": "Last non-successful callback time in UNIX UTC epoch time in milliseconds", + "description": "Last non-successful callback time in UNIX UTC epoch time in milliseconds.", "$ref": "../../type/basic.json#/definitions/timestamp" }, "lastFailedStatusCode": { - "description": "Last non-successful activity response code received during callback", + "description": "Last non-successful activity response code received during callback.", "type": "integer" }, "lastFailedReason": { - "description": "Last non-successful activity response reason received during callback", + "description": "Last non-successful activity response reason received during callback.", "type": "string" }, "nextAttempt": { diff --git a/catalog-rest-service/src/main/resources/json/schema/entity/policies/accessControl/rule.json b/catalog-rest-service/src/main/resources/json/schema/entity/policies/accessControl/rule.json index 931ae9de64c..c5572ebf310 100644 --- a/catalog-rest-service/src/main/resources/json/schema/entity/policies/accessControl/rule.json +++ b/catalog-rest-service/src/main/resources/json/schema/entity/policies/accessControl/rule.json @@ -8,7 +8,7 @@ "definitions": { "operation": { "javaType": "org.openmetadata.catalog.type.MetadataOperation", - "description": "This schema defines all possible operations on metadata of data entities", + "description": "This schema defines all possible operations on metadata of data entities.", "type": "string", "enum": [ "SuggestDescription", @@ -32,17 +32,17 @@ "type": "string" }, "entityTypeAttr": { - "description": "Entity type that the rule should match on", + "description": "Entity type that the rule should match on.", "type": "string", "default": null }, "entityTagAttr": { - "description": "Entity tag that the rule should match on", + "description": "Entity tag that the rule should match on.", "$ref": "../../../type/tagLabel.json#/definitions/tagFQN", "default": null }, "userRoleAttr": { - "description": "Role of the user that the rule should match on", + "description": "Role of the user that the rule should match on.", "$ref": "../../teams/team.json#/definitions/teamName", "default": null }, diff --git 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 index e43e476d9d4..f33758148cf 100644 --- 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 @@ -2,7 +2,7 @@ "$id": "https://open-metadata.org/schema/entity/teams/role.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Role", - "description": "This schema defines the Role entity. A Role has access to zero or more data assets", + "description": "This schema defines the Role entity. A Role has access to zero or more data assets.", "type": "object", "definitions" : { "roleName" : { diff --git a/catalog-rest-service/src/main/resources/json/schema/type/include.json b/catalog-rest-service/src/main/resources/json/schema/type/include.json index 1a62b2575c1..3484daca887 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/include.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/include.json @@ -2,7 +2,7 @@ "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/include.json", "$schema": "http://json-schema.org/draft-07/schema#", "title": "Include all, deleted, or non-deleted (default) entities", - "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include", + "description": "GET entity by id, GET entity by name, and LIST entities can include deleted or non-deleted entities using the parameter include.", "type": "string", "javaType": "org.openmetadata.catalog.type.Include", "enum": [ diff --git a/catalog-rest-service/src/main/resources/json/schema/type/storage.json b/catalog-rest-service/src/main/resources/json/schema/type/storage.json index 1c2cdc54ec2..f6d983538df 100644 --- a/catalog-rest-service/src/main/resources/json/schema/type/storage.json +++ b/catalog-rest-service/src/main/resources/json/schema/type/storage.json @@ -1,7 +1,7 @@ { "$id": "https://open-metadata.org/schema/entity/type/storage.json", "$schema": "http://json-schema.org/draft-07/schema#", - "description": "Definitions related to Storage Service", + "description": "Definitions related to Storage Service.", "definitions": { "storageServiceType": { "description": "Type of storage service such as S3, GCS, HDFS...", @@ -29,7 +29,7 @@ ] }, "storageClassType": { - "description": "Type of storage class for the storage service", + "description": "Type of storage class for the storage service.", "type": "string", "javaType": "org.openmetadata.catalog.type.StorageClassType", "oneOf": [ @@ -46,7 +46,7 @@ }, "s3StorageClass": { "$comment": "https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/model/StorageClass.html", - "description": "Type of storage class offered by S3", + "description": "Type of storage class offered by S3.", "type": "string", "javaType": "org.openmetadata.catalog.type.S3StorageClassType", "enum": [ @@ -88,7 +88,7 @@ }, "gcsStorageClass": { "$comment": "https://googleapis.dev/java/google-cloud-storage/latest/index.html", - "description": "Type of storage class offered by GCS", + "description": "Type of storage class offered by GCS.", "type": "string", "javaType": "org.openmetadata.catalog.type.GCSStorageClassType", "enum": [ @@ -126,7 +126,7 @@ }, "abfsStorageClass": { "$comment": "https://docs.microsoft.com/en-us/java/api/com.azure.storage.blob.models.accesstier?view=azure-java-stable", - "description": "Type of storage class offered by ABFS", + "description": "Type of storage class offered by ABFS.", "type": "string", "javaType": "org.openmetadata.catalog.type.ABFSStorageClassType", "enum": [