update_index_metadata
Update metadata documentation for Elasticsearch indexes, including descriptions, purpose, data types, usage patterns, retention policies, related indices, and tags, to maintain accurate and organized index information.
Instructions
Update existing metadata documentation for an Elasticsearch index
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data_types | No | Updated types of data stored in this index | |
| description | No | Updated description of the index purpose and content | |
| index_name | Yes | Name of the index to update metadata for | |
| purpose | No | Updated primary purpose and use case | |
| related_indices | No | Updated related or dependent indices | |
| retention_policy | No | Updated data retention policy | |
| tags | No | Updated tags for categorization | |
| updated_by | No | Person or team making this update | Unknown |
| usage_pattern | No | Updated access pattern |
Input Schema (JSON Schema)
{
"properties": {
"data_types": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated types of data stored in this index",
"title": "Data Types"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated description of the index purpose and content",
"title": "Description"
},
"index_name": {
"description": "Name of the index to update metadata for",
"title": "Index Name",
"type": "string"
},
"purpose": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated primary purpose and use case",
"title": "Purpose"
},
"related_indices": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated related or dependent indices",
"title": "Related Indices"
},
"retention_policy": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated data retention policy",
"title": "Retention Policy"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated tags for categorization",
"title": "Tags"
},
"updated_by": {
"default": "Unknown",
"description": "Person or team making this update",
"title": "Updated By",
"type": "string"
},
"usage_pattern": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Updated access pattern",
"title": "Usage Pattern"
}
},
"required": [
"index_name"
],
"type": "object"
}