yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-08 00:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

added periods to json schema descriptions (#2334)

Browse Source
This commit is contained in:
parthp2107 2022-01-23 11:55:15 +05:30 committed by GitHub
parent e5fdf77d8e
commit a784bc217d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -343,18 +343,18 @@
"type": "number" "type": "number"
}, },
"variance": { "variance": {
"description": "Variance of a column", "description": "Variance of a column.",
"type": "number" "type": "number"
}, },
"histogram": { "histogram": {
"description": "Histogram of a column", "description": "Histogram of a column.",
"properties": { "properties": {
"boundaries": { "boundaries": {
"description": "Boundaries of Histogram", "description": "Boundaries of Histogram.",
"type": "array" "type": "array"
}, },
"frequencies": { "frequencies": {
"description": "Frequencies of Histogram", "description": "Frequencies of Histogram.",
"type": "array" "type": "array"
} }
} }

18
catalog-rest-service/src/main/resources/json/schema/entity/events/webhook.json
View File

@ -2,7 +2,7 @@
"$id": "https://open-metadata.org/schema/type/webhook.json", "$id": "https://open-metadata.org/schema/type/webhook.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "ChangeEvent", "title": "ChangeEvent",
"description": "This schema defines webhook for receiving events from OpenMetadata", "description": "This schema defines webhook for receiving events from OpenMetadata.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.Webhook", "javaType": "org.openmetadata.catalog.type.Webhook",
"properties": { "properties": {
@ -17,7 +17,7 @@
"maxLength": 128 "maxLength": 128
}, },
"description": { "description": {
"description": "Description of the application", "description": "Description of the application.",
"type": "string" "type": "string"
}, },
"endpoint": { "endpoint": {
@ -38,12 +38,12 @@
"default": 10 "default": 10
}, },
"timeout": { "timeout": {
"description": "Connection timeout in seconds. (Default 10s)", "description": "Connection timeout in seconds. (Default 10s).",
"type": "integer", "type": "integer",
"default": 10 "default": 10
}, },
"enabled": { "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", "type": "boolean",
"default": true "default": true
}, },
@ -75,23 +75,23 @@
] ]
}, },
"failureDetails": { "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", "type": "object",
"properties": { "properties": {
"lastSuccessfulAt": { "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" "$ref": "../../type/basic.json#/definitions/timestamp"
}, },
"lastFailedAt": { "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" "$ref": "../../type/basic.json#/definitions/timestamp"
}, },
"lastFailedStatusCode": { "lastFailedStatusCode": {
"description": "Last non-successful activity response code received during callback", "description": "Last non-successful activity response code received during callback.",
"type": "integer" "type": "integer"
}, },
"lastFailedReason": { "lastFailedReason": {
"description": "Last non-successful activity response reason received during callback", "description": "Last non-successful activity response reason received during callback.",
"type": "string" "type": "string"
}, },
"nextAttempt": { "nextAttempt": {

8
catalog-rest-service/src/main/resources/json/schema/entity/policies/accessControl/rule.json
View File

@ -8,7 +8,7 @@
"definitions": { "definitions": {
"operation": { "operation": {
"javaType": "org.openmetadata.catalog.type.MetadataOperation", "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", "type": "string",
"enum": [ "enum": [
"SuggestDescription", "SuggestDescription",
@ -32,17 +32,17 @@
"type": "string" "type": "string"
}, },
"entityTypeAttr": { "entityTypeAttr": {
"description": "Entity type that the rule should match on", "description": "Entity type that the rule should match on.",
"type": "string", "type": "string",
"default": null "default": null
}, },
"entityTagAttr": { "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", "$ref": "../../../type/tagLabel.json#/definitions/tagFQN",
"default": null "default": null
}, },
"userRoleAttr": { "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", "$ref": "../../teams/team.json#/definitions/teamName",
"default": null "default": null
}, },

2
catalog-rest-service/src/main/resources/json/schema/entity/teams/role.json
View File

@ -2,7 +2,7 @@
"$id": "https://open-metadata.org/schema/entity/teams/role.json", "$id": "https://open-metadata.org/schema/entity/teams/role.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Role", "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", "type": "object",
"definitions" : { "definitions" : {
"roleName" : { "roleName" : {

2
catalog-rest-service/src/main/resources/json/schema/type/include.json
View File

@ -2,7 +2,7 @@
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/include.json", "$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#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Include all, deleted, or non-deleted (default) entities", "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", "type": "string",
"javaType": "org.openmetadata.catalog.type.Include", "javaType": "org.openmetadata.catalog.type.Include",
"enum": [ "enum": [

10
catalog-rest-service/src/main/resources/json/schema/type/storage.json
View File

@ -1,7 +1,7 @@
{ {
"$id": "https://open-metadata.org/schema/entity/type/storage.json", "$id": "https://open-metadata.org/schema/entity/type/storage.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"description": "Definitions related to Storage Service", "description": "Definitions related to Storage Service.",
"definitions": { "definitions": {
"storageServiceType": { "storageServiceType": {
"description": "Type of storage service such as S3, GCS, HDFS...", "description": "Type of storage service such as S3, GCS, HDFS...",
@ -29,7 +29,7 @@
] ]
}, },
"storageClassType": { "storageClassType": {
"description": "Type of storage class for the storage service", "description": "Type of storage class for the storage service.",
"type": "string", "type": "string",
"javaType": "org.openmetadata.catalog.type.StorageClassType", "javaType": "org.openmetadata.catalog.type.StorageClassType",
"oneOf": [ "oneOf": [
@ -46,7 +46,7 @@
}, },
"s3StorageClass": { "s3StorageClass": {
"$comment": "https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/s3/model/StorageClass.html", "$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", "type": "string",
"javaType": "org.openmetadata.catalog.type.S3StorageClassType", "javaType": "org.openmetadata.catalog.type.S3StorageClassType",
"enum": [ "enum": [
@ -88,7 +88,7 @@
}, },
"gcsStorageClass": { "gcsStorageClass": {
"$comment": "https://googleapis.dev/java/google-cloud-storage/latest/index.html", "$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", "type": "string",
"javaType": "org.openmetadata.catalog.type.GCSStorageClassType", "javaType": "org.openmetadata.catalog.type.GCSStorageClassType",
"enum": [ "enum": [
@ -126,7 +126,7 @@
}, },
"abfsStorageClass": { "abfsStorageClass": {
"$comment": "https://docs.microsoft.com/en-us/java/api/com.azure.storage.blob.models.accesstier?view=azure-java-stable", "$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", "type": "string",
"javaType": "org.openmetadata.catalog.type.ABFSStorageClassType", "javaType": "org.openmetadata.catalog.type.ABFSStorageClassType",
"enum": [ "enum": [