mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-24 05:58:31 +00:00
Doc cleanup - fixing gitbook rendering issues - part7
This commit is contained in:
sureshms
parent
d4eb8e9be0
commit
2954420fa7
@ -2,17 +2,16 @@
|
||||
"$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#",
|
||||
"title": "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.",
|
||||
"description": "This schema defines Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It runs as a special user in the system.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
"id": {
|
||||
"description": "Unique identifier that identifies an entity instance.",
|
||||
"description": "Unique identifier of a bot instance.",
|
||||
"$ref": "../type/basic.json#/definitions/uuid"
|
||||
},
|
||||
"name": {
|
||||
"description": "Optional name that identifies this entity. Same as id if name is not available.",
|
||||
"description": "Name of the bot.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
@ -22,11 +21,11 @@
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of entity instance.",
|
||||
"description": "Description of the bot.",
|
||||
"type": "string"
|
||||
},
|
||||
"href": {
|
||||
"description": "Link to the resource corresponding to this entity.",
|
||||
"description": "Link to the resource corresponding to this bot.",
|
||||
"$ref": "../type/basic.json#/definitions/href"
|
||||
}
|
||||
}
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Dashboard",
|
||||
"description": "This schema defines Dashboard entity.",
|
||||
"description": "This schema defines the Dashboard entity.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
@ -17,13 +17,13 @@
|
||||
"maxLength": 64
|
||||
},
|
||||
"fullyQualifiedName": {
|
||||
"description": "Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.",
|
||||
"description": "A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of dashboard, what it is and how to use it.",
|
||||
"description": "Description of the dashboard, what it is, and how to use it.",
|
||||
"type": "string"
|
||||
},
|
||||
"href": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Database",
|
||||
"description": "This schema defines Database entity. Database is a collection of schemas. They are also referred to as Database Catalog.",
|
||||
"description": "This schema defines the Database entity. A database is a collection of schemas. They are also referred to as Database Catalog.",
|
||||
"type": "object",
|
||||
|
||||
"definitions": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Metrics",
|
||||
"description": "This schema defines Metrics entity.",
|
||||
"description": "This schema defines the Metrics entity.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
@ -11,19 +11,19 @@
|
||||
"$ref": "../../type/basic.json#/definitions/uuid"
|
||||
},
|
||||
"name": {
|
||||
"description": "Name that identifies the this metrics instance uniquely.",
|
||||
"description": "Name that identifies this metrics instance uniquely.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"fullyQualifiedName": {
|
||||
"description": "Unique name that identifies a metric in the format 'ServiceName.MetricName'.",
|
||||
"description": "A unique name that identifies a metric in the format 'ServiceName.MetricName'.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of metrics instance. What is has and how to use it.",
|
||||
"description": "Description of metrics instance, what it is, and how to use it.",
|
||||
"type": "string"
|
||||
},
|
||||
"href": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Pipeline",
|
||||
"description": "This schema defines Pipeline entity.",
|
||||
"description": "This schema defines the Pipeline entity.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
@ -11,13 +11,13 @@
|
||||
"$ref": "../../type/basic.json#/definitions/uuid"
|
||||
},
|
||||
"name": {
|
||||
"description": "Name that identifies the this pipeline instance uniquely.",
|
||||
"description": "Name that identifies this pipeline instance uniquely.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"fullyQualifiedName": {
|
||||
"description": "Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.",
|
||||
"description": "A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Report",
|
||||
"description": "This schema defines Report entity.",
|
||||
"description": "This schema defines the Report entity.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
@ -17,7 +17,7 @@
|
||||
"maxLength": 64
|
||||
},
|
||||
"fullyQualifiedName": {
|
||||
"description": "Unique name that identifies a report in the format 'ServiceName.ReportName'.",
|
||||
"description": "A unique name that identifies a report in the format 'ServiceName.ReportName'.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Table",
|
||||
"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.",
|
||||
"description": "This schema defines the Table entity. A 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",
|
||||
"javaType": "org.openmetadata.catalog.entity.data.Table",
|
||||
"definitions": {
|
||||
@ -37,7 +37,7 @@
|
||||
},
|
||||
"columnDataType": {
|
||||
"javaType": "org.openmetadata.catalog.type.ColumnDataType",
|
||||
"description": "This enum defines the type for column data type.",
|
||||
"description": "This enum defines the type of data stored in a column.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"NUMBER",
|
||||
@ -173,7 +173,7 @@
|
||||
"columnJoins": {
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.ColumnJoin",
|
||||
"description": "This schema defines the type to capture how frequently a column in this table is joined with columns in the other tables.",
|
||||
"description": "This schema defines the type to capture how frequently a column are joined with columns in the other tables.",
|
||||
"properties": {
|
||||
"columnName": {
|
||||
"$ref": "#/definitions/columnName"
|
||||
@ -199,7 +199,7 @@
|
||||
"tableJoins": {
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.TableJoins",
|
||||
"description": "This schema defines the type to capture how columns in this table is joined with columns in the other tables.",
|
||||
"description": "This schema defines the type to capture how columns in this table are joined with columns in the other tables.",
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"description": "Date can be only from today going back to last 29 days.",
|
||||
@ -231,10 +231,10 @@
|
||||
}
|
||||
},
|
||||
"rows": {
|
||||
"description": "Data for a multiple rows of the table.",
|
||||
"description": "Data for multiple rows of the table.",
|
||||
"type": "array",
|
||||
"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 within the same order as columns fields.",
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
@ -248,7 +248,7 @@
|
||||
"$ref": "../../type/basic.json#/definitions/uuid"
|
||||
},
|
||||
"name": {
|
||||
"description": "Name of the table. Expected to be unique with in a database.",
|
||||
"description": "Name of the table. Expected to be unique within a database.",
|
||||
"$ref": "#/definitions/tableName"
|
||||
},
|
||||
"description": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Thread",
|
||||
"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.",
|
||||
"description": "This schema defines the Thread entity. A Thread is a collection of posts made by the users. The 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 mention Users or other Data Assets.",
|
||||
"type": "object",
|
||||
|
||||
"definitions": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Database Service",
|
||||
"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.",
|
||||
"description": "This schema defines the 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",
|
||||
"definitions": {
|
||||
"databaseServiceType": {
|
||||
@ -58,7 +58,7 @@
|
||||
"$ref": "#/definitions/databaseServiceType"
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of database service instance.",
|
||||
"description": "Description of a database service instance.",
|
||||
"type": "string"
|
||||
},
|
||||
"href": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "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.",
|
||||
"description": "This schema defines the 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 levels of tags are supported currently.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.TagCategory",
|
||||
"definitions": {
|
||||
|
||||
@ -2,12 +2,12 @@
|
||||
"$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#",
|
||||
"title": "Team",
|
||||
"description": "This schema defines Team entity. A Team is a group of zero or more users. Team can have ownership of data assets.",
|
||||
"description": "This schema defines the Team entity. A Team is a group of zero or more users and can have ownership of data assets.",
|
||||
"type": "object",
|
||||
|
||||
"definitions" : {
|
||||
"teamName" : {
|
||||
"description": "Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.",
|
||||
"description": "A unique name of the team typically the team ID from an identity provider. Example - group Id from ldap.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
|
||||
@ -2,12 +2,12 @@
|
||||
"$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#",
|
||||
"title": "User",
|
||||
"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.",
|
||||
"description": "This schema defines the 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",
|
||||
|
||||
"definitions": {
|
||||
"userName" : {
|
||||
"description": "Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.",
|
||||
"description": "A unique name of the user typically the user ID from an identity provider. Example - uid from ldap.",
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
@ -40,7 +40,7 @@
|
||||
"format": "timezone"
|
||||
},
|
||||
"deactivated" : {
|
||||
"description": "When true indicates user has been deactivated. Users are deactivated instead of deleted.",
|
||||
"description": "When true indicates the user has been deactivated. Users are deactivated instead of deleted.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"isBot" : {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$id": "https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json",
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "Audit Log",
|
||||
"description": "This schema defines type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations.",
|
||||
"description": "This schema defines the type for Audit Log to capture the audit trail of POST, PUT, and PATCH API operations.",
|
||||
"type": "object",
|
||||
|
||||
"properties" : {
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
"pattern": "^<#E/\\S+/\\S+>$"
|
||||
},
|
||||
"timestamp": {
|
||||
"description": "Time stamp in unixTimeMillis",
|
||||
"description": "Timestamp in unixTimeMillis",
|
||||
"type": "string",
|
||||
"format": "utc-millisec"
|
||||
},
|
||||
@ -47,11 +47,11 @@
|
||||
}
|
||||
},
|
||||
"duration": {
|
||||
"description": "Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'.",
|
||||
"description": "Duration in ISO 8601 format in UTC. Example - 'P23DT23H'.",
|
||||
"type": "string"
|
||||
},
|
||||
"date": {
|
||||
"description": "Date in ISO 8601 format in UTC time. Example - '2018-11-13'.",
|
||||
"description": "Date in ISO 8601 format in UTC. Example - '2018-11-13'.",
|
||||
"type": "string",
|
||||
"format": "date"
|
||||
},
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Daily count of some measurement",
|
||||
"description": "This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins.",
|
||||
"description": "This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins.",
|
||||
"type" : "object",
|
||||
|
||||
"properties": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Entity Reference",
|
||||
"description": "This schema defines the type Entity Reference used for referencing an entity.",
|
||||
"description": "This schema defines the type EntityReference used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.EntityReference",
|
||||
"definitions": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Usage details of an entity",
|
||||
"description": "This schema defines type used for capturing usage details of an entity.",
|
||||
"description": "This schema defines the type used for capturing usage details of an entity.",
|
||||
"type" : "object",
|
||||
|
||||
"properties": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "JDBC connection",
|
||||
"description": "This schema defines type used for capturing JDBC connection information used for connecting to a database services.",
|
||||
"description": "This schema defines the type used for JDBC connection information.",
|
||||
"type": "object",
|
||||
|
||||
"definitions": {
|
||||
|
||||
@ -2,12 +2,12 @@
|
||||
"$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#",
|
||||
"title": "Profile",
|
||||
"description": "This schema defines type used to capture profile of a user, team, or an organization.",
|
||||
"description": "This schema defines the type used to capture profile of a user, team, or an organization.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.Profile",
|
||||
"definitions": {
|
||||
"imageList": {
|
||||
"description": "Links to list of images of varying resolutions/sizes.",
|
||||
"description": "Links to a list of images of varying resolutions/sizes.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.ImageList",
|
||||
"properties": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Type used for schedule with start time and repeat frequency",
|
||||
"description": "This schema defines type used for Schedule with start time and repeat frequency.",
|
||||
"description": "This schema defines the type used for schedule with start time and repeat frequency.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.Schedule",
|
||||
"properties": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Tag Label",
|
||||
"description": "This schema defines type used for labeling an entity or an entity field with a Tag.",
|
||||
"description": "This schema defines the type used for labeling an entity with a Tag.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.TagLabel",
|
||||
"properties": {
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
"$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#",
|
||||
"title": "Type used to return usage details of an entity",
|
||||
"description": "This schema defines type used for capturing usage details of an entity.",
|
||||
"description": "This schema defines the type used for capturing usage details. Based on usage, daily, weekly, and monthly aggregation of usage is provided along with the percentile rank based on the usage.",
|
||||
"type": "object",
|
||||
"javaType": "org.openmetadata.catalog.type.UsageDetails",
|
||||
"definitions": {
|
||||
@ -43,7 +43,7 @@
|
||||
"$ref": "#/definitions/usageStats"
|
||||
},
|
||||
"date": {
|
||||
"description": "Date in UTC time.",
|
||||
"description": "Date in UTC.",
|
||||
"$ref": "basic.json#/definitions/date"
|
||||
}
|
||||
},
|
||||
|
||||
@ -129,7 +129,7 @@ GET /v1/tables/name/service.database.dim_user
|
||||
|
||||
### Getting entities with only necessary fields
|
||||
|
||||
To GET an entity with only necessary fields, pass `fields` query parameter while listing or getting an entity. This help clients control the amount of data returned in the response. Some fields may be included by default whether `fields` specifies them or not \(example - id and name fields below\):
|
||||
To GET an entity with only necessary fields, pass `fields` query parameter while listing or getting an entity. This helps clients control the amount of data returned in the response. Some fields may be included by default whether `fields` specifies them or not \(example - id and name fields below\):
|
||||
|
||||
```text
|
||||
GET /v1/tables/123e4567-e89b-42d3-a456-556642440000?fields=columns,tableConstraints,usage
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Bot
|
||||
|
||||
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.
|
||||
This schema defines Bot entity. A bot automates tasks, such as adding description, identifying the importance of data. It runs as a special user in the system.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitybots.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json</b>
|
||||
|
||||
@ -8,18 +8,18 @@ Type: `object`
|
||||
|
||||
## Properties
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json/properties/id">id</b>
|
||||
- Unique identifier that identifies an entity instance.
|
||||
- Unique identifier of a bot instance.
|
||||
- $ref: [../type/basic.json#/definitions/uuid](#..typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json/properties/name">name</b>
|
||||
- Optional name that identifies this entity. Same as id if name is not available.
|
||||
- Name of the bot.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json/properties/displayName">displayName</b>
|
||||
- Name used for display purposes. Example 'FirstName LastName'.
|
||||
- Type: `string`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json/properties/description">description</b>
|
||||
- Description of entity instance.
|
||||
- Description of the bot.
|
||||
- Type: `string`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/bots.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
- Link to the resource corresponding to this bot.
|
||||
- $ref: [../type/basic.json#/definitions/href](#..typebasic.jsondefinitionshref)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Dashboard
|
||||
|
||||
This schema defines Dashboard entity.
|
||||
This schema defines the Dashboard entity.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatadashboard.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json</b>
|
||||
|
||||
@ -15,11 +15,11 @@ Type: `object`
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
|
||||
- A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json/properties/description">description</b>
|
||||
- Description of dashboard, what it is and how to use it.
|
||||
- Description of the dashboard, what it is, and how to use it.
|
||||
- Type: `string`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/dashboard.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Database
|
||||
|
||||
This schema defines Database entity. Database is a collection of schemas. They are also referred to as Database Catalog.
|
||||
This schema defines the Database entity. A database is a collection of schemas. They are also referred to as Database Catalog.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatadatabase.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/database.json</b>
|
||||
|
||||
@ -36,8 +36,8 @@ Type: `object`
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_databaseName_**
|
||||
## Types defined in this schema
|
||||
**databaseName**
|
||||
|
||||
- Name that identifies the database.
|
||||
- Type: `string`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Metrics
|
||||
|
||||
This schema defines Metrics entity.
|
||||
This schema defines the Metrics entity.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatametrics.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json</b>
|
||||
|
||||
@ -11,15 +11,15 @@ Type: `object`
|
||||
- Unique identifier that identifies this metrics instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json/properties/name">name</b> `required`
|
||||
- Name that identifies the this metrics instance uniquely.
|
||||
- Name that identifies this metrics instance uniquely.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Unique name that identifies a metric in the format 'ServiceName.MetricName'.
|
||||
- A unique name that identifies a metric in the format 'ServiceName.MetricName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json/properties/description">description</b>
|
||||
- Description of metrics instance. What is has and how to use it.
|
||||
- Description of metrics instance, what it is, and how to use it.
|
||||
- Type: `string`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json/properties/href">href</b>
|
||||
- Link to the resource corresponding to this entity.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Pipeline
|
||||
|
||||
This schema defines Pipeline entity.
|
||||
This schema defines the Pipeline entity.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatapipeline.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json</b>
|
||||
|
||||
@ -11,11 +11,11 @@ Type: `object`
|
||||
- Unique identifier that identifies a pipeline instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json/properties/name">name</b> `required`
|
||||
- Name that identifies the this pipeline instance uniquely.
|
||||
- Name that identifies this pipeline instance uniquely.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
|
||||
- A unique name that identifies a pipeline in the format 'ServiceName.PipelineName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/pipeline.json/properties/description">description</b>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Report
|
||||
|
||||
This schema defines Report entity.
|
||||
This schema defines the Report entity.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatareport.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json</b>
|
||||
|
||||
@ -15,7 +15,7 @@ Type: `object`
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- Unique name that identifies a report in the format 'ServiceName.ReportName'.
|
||||
- A unique name that identifies a report in the format 'ServiceName.ReportName'.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/report.json/properties/description">description</b>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Table
|
||||
|
||||
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.
|
||||
This schema defines the Table entity. A 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.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitydatatable.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json</b>
|
||||
|
||||
@ -11,7 +11,7 @@ Type: `object`
|
||||
- Unique identifier of this table instance.
|
||||
- $ref: [../../type/basic.json#/definitions/uuid](#....typebasic.jsondefinitionsuuid)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/name">name</b> `required`
|
||||
- Name of the table. Expected to be unique with in a database.
|
||||
- Name of the table. Expected to be unique within a database.
|
||||
- $ref: [#/definitions/tableName](#/definitions/tableName)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/description">description</b>
|
||||
- Description of the table.
|
||||
@ -27,12 +27,12 @@ Type: `object`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/columns">columns</b> `required`
|
||||
- Columns in this table.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/column](#/definitions/column)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tableConstraints">tableConstraints</b>
|
||||
- Table constraints.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/tableConstraint](#/definitions/tableConstraint)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/usageSummary">usageSummary</b>
|
||||
- Latest usage information for this table.
|
||||
@ -49,7 +49,7 @@ Type: `object`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/tags">tags</b>
|
||||
- Tags for this table.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](#....typetaglabel.json)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/properties/joins">joins</b>
|
||||
- Details of other tables this table is frequently joined with.
|
||||
@ -59,8 +59,8 @@ Type: `object`
|
||||
- $ref: [#/definitions/tableData](#/definitions/tableData)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_tableType_**
|
||||
## Types defined in this schema
|
||||
**tableType**
|
||||
|
||||
- This schema defines the type for a column in a table.
|
||||
- Type: `string`
|
||||
@ -72,9 +72,9 @@ Type: `object`
|
||||
5. _"MaterializedView"_
|
||||
|
||||
|
||||
**_columnDataType_**
|
||||
**columnDataType**
|
||||
|
||||
- This enum defines the type for column data type.
|
||||
- This enum defines the type of data stored in a column.
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
1. _"NUMBER"_
|
||||
@ -112,7 +112,7 @@ Type: `object`
|
||||
33. _"JSON"_
|
||||
|
||||
|
||||
**_columnConstraint_**
|
||||
**columnConstraint**
|
||||
|
||||
- This enum defines the type for column constraint.
|
||||
- Type: `string`
|
||||
@ -124,11 +124,11 @@ Type: `object`
|
||||
- Default: _"NULL"_
|
||||
|
||||
|
||||
**_tableConstraint_**
|
||||
**tableConstraint**
|
||||
|
||||
- This enum defines the type for table constraint.
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableConstraint/properties/constraintType">constraintType</b>
|
||||
- Type: `string`
|
||||
- The value is restricted to the following:
|
||||
@ -138,11 +138,11 @@ Type: `object`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableConstraint/properties/columns">columns</b>
|
||||
- List of column names corresponding to the constraint.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- Type: `string`
|
||||
|
||||
|
||||
**_columnName_**
|
||||
**columnName**
|
||||
|
||||
- Local name (not fully qualified name) of the column.
|
||||
- Type: `string`
|
||||
@ -150,7 +150,7 @@ Type: `object`
|
||||
- Length: between 1 and 64
|
||||
|
||||
|
||||
**_tableName_**
|
||||
**tableName**
|
||||
|
||||
- Local name (not fully qualified name) of the table.
|
||||
- Type: `string`
|
||||
@ -158,18 +158,18 @@ Type: `object`
|
||||
- Length: between 1 and 64
|
||||
|
||||
|
||||
**_fullyQualifiedColumnName_**
|
||||
**fullyQualifiedColumnName**
|
||||
|
||||
- Fully qualified name of the column that includes `serviceName.databaseName.tableName.columnName`.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 256
|
||||
|
||||
|
||||
**_column_**
|
||||
**column**
|
||||
|
||||
- This schema defines the type for a column in a table.
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/name">name</b> `required`
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/columnDataType">columnDataType</b> `required`
|
||||
@ -183,7 +183,7 @@ Type: `object`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/tags">tags</b>
|
||||
- Tags associated with the column.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [../../type/tagLabel.json](#....typetaglabel.json)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/column/properties/columnConstraint">columnConstraint</b>
|
||||
- Column level constraint.
|
||||
@ -193,32 +193,32 @@ Type: `object`
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
**_columnJoins_**
|
||||
**columnJoins**
|
||||
|
||||
- This schema defines the type to capture how frequently a column in this table is joined with columns in the other tables.
|
||||
- This schema defines the type to capture how frequently a column are joined with columns in the other tables.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins/properties/columnName">columnName</b>
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith">joinedWith</b>
|
||||
- Fully qualified names of the columns that this column is joined with.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith/items/properties/fullyQualifiedName">fullyQualifiedName</b>
|
||||
- $ref: [#/definitions/fullyQualifiedColumnName](#/definitions/fullyQualifiedColumnName)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/columnJoins/properties/joinedWith/items/properties/joinCount">joinCount</b>
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
**_tableJoins_**
|
||||
**tableJoins**
|
||||
|
||||
- This schema defines the type to capture how columns in this table is joined with columns in the other tables.
|
||||
- This schema defines the type to capture how columns in this table are joined with columns in the other tables.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableJoins/properties/startDate">startDate</b>
|
||||
- Date can be only from today going back to last 29 days.
|
||||
- $ref: [../../type/basic.json#/definitions/date](#....typebasic.jsondefinitionsdate)
|
||||
@ -227,26 +227,26 @@ Type: `object`
|
||||
- Default: `1`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableJoins/properties/columnJoins">columnJoins</b>
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/columnJoins](#/definitions/columnJoins)
|
||||
|
||||
|
||||
**_tableData_**
|
||||
**tableData**
|
||||
|
||||
- This schema defines the type to capture rows of sample data for the table.
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableData/properties/columns">columns</b>
|
||||
- List of local column names (not fully qualified column names) of the table.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/columnName](#/definitions/columnName)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/data/table.json/definitions/tableData/properties/rows">rows</b>
|
||||
- Data for a multiple rows of the table.
|
||||
- Data for multiple rows of the table.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- Data for a single row of the table with in the same order as columns fields.
|
||||
- **Items**
|
||||
- Data for a single row of the table within the same order as columns fields.
|
||||
- Type: `array`
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Thread
|
||||
|
||||
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.
|
||||
This schema defines the Thread entity. A Thread is a collection of posts made by the users. The 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 mention Users or other Data Assets.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentityfeedthread.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json</b>
|
||||
|
||||
@ -23,16 +23,16 @@ Type: `object`
|
||||
- $ref: [../../type/basic.json#/definitions/entityLink](#....typebasic.jsondefinitionsentitylink)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json/properties/posts">posts</b> `required`
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/post](#/definitions/post)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_post_**
|
||||
## Types defined in this schema
|
||||
**post**
|
||||
|
||||
- Post within a feed.
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/feed/thread.json/definitions/post/properties/message">message</b> `required`
|
||||
- Message in markdown format. See markdown support for more details.
|
||||
- Type: `string`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Database Service
|
||||
|
||||
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.
|
||||
This schema defines the Database Service entity, such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentityservicesdatabaseservice.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json</b>
|
||||
|
||||
@ -18,7 +18,7 @@ Type: `object`
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- $ref: [#/definitions/databaseServiceType](#/definitions/databaseServiceType)
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json/properties/description">description</b>
|
||||
- Description of database service instance.
|
||||
- Description of a database service instance.
|
||||
- Type: `string`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/services/databaseService.json/properties/href">href</b> `required`
|
||||
- Link to the resource corresponding to this database service.
|
||||
@ -31,8 +31,8 @@ Type: `object`
|
||||
- $ref: [../../type/schedule.json](#....typeschedule.json)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_databaseServiceType_**
|
||||
## Types defined in this schema
|
||||
**databaseServiceType**
|
||||
|
||||
- Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres...
|
||||
- Type: `string`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Tag Category
|
||||
|
||||
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.
|
||||
This schema defines the 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 levels of tags are supported currently.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentitytagstagcategory.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json</b>
|
||||
|
||||
@ -25,19 +25,19 @@ This schema <u>does not</u> accept additional properties.
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/tags/tagCategory.json/properties/children">children</b>
|
||||
- Tags under this category.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [#/definitions/tag](#/definitions/tag)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_tagName_**
|
||||
## Types defined in this schema
|
||||
**tagName**
|
||||
|
||||
- Name of the tag.
|
||||
- Type: `string`
|
||||
- Length: between 2 and 25
|
||||
|
||||
|
||||
**_tagCategoryType_**
|
||||
**tagCategoryType**
|
||||
|
||||
- Type of tag category.
|
||||
- Type: `string`
|
||||
@ -46,7 +46,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
2. _"Classification"_
|
||||
|
||||
|
||||
**_tag_**
|
||||
**tag**
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Team
|
||||
|
||||
This schema defines Team entity. A Team is a group of zero or more users. Team can have ownership of data assets.
|
||||
This schema defines the Team entity. A Team is a group of zero or more users and can have ownership of data assets.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentityteamsteam.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/team.json</b>
|
||||
|
||||
@ -34,10 +34,10 @@ Type: `object`
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_teamName_**
|
||||
## Types defined in this schema
|
||||
**teamName**
|
||||
|
||||
- Unique name of the team typically the team ID from the identify provider. Example - group Id from ldap.
|
||||
- A unique name of the team typically the team ID from an identity provider. Example - group Id from ldap.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# User
|
||||
|
||||
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.
|
||||
This schema defines the 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.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschemaentityteamsuser.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json</b>
|
||||
|
||||
@ -28,7 +28,7 @@ This schema <u>does not</u> accept additional properties.
|
||||
- Type: `string`
|
||||
- String format must be a "timezone"
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/deactivated">deactivated</b>
|
||||
- When true indicates user has been deactivated. Users are deactivated instead of deleted.
|
||||
- When true indicates the user has been deactivated. Users are deactivated instead of deleted.
|
||||
- Type: `boolean`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/entity/teams/user.json/properties/isBot">isBot</b>
|
||||
- When true indicates a special type of user called Bot.
|
||||
@ -50,10 +50,10 @@ This schema <u>does not</u> accept additional properties.
|
||||
- $ref: [../../type/entityReference.json#/definitions/entityReferenceList](#....typeentityreference.jsondefinitionsentityreferencelist)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_userName_**
|
||||
## Types defined in this schema
|
||||
**userName**
|
||||
|
||||
- Unique name of the user typically the user ID from the identify provider. Example - uid from ldap.
|
||||
- A unique name of the user typically the user ID from an identity provider. Example - uid from ldap.
|
||||
- Type: `string`
|
||||
- Length: between 1 and 64
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Audit Log
|
||||
|
||||
This schema defines type for Audit Log. Audit Log is used to capture audit trail of POST, PUT, and PATCH API operations.
|
||||
This schema defines the type for Audit Log to capture the audit trail of POST, PUT, and PATCH API operations.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeauditlog.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/auditLog.json</b>
|
||||
|
||||
|
||||
@ -6,15 +6,15 @@ This schema defines basic common types that are used by other schemas.
|
||||
|
||||
|
||||
|
||||
## Definitions
|
||||
**_uuid_**
|
||||
## Types defined in this schema
|
||||
**uuid**
|
||||
|
||||
- Unique id used to identify an entity.
|
||||
- Type: `string`
|
||||
- String format must be a "uuid"
|
||||
|
||||
|
||||
**_email_**
|
||||
**email**
|
||||
|
||||
- Email address of a user or other entities.
|
||||
- Type: `string`
|
||||
@ -23,31 +23,31 @@ This schema defines basic common types that are used by other schemas.
|
||||
- Length: between 6 and 127
|
||||
|
||||
|
||||
**_entityLink_**
|
||||
**entityLink**
|
||||
|
||||
- Link to an entity or field of an entity of format `<#E/{enties}/{entityName}/{field}/{fieldValue}`.
|
||||
- Type: `string`
|
||||
- The value must match this pattern: `^<#E/\S+/\S+>$`
|
||||
|
||||
|
||||
**_timestamp_**
|
||||
**timestamp**
|
||||
|
||||
- Time stamp in unixTimeMillis
|
||||
- Timestamp in unixTimeMillis
|
||||
- Type: `string`
|
||||
- String format must be a "utc-millisec"
|
||||
|
||||
|
||||
**_href_**
|
||||
**href**
|
||||
|
||||
- href that points to a resource.
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
**_timeInterval_**
|
||||
**timeInterval**
|
||||
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/basic.json/definitions/timeInterval/properties/start">start</b>
|
||||
- Start time in unixTimeMillis.
|
||||
- Type: `integer`
|
||||
@ -56,20 +56,20 @@ This schema defines basic common types that are used by other schemas.
|
||||
- Type: `integer`
|
||||
|
||||
|
||||
**_duration_**
|
||||
**duration**
|
||||
|
||||
- Duration in ISO 8601 format in UTC time. Example - 'P23DT23H'.
|
||||
- Type: `string`
|
||||
|
||||
|
||||
**_date_**
|
||||
**date**
|
||||
|
||||
- Date in ISO 8601 format in UTC time. Example - '2018-11-13'.
|
||||
- Type: `string`
|
||||
- String format must be a "date"
|
||||
|
||||
|
||||
**_dateTime_**
|
||||
**dateTime**
|
||||
|
||||
- Date and time in ISO 8601 format. Example - '2018-11-13T20:20:39+00:00'.
|
||||
- Type: `string`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Daily count of some measurement
|
||||
|
||||
This schema defines type used for capturing and reporting daily count of some measurement, such as usage, joins.
|
||||
This schema defines the type used for capturing and reporting the daily count of some measurement, such as usage, joins.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypedailycount.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/dailyCount.json</b>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Entity Reference
|
||||
|
||||
This schema defines the type Entity Reference used for referencing an entity.
|
||||
This schema defines the type EntityReference used for referencing an entity. EntityReference is used for capturing relationship from one entity to another. For example, table has an attribute called database of type EntityReference that captures the relationship of a table `belongs to a` database.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeentityreference.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityReference.json</b>
|
||||
|
||||
@ -24,11 +24,11 @@ Type: `object`
|
||||
- $ref: [basic.json#/definitions/href](#basic.jsondefinitionshref)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_entityReferenceList_**
|
||||
## Types defined in this schema
|
||||
**entityReferenceList**
|
||||
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [entityReference.json](#entityreference.json)
|
||||
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Usage details of an entity
|
||||
|
||||
This schema defines type used for capturing usage details of an entity.
|
||||
This schema defines the type used for capturing usage details of an entity.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeentityusage.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json</b>
|
||||
|
||||
@ -13,5 +13,5 @@ Type: `object`
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/entityUsage.json/properties/usage">usage</b> `required`
|
||||
- List usage details per day.
|
||||
- Type: `array`
|
||||
- **_Items_**
|
||||
- **Items**
|
||||
- $ref: [usageDetails.json](#usagedetails.json)
|
||||
|
||||
@ -21,25 +21,25 @@ Type: `object`
|
||||
- Type: `string`
|
||||
|
||||
|
||||
## Definitions
|
||||
**_driverClass_**
|
||||
## Types defined in this schema
|
||||
**driverClass**
|
||||
|
||||
- Type used for JDBC driver class
|
||||
- Type: `string`
|
||||
|
||||
|
||||
**_connectionUrl_**
|
||||
**connectionUrl**
|
||||
|
||||
- Type used for JDBC connection URL
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
|
||||
**_jdbcInfo_**
|
||||
**jdbcInfo**
|
||||
|
||||
- Type for capturing JDBC connector information
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/jdbcConnection.json/definitions/jdbcInfo/properties/driverClass">driverClass</b> `required`
|
||||
- $ref: [#/definitions/driverClass](#/definitions/driverClass)
|
||||
- Default: _"com.amazon.redshift.jdbc42.Driver"_
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Profile
|
||||
|
||||
This schema defines type used to capture profile of a user, team, or an organization.
|
||||
This schema defines the type used to capture profile of a user, team, or an organization.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeprofile.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json</b>
|
||||
|
||||
@ -11,12 +11,12 @@ Type: `object`
|
||||
- $ref: [#/definitions/imageList](#/definitions/imageList)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_imageList_**
|
||||
## Types defined in this schema
|
||||
**imageList**
|
||||
|
||||
- Links to list of images of varying resolutions/sizes.
|
||||
- Links to a list of images of varying resolutions/sizes.
|
||||
- Type: `object`
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/profile.json/definitions/imageList/properties/image">image</b>
|
||||
- Type: `string`
|
||||
- String format must be a "uri"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Type used for schedule with start time and repeat frequency
|
||||
|
||||
This schema defines type used for Schedule with start time and repeat frequency.
|
||||
This schema defines the type used for schedule with start time and repeat frequency.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeschedule.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/schedule.json</b>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Tag Label
|
||||
|
||||
This schema defines type used for labeling an entity or an entity field with a Tag.
|
||||
This schema defines the type used for labeling an entity with a Tag.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypetaglabel.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/tagLabel.json</b>
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Type used to return usage details of an entity
|
||||
|
||||
This schema defines type used for capturing usage details of an entity.
|
||||
This schema defines the type used for capturing usage details. Based on usage, daily, weekly, and monthly aggregation of usage is provided along with the percentile rank based on the usage.
|
||||
|
||||
<b id="httpsgithub.comopen-metadataopenmetadatablobmaincatalog-rest-servicesrcmainresourcesjsonschematypeusagedetails.json">$id: https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json</b>
|
||||
|
||||
@ -21,13 +21,13 @@ Type: `object`
|
||||
- $ref: [basic.json#/definitions/date](#basic.jsondefinitionsdate)
|
||||
|
||||
|
||||
## Definitions
|
||||
**_usageStats_**
|
||||
## Types defined in this schema
|
||||
**usageStats**
|
||||
|
||||
- Type used to return usage statistics
|
||||
- Type: `object`
|
||||
- This schema <u>does not</u> accept additional properties.
|
||||
- **_Properties_**
|
||||
- **Properties**
|
||||
- <b id="#https://github.com/open-metadata/OpenMetadata/blob/main/catalog-rest-service/src/main/resources/json/schema/type/usageDetails.json/definitions/usageStats/properties/count">count</b> `required`
|
||||
- Usage count of a data asset on the start date.
|
||||
- Type: `integer`
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user