Skip to content

Commit

Permalink
Update IndexMappingToolDescription (#1982)
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Widdis <[email protected]>
  • Loading branch information
dbwiddis authored Feb 3, 2024
1 parent c0691b6 commit 34a9f8e
Showing 1 changed file with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ public class IndexMappingTool implements Tool {
.join(
" ",
"This tool gets index mapping information from a certain index.",
"It takes 1 required argument named `index` which is a comma-delimited list of one or more indices to get mapping information from, which expands wildcards.",
"It takes 1 optional argument named `local` which means whether to return information from the local node only instead of the cluster manager node (Default is false).",
"The tool returns the index mapping information, which is about how documents and their fields are stored and indexed, and also returns the index settings."
"It takes 1 required argument named 'index' which is a comma-delimited list of one or more indices to get mapping information from, which expands wildcards.",
"It takes 1 optional argument named 'local' which means whether to return information from the local node only instead of the cluster manager node (Default is false).",
"The tool returns a list of index mappings and settings for each index.",
"The mappings are in JSON format under the key 'properties' which includes the field name as a key and a JSON object with field type under the key 'type'.",
"The settings are in flattened map with 'index' as the top element and key-value pairs for each setting."
);

@Setter
Expand Down

0 comments on commit 34a9f8e

Please sign in to comment.