yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-30 01:59:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix #75 Update JSON schema documentation

Browse Source
This commit is contained in:
sureshms 2021-08-09 12:13:56 -07:00
parent 5bff12aefe
commit ad4a32d1b8
23 changed files with 201 additions and 203 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
catalog-rest-service/src/main/resources/json/schema/entity/audit/auditLog.json
View File

@ -1,47 +1,47 @@
{ {
"$id": "https://streaminlinedata.ai/entity/audit/auditLog.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/audit/auditLog.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Audit Log entity", "title": "Audit Log",
"description": "Entity that represents a Audit Log", "description": "This schema defines Audit Log entity. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies a Audit Log Entry", "description": "Unique identifier that identifies a Audit Log Entry.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"method": { "method": {
"description": "HTTP Method used in a call", "description": "HTTP Method used in a call.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
}, },
"responseCode": { "responseCode": {
"description": "HTTP response code for the api requested", "description": "HTTP response code for the api requested.",
"type": "integer" "type": "integer"
}, },
"path": { "path": {
"description": "requested API Path", "description": "Requested API Path.",
"type": "string" "type": "string"
}, },
"username": { "username": {
"description": "Name of the user who requested for the API", "description": "Name of the user who requested for the API.",
"type": "string" "type": "string"
}, },
"date": { "date": {
"description": "Date which the api call is made", "description": "Date which the api call is made.",
"$ref": "../../type/basic.json#/definitions/date" "$ref": "../../type/basic.json#/definitions/date"
}, },
"entityId": { "entityId": {
"description": "entityReference Id", "description": "Entity reference.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"entityType": { "entityType": {
"description": "Entity Type", "description": "Entity Type.",
"type": "string" "type": "string"
}, },
"entity" : { "entity" : {
"description": "Link to entity on which api request is done", "description": "Link to entity on which api request is done.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
} }
}, },

13
catalog-rest-service/src/main/resources/json/schema/entity/bots.json
View File

@ -1,23 +1,24 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Bot entity", "title": "Bot",
"description": "Bot entity to capture the details of a bot", "description": "Bot entity to capture the details of a bot.",
"description": "This schema defines Bot entity. A bot automates tasks, such as adding description, identifying importance of data. It runs as a special user in the system.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies an entity instance", "description": "Unique identifier that identifies an entity instance.",
"$ref": "../type/basic.json#/definitions/uuid" "$ref": "../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"description": "Optional name that identifies this entity. Same as id if name is not available", "description": "Optional name that identifies this entity. Same as id if name is not available.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
}, },
"displayName": { "displayName": {
"description": "Name used for display purposes. Example 'FirstName LastName'", "description": "Name used for display purposes. Example 'FirstName LastName'.",
"type": "string" "type": "string"
}, },
"description": { "description": {
@ -25,7 +26,7 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../type/basic.json#/definitions/href" "$ref": "../type/basic.json#/definitions/href"
} }
} }

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

@ -1,23 +1,23 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Dashboard entity", "title": "Dashboard",
"description": "Entity that represents a Dashboard", "description": "This schema defines Dashboard entity.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies a dashboard instance", "description": "Unique identifier that identifies a dashboard instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"description": "Name that identifies the this dashboard.", "description": "Name that identifies this dashboard.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'", "description": "Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
@ -27,19 +27,19 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"owner": { "owner": {
"description": "Owner of this dashboard", "description": "Owner of this dashboard.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"service" : { "service" : {
"description": "Link to service where this dashboard is hosted in", "description": "Link to service where this dashboard is hosted in.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
}, },
"usageSummary" : { "usageSummary" : {
"description": "Latest usage information for this database", "description": "Latest usage information for this database.",
"$ref": "../../type/usageDetails.json", "$ref": "../../type/usageDetails.json",
"default": null "default": null
} }

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

@ -1,13 +1,13 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Database entity", "title": "Database",
"description": "Entity that represents a database", "description": "This schema defines Database entity. Database is a collection of schemas. They are also referred to as Database Catalog.",
"type": "object", "type": "object",
"definitions": { "definitions": {
"databaseName": { "databaseName": {
"description": "Name that identifies the database", "description": "Name that identifies the database.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64, "maxLength": 64,
@ -16,15 +16,15 @@
}, },
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies this database instance", "description": "Unique identifier that identifies this database instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"description": "Name that identifies the database", "description": "Name that identifies the database.",
"$ref": "#/definitions/databaseName" "$ref": "#/definitions/databaseName"
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'", "description": "Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'.",
"type": "string" "type": "string"
}, },
"description": { "description": {
@ -32,24 +32,24 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"owner": { "owner": {
"description": "Owner of this database", "description": "Owner of this database.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"service" : { "service" : {
"description": "Link to the database cluster/service where this database is hosted in", "description": "Link to the database cluster/service where this database is hosted in.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
}, },
"usageSummary" : { "usageSummary" : {
"description": "Latest usage information for this database", "description": "Latest usage information for this database.",
"$ref": "../../type/usageDetails.json", "$ref": "../../type/usageDetails.json",
"default": null "default": null
}, },
"tables": { "tables": {
"description": "References to tables in the database", "description": "References to tables in the database.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
} }
}, },

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

