create_index_metadata
Create metadata documentation for Elasticsearch indices to define purpose, data types, retention policy, and relationships, supporting index governance and clear usage context.
Instructions
Create metadata documentation for an Elasticsearch index to ensure proper governance and documentation
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index_name | Yes | Name of the index to document | |
| description | Yes | Detailed description of the index purpose and content | |
| purpose | Yes | Primary purpose and use case for this index | |
| data_types | No | Types of data stored in this index (e.g., 'documents', 'logs', 'metrics') | |
| usage_pattern | No | How the index is accessed (e.g., 'read-heavy', 'write-heavy', 'mixed') | mixed |
| retention_policy | No | Data retention policy and lifecycle management | No specific policy |
| related_indices | No | Names of related or dependent indices | |
| tags | No | Tags for categorizing and organizing indices | |
| created_by | No | Team or person responsible for this index | Unknown |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |