mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-04 11:33:07 +00:00
26 lines
1.8 KiB
Markdown
26 lines
1.8 KiB
Markdown
# 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.
|
|
|
|
<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>
|
|
|
|
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.
|
|
- $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.
|
|
- 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.
|
|
- 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.
|
|
- $ref: [../type/basic.json#/definitions/href](#..typebasic.jsondefinitionshref)
|