@ -1,13 +1,13 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Metrics entity", "title": "Metrics",
"description": "Entity that represents a Metrics", "description": "This schema defines Metrics entity.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies this metrics instance", "description": "Unique identifier that identifies this metrics instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
@ -17,29 +17,29 @@
"maxLength": 64 "maxLength": 64
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Unique name that identifies a metric in the format 'ServiceName.MetricName'", "description": "Unique name that identifies a metric in the format 'ServiceName.MetricName'.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
}, },
"description": { "description": {
"description": "Description of metrics instance. What is has and how to use it", "description": "Description of metrics instance. What is has and how to use it.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"owner": { "owner": {
"description": "Owner of this metrics", "description": "Owner of this metrics.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"service" : { "service" : {
"description": "Link to service where this metrics is hosted in", "description": "Link to service where this metrics is hosted in.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
}, },
"usageSummary" : { "usageSummary" : {
"description": "Latest usage information for this database", "description": "Latest usage information for this database.",
"$ref": "../../type/usageDetails.json", "$ref": "../../type/usageDetails.json",
"default": null "default": null
} }

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

@ -1,13 +1,13 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Pipeline entity", "title": "Pipeline",
"description": "Entity that represents a Pipeline", "description": "This schema defines Pipeline entity.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies a pipeline instance", "description": "Unique identifier that identifies a pipeline instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
@ -17,7 +17,7 @@
"maxLength": 64 "maxLength": 64
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'", "description": "Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
@ -27,15 +27,15 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"owner": { "owner": {
"description": "Owner of this pipeline", "description": "Owner of this pipeline.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"service" : { "service" : {
"description": "Link to service where this pipeline is hosted in", "description": "Link to service where this pipeline is hosted in.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
} }
}, },

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

@ -1,13 +1,13 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Report entity", "title": "Report",
"description": "Entity that represents a Report", "description": "This schema defines Report entity.",
"type": "object", "type": "object",
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies this report", "description": "Unique identifier that identifies this report.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
@ -17,7 +17,7 @@
"maxLength": 64 "maxLength": 64
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Unique name that identifies a report in the format 'ServiceName.ReportName'", "description": "Unique name that identifies a report in the format 'ServiceName.ReportName'.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
@ -27,19 +27,19 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this report", "description": "Link to the resource corresponding to this report.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"owner": { "owner": {
"description": "Owner of this pipeline", "description": "Owner of this pipeline.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"service" : { "service" : {
"description": "Link to service where this report is hosted in", "description": "Link to service where this report is hosted in.",
"$ref" : "../../type/entityReference.json" "$ref" : "../../type/entityReference.json"
}, },
"usageSummary" : { "usageSummary" : {
"description": "Latest usage information for this database", "description": "Latest usage information for this database.",
"$ref": "../../type/usageDetails.json", "$ref": "../../type/usageDetails.json",
"default": null "default": null
} }

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

@ -1,14 +1,14 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Table entity", "title": "Table",
"description": "Schema corresponding to a table that belongs to a database", "description": "This schema defines Table entity. Database contains a collection of schemas. Schemas contain Tables, Views, etc. OpenMetadata does not have a separate hierarchy for Schema. Both Table and Schema are captured in this entity.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.entity.data.Table", "javaType": "org.openmetadata.catalog.entity.data.Table",
"definitions": { "definitions": {
"tableType": { "tableType": {
"javaType": "org.openmetadata.catalog.type.TableType", "javaType": "org.openmetadata.catalog.type.TableType",
"description": "Type for capturing a column in a table", "description": "Type for capturing a column in a table.",
"type": "string", "type": "string",
"enum": [ "enum": [
"Regular", "Regular",
@ -37,7 +37,7 @@
}, },
"columnDataType": { "columnDataType": {
"javaType": "org.openmetadata.catalog.type.ColumnDataType", "javaType": "org.openmetadata.catalog.type.ColumnDataType",
"description": "Type for capturing a column in a table", "description": "Type for capturing a column in a table.",
"type": "string", "type": "string",
"enum": [ "enum": [
"NUMBER", "NUMBER",
@ -77,7 +77,7 @@
}, },
"columnConstraint": { "columnConstraint": {
"javaType": "org.openmetadata.catalog.type.ColumnConstraint", "javaType": "org.openmetadata.catalog.type.ColumnConstraint",
"description": "Column constraint", "description": "Column constraint.",
"type": "string", "type": "string",
"enum": [ "enum": [
"NULL", "NULL",
@ -90,7 +90,7 @@
"tableConstraint": { "tableConstraint": {
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.TableConstraint", "javaType": "org.openmetadata.catalog.type.TableConstraint",
"description": "Table constraint", "description": "Table constraint.",
"properties": { "properties": {
"constraintType": { "constraintType": {
"type": "string", "type": "string",
@ -101,7 +101,7 @@
] ]
}, },
"columns": { "columns": {
"description": "List of column names corresponding to the constraint", "description": "List of column names corresponding to the constraint.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -110,21 +110,21 @@
} }
}, },
"columnName": { "columnName": {
"description": "Local name (not fully qualified name) of the column", "description": "Local name (not fully qualified name) of the column.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64, "maxLength": 64,
"pattern": "^[^.]*$" "pattern": "^[^.]*$"
}, },
"tableName": { "tableName": {
"description": "Local name (not fully qualified name) of the table", "description": "Local name (not fully qualified name) of the table.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64, "maxLength": 64,
"pattern": "^[^.]*$" "pattern": "^[^.]*$"
}, },
"fullyQualifiedColumnName": { "fullyQualifiedColumnName": {
"description": "Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName", "description": "Fully qualified name of the column that includes serviceName.databaseName.tableName.columnName.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 256 "maxLength": 256
@ -132,24 +132,24 @@
"column": { "column": {
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.Column", "javaType": "org.openmetadata.catalog.type.Column",
"description": "Type for capturing a column in a table", "description": "Type for capturing a column in a table.",
"properties": { "properties": {
"name": { "name": {
"$ref": "#/definitions/columnName" "$ref": "#/definitions/columnName"
}, },
"columnDataType": { "columnDataType": {
"description": "Data type of the column (int, date etc.)", "description": "Data type of the column (int, date etc.).",
"$ref": "#/definitions/columnDataType" "$ref": "#/definitions/columnDataType"
}, },
"description": { "description": {
"description": "Description of the column", "description": "Description of the column.",
"type": "string" "type": "string"
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"$ref": "#/definitions/fullyQualifiedColumnName" "$ref": "#/definitions/fullyQualifiedColumnName"
}, },
"tags": { "tags": {
"description": "Tags associated with the column", "description": "Tags associated with the column.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "../../type/tagLabel.json" "$ref": "../../type/tagLabel.json"
@ -157,11 +157,11 @@
"default": null "default": null
}, },
"columnConstraint": { "columnConstraint": {
"description": "Column level constraint", "description": "Column level constraint.",
"$ref": "#/definitions/columnConstraint" "$ref": "#/definitions/columnConstraint"
}, },
"ordinalPosition": { "ordinalPosition": {
"description": "Ordinal position of the column", "description": "Ordinal position of the column.",
"type": "integer" "type": "integer"
} }
}, },
@ -173,13 +173,13 @@
"columnJoins": { "columnJoins": {
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.ColumnJoin", "javaType": "org.openmetadata.catalog.type.ColumnJoin",
"description": "Information on other tables that this table column is frequently joined with", "description": "Information on other tables that this table column is frequently joined with.",
"properties": { "properties": {
"columnName": { "columnName": {
"$ref": "#/definitions/columnName" "$ref": "#/definitions/columnName"
}, },
"joinedWith": { "joinedWith": {
"description": "Fully qualified names of the columns that this column is joined with", "description": "Fully qualified names of the columns that this column is joined with.",
"type": "array", "type": "array",
"items": { "items": {
"type" : "object", "type" : "object",
@ -201,7 +201,7 @@
"javaType": "org.openmetadata.catalog.type.TableJoins", "javaType": "org.openmetadata.catalog.type.TableJoins",
"properties": { "properties": {
"startDate": { "startDate": {
"description": "Date can be only from today going back to last 29 days", "description": "Date can be only from today going back to last 29 days.",
"$ref": "../../type/basic.json#/definitions/date" "$ref": "../../type/basic.json#/definitions/date"
}, },
"dayCount": { "dayCount": {
@ -220,20 +220,20 @@
"tableData": { "tableData": {
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.TableData", "javaType": "org.openmetadata.catalog.type.TableData",
"description": "Information on other tables that this table column is frequently joined with", "description": "Information on other tables that this table column is frequently joined with.",
"properties": { "properties": {
"columns": { "columns": {
"description": "List of local column names (not fully qualified column names) of the table", "description": "List of local column names (not fully qualified column names) of the table.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/columnName" "$ref": "#/definitions/columnName"
} }
}, },
"rows": { "rows": {
"description": "Data for a multiple rows of the table", "description": "Data for a multiple rows of the table.",
"type": "array", "type": "array",
"items": { "items": {
"description": "Data for a single row of the table with in the same order as columns fields", "description": "Data for a single row of the table with in the same order as columns fields.",
"type": "array" "type": "array"
} }
} }
@ -243,30 +243,30 @@
}, },
"properties": { "properties": {
"id": { "id": {
"description": "Unique identifier that identifies this table instance", "description": "Unique identifier that identifies this table instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"description": "Name of the table. Expected to be unique with in a database", "description": "Name of the table. Expected to be unique with in a database.",
"$ref": "#/definitions/tableName" "$ref": "#/definitions/tableName"
}, },
"description": { "description": {
"description": "Description of the table", "description": "Description of the table.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to this table resource", "description": "Link to this table resource.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"tableType": { "tableType": {
"$ref": "#/definitions/tableType" "$ref": "#/definitions/tableType"
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Fully qualified name of the table in the form serviceName.databaseName.tableName", "description": "Fully qualified name of the table in the form serviceName.databaseName.tableName.",
"type": "string" "type": "string"
}, },
"columns": { "columns": {
"description": "Columns in the table", "description": "Columns in the table.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/column" "$ref": "#/definitions/column"
@ -274,7 +274,7 @@
"default": null "default": null
}, },
"tableConstraints": { "tableConstraints": {
"description": "Table constraints", "description": "Table constraints.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/tableConstraint" "$ref": "#/definitions/tableConstraint"
@ -283,24 +283,24 @@
}, },
"usageSummary": { "usageSummary": {
"$ref": "../../type/usageDetails.json", "$ref": "../../type/usageDetails.json",
"description": "Latest usage information for this table", "description": "Latest usage information for this table.",
"default": null "default": null
}, },
"owner": { "owner": {
"description": "Owner of this table", "description": "Owner of this table.",
"$ref": "../../type/entityReference.json", "$ref": "../../type/entityReference.json",
"default": null "default": null
}, },
"followers": { "followers": {
"description": "Followers of this table", "description": "Followers of this table.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
}, },
"database": { "database": {
"description": "Reference to Database that contains this table", "description": "Reference to Database that contains this table.",
"$ref": "../../type/entityReference.json" "$ref": "../../type/entityReference.json"
}, },
"tags": { "tags": {
"description": "Tags for this table", "description": "Tags for this table.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "../../type/tagLabel.json" "$ref": "../../type/tagLabel.json"
@ -308,12 +308,12 @@
"default": null "default": null
}, },
"joins": { "joins": {
"description": "Details of other tables this table is frequently joined with", "description": "Details of other tables this table is frequently joined with.",
"$ref": "#/definitions/tableJoins", "$ref": "#/definitions/tableJoins",
"default": null "default": null
}, },
"sampleData": { "sampleData": {
"description": "Sample data for the table", "description": "Sample data for the table.",
"$ref": "#/definitions/tableData", "$ref": "#/definitions/tableData",
"default": null "default": null
} }

20
catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json
View File

@ -1,27 +1,27 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Feed entity", "title": "Thread",
"description": "Entity that represents a feed", "description": "This schema defines Thread entity. A Thread is a collection of posts made the users. First post that starts a thread is about a data asset created by a user. Other users can respond to this post by creating new posts in the thread. Note that bot users can also interact with a thread. A post can contains links that mentions Users or other Data Assets.",
"type": "object", "type": "object",
"definitions": { "definitions": {
"post": { "post": {
"javaType": "org.openmetadata.catalog.type.Post", "javaType": "org.openmetadata.catalog.type.Post",
"type": "object", "type": "object",
"description": "Post within a feed", "description": "Post within a feed.",
"properties": { "properties": {
"message": { "message": {
"description": "Message in markdown format. See markdown support for more details.", "description": "Message in markdown format. See markdown support for more details.",
"type": "string" "type": "string"
}, },
"postTs": { "postTs": {
"description": "Timestamp of the post", "description": "Timestamp of the post.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"from": { "from": {
"description": "ID of User (regular user or a bot) posting the message", "description": "ID of User (regular user or a bot) posting the message.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
} }
}, },
@ -30,23 +30,23 @@
}, },
"properties": { "properties": {
"id": { "id": {
"description": "Unique identifier that identifies an entity instance", "description": "Unique identifier that identifies an entity instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"threadTs": { "threadTs": {
"description": "Timestamp of the when the first post created the thread", "description": "Timestamp of the when the first post created the thread.",
"format": "date-time" "format": "date-time"
}, },
"about": { "about": {
"description": "Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}", "description": "Data asset about which this thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}.",
"$ref" : "../../type/basic.json#/definitions/entityLink" "$ref" : "../../type/basic.json#/definitions/entityLink"
}, },
"addressedTo": { "addressedTo": {
"description": "User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}", "description": "User or team this thread is addressed to in format <#E/{enties}/{entityName}/{field}/{fieldValue}.",
"$ref" : "../../type/basic.json#/definitions/entityLink" "$ref" : "../../type/basic.json#/definitions/entityLink"
}, },
"posts": { "posts": {

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

@ -1,8 +1,8 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Database service entity", "title": "Database Service",
"description": "Database service entity that reference services such as MySQL, BigQuery, Redshift, Postgres or Snowflake", "description": "This schema defines Database Service entity, such as MySQL, BigQuery, Redshift, Postgres or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used.",
"type": "object", "type": "object",
"definitions": { "definitions": {
"databaseServiceType": { "databaseServiceType": {
@ -44,11 +44,11 @@
}, },
"properties": { "properties": {
"id": { "id": {
"description": "Unique identifier that identifies an entity instance", "description": "Unique identifier that identifies an entity instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"description": "Name that identifies the this entity instance uniquely. Same as id if when name is not unique", "description": "Name that identifies the this entity instance uniquely. Same as id if when name is not unique.",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 64 "maxLength": 64
@ -61,14 +61,14 @@
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"jdbc": { "jdbc": {
"$ref": "../../type/jdbcConnection.json#/definitions/jdbcInfo" "$ref": "../../type/jdbcConnection.json#/definitions/jdbcInfo"
}, },
"ingestionSchedule": { "ingestionSchedule": {
"description": "Schedule for running metadata ingestion jobs", "description": "Schedule for running metadata ingestion jobs.",
"$ref": "../../type/schedule.json" "$ref": "../../type/schedule.json"
} }
}, },

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

@ -1,19 +1,19 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Types related to tag category", "title": "Tag Category",
"description": "Types related to tag category", "description": "This schema defines Tag Category entity. A Tag Category has one more children tags called Primary Tags. Primary Tags can have children Tags called Secondary Tags. Only two level of of tags are supported currently.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.TagCategory", "javaType": "org.openmetadata.catalog.type.TagCategory",
"definitions": { "definitions": {
"tagName": { "tagName": {
"description": "Name of the tag", "description": "Name of the tag.",
"type": "string", "type": "string",
"minLength": 2, "minLength": 2,
"maxLength": 25 "maxLength": 25
}, },
"tagCategoryType": { "tagCategoryType": {
"description": "Type of tag category", "description": "Type of tag category.",
"type": "string", "type": "string",
"enum": [ "enum": [
"Descriptive", "Descriptive",
@ -22,11 +22,11 @@
"javaEnums": [ "javaEnums": [
{ {
"name": "Descriptive", "name": "Descriptive",
"description": "Tag category used for describing an entity. Example - column is of of type User.Address" "description": "Tag category used for describing an entity. Example - column is of of type User.Addres.s"
}, },
{ {
"name": "Classification", "name": "Classification",
"description": "Tag category used for classifying an entity. Example - column is of of type PII.sensitive" "description": "Tag category used for classifying an entity. Example - column is of of type PII.sensitiv.e"
} }
] ]
}, },
@ -37,35 +37,35 @@
"$ref": "#/definitions/tagName" "$ref": "#/definitions/tagName"
}, },
"fullyQualifiedName": { "fullyQualifiedName": {
"description": "Unique name of the tag of format Category.PrimaryTag.SecondaryTag", "description": "Unique name of the tag of format Category.PrimaryTag.SecondaryTag.",
"type": "string" "type": "string"
}, },
"description": { "description": {
"description": "Unique name of the tag category", "description": "Unique name of the tag category.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to the tag", "description": "Link to the resource corresponding to the tag.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"usageCount": { "usageCount": {
"description": "Count of how many times this tag and children tags are used", "description": "Count of how many times this tag and children tags are used.",
"type": "integer" "type": "integer"
}, },
"deprecated": { "deprecated": {
"description": "If the tag is deprecated", "description": "If the tag is deprecated.",
"type": "boolean", "type": "boolean",
"default": false "default": false
}, },
"associatedTags": { "associatedTags": {
"description": "Fully qualified names of tags associated with this tag", "description": "Fully qualified names of tags associated with this tag.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"children": { "children": {
"description": "Tags under this tag group or empty for tags at leaf level", "description": "Tags under this tag group or empty for tags at leaf level.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/tag" "$ref": "#/definitions/tag"
@ -84,22 +84,22 @@
"$ref": "#/definitions/tagName" "$ref": "#/definitions/tagName"
}, },
"description": { "description": {
"description": "Description of the tag category", "description": "Description of the tag category.",
"type": "string" "type": "string"
}, },
"categoryType": { "categoryType": {
"$ref": "#/definitions/tagCategoryType" "$ref": "#/definitions/tagCategoryType"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to the tag category", "description": "Link to the resource corresponding to the tag category.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"usageCount": { "usageCount": {
"description": "Count of how many times the tags from this tag category are used", "description": "Count of how many times the tags from this tag category are used.",
"type": "integer" "type": "integer"
}, },
"children": { "children": {
"description": "Tags under this category", "description": "Tags under this category.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/tag" "$ref": "#/definitions/tag"

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

@ -1,8 +1,8 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Team entity", "title": "Team",
"description": "Team entity", "description": "This schema defines Team entity. A Team is a group of zero or more users. Team can have ownership of data assets.",
"type": "object", "type": "object",
"defintions" : { "defintions" : {
@ -22,30 +22,30 @@
"$ref": "#/defintions/teamName" "$ref": "#/defintions/teamName"
}, },
"displayName": { "displayName": {
"description": "Name used for display purposes. Example 'Data Science team'", "description": "Name used for display purposes. Example 'Data Science team'.",
"type": "string" "type": "string"
}, },
"description": { "description": {
"description": "Description of the team", "description": "Description of the team.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"profile": { "profile": {
"description": "Team profile information", "description": "Team profile information.",
"$ref": "../../type/profile.json" "$ref": "../../type/profile.json"
}, },
"deleted" : { "deleted" : {
"type": "boolean" "type": "boolean"
}, },
"users" : { "users" : {
"description": "Users that are part of the team", "description": "Users that are part of the team.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
}, },
"owns" : { "owns" : {
"description": "Entities owned by the team", "description": "Entities owned by the team.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
} }
}, },

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

@ -1,8 +1,8 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "User entity", "title": "User",
"description": "User entity that is part of an organization", "description": "This schema defines User entity. A user can be part of 0 or more teams. A special type of user called Bot is used for automation. A user can be an owner and own zero or more data asset entities. A user can also follow zero or more data asset entities.",
"type": "object", "type": "object",
"definitions": { "definitions": {
@ -16,37 +16,40 @@
"properties" : { "properties" : {
"id": { "id": {
"description": "Unique identifier that identifies an entity instance", "description": "Unique identifier that identifies a user entity instance.",
"$ref": "../../type/basic.json#/definitions/uuid" "$ref": "../../type/basic.json#/definitions/uuid"
}, },
"name": { "name": {
"$ref": "#/definitions/userName" "$ref": "#/definitions/userName"
}, },
"displayName": { "displayName": {
"description": "Name used for display purposes. Example 'FirstName LastName'", "description": "Name used for display purposes. Example 'FirstName LastName'.",
"type": "string" "type": "string"
}, },
"email": { "email": {
"description": "Email address of the user.",
"$ref": "../../type/basic.json#/definitions/email" "$ref": "../../type/basic.json#/definitions/email"
}, },
"href": { "href": {
"description": "Link to the resource corresponding to this entity", "description": "Link to the resource corresponding to this entity.",
"$ref": "../../type/basic.json#/definitions/href" "$ref": "../../type/basic.json#/definitions/href"
}, },
"timezone": { "timezone": {
"description": "Timezone of the user", "description": "Timezone of the user.",
"type": "string", "type": "string",
"format": "timezone" "format": "timezone"
}, },
"deactivated" : { "deactivated" : {
"description": "When true indicates user has been deactivated. Users are deactivated instead of deleted.",
"type": "boolean" "type": "boolean"
}, },
"isBot" : { "isBot" : {
"description": "When true indicates a special type of user called Bot.",
"type": "boolean", "type": "boolean",
"boolean" : false "boolean" : false
}, },
"isAdmin" : { "isAdmin" : {
"description": "When true indicates user is an adiministrator for the sytem with superuser privileges", "description": "When true indicates user is an administrator for the system with superuser privileges.",
"type": "boolean", "type": "boolean",
"boolean" : false "boolean" : false
}, },
@ -54,17 +57,18 @@
"$ref": "../../type/profile.json" "$ref": "../../type/profile.json"
}, },
"teams" : { "teams" : {
"description": "Teams that the user belongs to", "description": "Teams that the user belongs to.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
}, },
"owns" : { "owns" : {
"description": "Entities owned by the user", "description": "Entities owned by the user.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
}, },
"follows" : { "follows" : {
"description": "Entities followed by the user", "description": "Entities followed by the user.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList" "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
} }
}, },
"additionalProperties": false,
"required": ["id", "name", "email", "href"] "required": ["id", "name", "email", "href"]
} }

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

@ -1,21 +1,16 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Common types", "title": "Basic",
"description": "Common reusable types", "description": "This schema defines basic common types that are used by other schemas.",
"definitions": { "definitions": {
"uuid": { "uuid": {
"description": "Unique id used to identify an entity", "description": "Unique id used to identify an entity.",
"type": "string", "type": "string",
"format": "uuid" "format": "uuid"
}, },
"schema": {
"description": "URL for the schema of an entity",
"type": "string",
"format": "uri"
},
"email": { "email": {
"description": "Email address of user or other entities", "description": "Email address of a user or other entities.",
"type": "string", "type": "string",
"format": "email", "format": "email",
"pattern": "^\\S+@\\S+\\.\\S+$", "pattern": "^\\S+@\\S+\\.\\S+$",
@ -23,47 +18,45 @@
"maxLength": 127 "maxLength": 127
}, },
"entityLink": { "entityLink": {
"description": "Entity or field thread is created for with format <#E/{enties}/{entityName}/{field}/{fieldValue}", "description": "Link to an entity or field of an entity of format <#E/{enties}/{entityName}/{field}/{fieldValue}.",
"type": "string", "type": "string",
"pattern": "^<#E/\\S+/\\S+>$" "pattern": "^<#E/\\S+/\\S+>$"
}, },
"timestamp": { "timestamp": {
"$comment": "Timestamp type", "description": "Time stamp in unixTimeMillis",
"type": "string", "type": "string",
"format": "utc-millisec" "format": "utc-millisec"
}, },
"href": { "href": {
"$comment": "Link to the resource", "description": "href that points to a resource.",
"type": "string", "type": "string",
"format": "uri" "format": "uri"
}, },
"timeInterval": { "timeInterval": {
"$comment": "Time interval type",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.TimeInterval", "javaType": "org.openmetadata.catalog.type.TimeInterval",
"properties": { "properties": {
"start": { "start": {
"description": "Start unixTimeMillis", "description": "Start time in unixTimeMillis.",
"type": "integer" "type": "integer"
}, },
"end": { "end": {
"description": "End unixTimeMillis", "description": "End time in unixTimeMillis.",
"type": "integer" "type": "integer"
} }
} }
}, },
"duration": { "duration": {
"description": "Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'", "description": "Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'.",
"type": "string", "type": "string"
"$comment": "Jsonschema does not handle ISO 8601 duration yet and hence no format for this type"
}, },
"date": { "date": {
"description": "Date in ISO 8601 format in UTC time. Example - '2018-11-13'", "description": "Date in ISO 8601 format in UTC time. Example - '2018-11-13'.",
"type": "string", "type": "string",
"format": "date" "format": "date"
}, },
"dateTime": { "dateTime": {
"description": "Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'", "description": "Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.",
"type": "string", "type": "string",
"format": "date-Time" "format": "date-Time"
} }

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

@ -2,26 +2,26 @@
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/collectionDescriptor.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Schema for collection descriptor", "title": "Schema for collection descriptor",
"description": "Type used for capturing the details of a collection", "description": "Type used for capturing the details of a collection.",
"type": "object", "type": "object",
"definitions": { "definitions": {
"collectionInfo": { "collectionInfo": {
"description": "Collection Info", "description": "Collection Info.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.CollectionInfo", "javaType": "org.openmetadata.catalog.type.CollectionInfo",
"properties": { "properties": {
"name": { "name": {
"description": "Unique name that identifies a collection", "description": "Unique name that identifies a collection.",
"type": "string" "type": "string"
}, },
"documentation": { "documentation": {
"description": "Description of collection", "description": "Description of collection.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"type": "string", "type": "string",
"description": "URL of the API endpoint where given collections are available", "description": "URL of the API endpoint where given collections are available.",
"format": "uri" "format": "uri"
}, },
"images": { "images": {

4
catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json
View File

@ -2,12 +2,12 @@
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Daily count of some measurement", "title": "Daily count of some measurement",
"description": "Type used for capturing and reporting daily count of some measurement, such as usage, joins", "description": "This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins.",
"type" : "object", "type" : "object",
"properties": { "properties": {
"count": { "count": {
"description": "Daily count of a measurement on the given date", "description": "Daily count of a measurement on the given date.",
"type": "integer", "type": "integer",
"minimum": 0 "minimum": 0
}, },

10
catalog-rest-service/src/main/resources/json/schema/type/entityReference.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/entityReference.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Entity Reference", "title": "Entity Reference",
"description": "Entity reference that includes entity ID and entity type", "description": "This schema defines the type Entity Reference used for referencing an entity.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.EntityReference", "javaType": "org.openmetadata.catalog.type.EntityReference",
"definitions": { "definitions": {
@ -16,7 +16,7 @@
}, },
"properties": { "properties": {
"id": { "id": {
"description": "Unique identifier that identifies an entity instance", "description": "Unique identifier that identifies an entity instance.",
"$ref": "basic.json#/definitions/uuid" "$ref": "basic.json#/definitions/uuid"
}, },
"type": { "type": {
@ -24,15 +24,15 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the entity instance", "description": "Name of the entity instance.",
"type": "string" "type": "string"
}, },
"description": { "description": {
"description": "Optional description of entity", "description": "Optional description of entity.",
"type": "string" "type": "string"
}, },
"href": { "href": {
"description": "Link to the entity resource", "description": "Link to the entity resource.",
"$ref": "basic.json#/definitions/href" "$ref": "basic.json#/definitions/href"
} }
}, },

6
catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json
View File

@ -2,16 +2,16 @@
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Usage details of an entity", "title": "Usage details of an entity",
"description": "Type used for capturing usage details of an entity", "description": "This schema defines type used for capturing usage details of an entity.",
"type" : "object", "type" : "object",
"properties": { "properties": {
"entity": { "entity": {
"description": "Entity for which usage is returned", "description": "Entity for which usage is returned.",
"$ref": "entityReference.json" "$ref": "entityReference.json"
}, },
"usage": { "usage": {
"description": "List usage details per day", "description": "List usage details per day.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "usageDetails.json" "$ref": "usageDetails.json"

6
catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.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/jdbcConnection.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "JDBC connection", "title": "JDBC connection",
"description": "JDBC connection information used for connecting to a database system", "description": "This schema defines type used for capturing JDBC connection information used for connecting to a database services.",
"type": "object", "type": "object",
"definitions": { "definitions": {
@ -45,11 +45,11 @@
"$ref" : "#/definitions/connectionUrl" "$ref" : "#/definitions/connectionUrl"
}, },
"userName": { "userName": {
"description": "Login user name", "description": "Login user name.",
"type": "string" "type": "string"
}, },
"password": { "password": {
"description": "Login password", "description": "Login password.",
"type": "string" "type": "string"
} }
}, },

6
catalog-rest-service/src/main/resources/json/schema/type/profile.json
View File

@ -1,13 +1,13 @@
{ {
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Type used to capture profile of a user, team, or an organization", "title": "Profile",
"description": "Type used to capture profile of a user, team, or an organization", "description": "This schema defines type used to capture profile of a user, team, or an organization.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.Profile", "javaType": "org.openmetadata.catalog.type.Profile",
"definitions": { "definitions": {
"imageList": { "imageList": {
"description": "Links to list of images of varying resolutions/sizes", "description": "Links to list of images of varying resolutions/sizes.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.ImageList", "javaType": "org.openmetadata.catalog.type.ImageList",
"properties": { "properties": {

6
catalog-rest-service/src/main/resources/json/schema/type/schedule.json
View File

@ -2,16 +2,16 @@
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Type used for schedule with start time and repeat frequency", "title": "Type used for schedule with start time and repeat frequency",
"description": "Type used for schedule with start time and repeat frequency", "description": "This schema defines type used for Schedule with start time and repeat frequency.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.Schedule", "javaType": "org.openmetadata.catalog.type.Schedule",
"properties": { "properties": {
"startDate": { "startDate": {
"description": "Start date and time of the schedule", "description": "Start date and time of the schedule.",
"$ref": "basic.json#/definitions/dateTime" "$ref": "basic.json#/definitions/dateTime"
}, },
"repeatFrequency": { "repeatFrequency": {
"description": "Repeat frequency in ISO 8601 duration format", "description": "Repeat frequency in ISO 8601 duration format.",
"$ref": "basic.json#/definitions/duration" "$ref": "basic.json#/definitions/duration"
} }
} }

4
catalog-rest-service/src/main/resources/json/schema/type/tagLabel.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/tagLabel.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Tag Label", "title": "Tag Label",
"description": "Type used for schedule with start time and repeat frequency", "description": "This schema defines type used for labeling an entity or an entity field with a Tag.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.TagLabel", "javaType": "org.openmetadata.catalog.type.TagLabel",
"properties": { "properties": {
@ -29,7 +29,7 @@
"default": "Confirmed" "default": "Confirmed"
}, },
"href": { "href": {
"description": "Link to the tag resource", "description": "Link to the tag resource.",
"$ref": "basic.json#/definitions/href" "$ref": "basic.json#/definitions/href"
} }
} }

14
catalog-rest-service/src/main/resources/json/schema/type/usageDetails.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/usageDetails.json", "$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json",
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
"title": "Type used to return usage details of an entity", "title": "Type used to return usage details of an entity",
"description": "Type used to return usage details of an entity", "description": "This schema defines type used for capturing usage details of an entity.",
"type": "object", "type": "object",
"javaType": "org.openmetadata.catalog.type.UsageDetails", "javaType": "org.openmetadata.catalog.type.UsageDetails",
"definitions": { "definitions": {
@ -12,12 +12,12 @@
"javaType": "org.openmetadata.catalog.type.UsageStats", "javaType": "org.openmetadata.catalog.type.UsageStats",
"properties": { "properties": {
"count": { "count": {
"Description": "Usage count of a data asset on the start date", "description": "Usage count of a data asset on the start date.",
"type": "integer", "type": "integer",
"minimum": 0 "minimum": 0
}, },
"percentileRank": { "percentileRank": {
"Description": "Optional daily percentile rank data asset use when relevant", "description": "Optional daily percentile rank data asset use when relevant.",
"type": "number", "type": "number",
"minimum": 0, "minimum": 0,
"maximum": 100 "maximum": 100
@ -31,19 +31,19 @@
}, },
"properties": { "properties": {
"dailyStats": { "dailyStats": {
"Description": "Daily usage stats of a data asset on the start date", "description": "Daily usage stats of a data asset on the start date.",
"$ref": "#/definitions/usageStats" "$ref": "#/definitions/usageStats"
}, },
"weeklyStats": { "weeklyStats": {
"Description": "Weekly (last 7 days) rolling usage stats of a data asset on the start date", "description": "Weekly (last 7 days) rolling usage stats of a data asset on the start date.",
"$ref": "#/definitions/usageStats" "$ref": "#/definitions/usageStats"
}, },
"monthlyStats": { "monthlyStats": {
"Description": "Monthly (last 30 days) rolling usage stats of a data asset on the start date", "description": "Monthly (last 30 days) rolling usage stats of a data asset on the start date.",
"$ref": "#/definitions/usageStats" "$ref": "#/definitions/usageStats"
}, },
"date": { "date": {
"Description": "Date in UTC time", "description": "Date in UTC time.",
"$ref": "basic.json#/definitions/date" "$ref": "basic.json#/definitions/date"
} }
}, },