fix: added docstring

github · Dec 30, 2024 · 026716e · 026716e
1 parent 309cd67
commit 026716e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/es.go b/es.go
@@ -1174,6 +1174,9 @@ func (c *Client) SnapshotAllIndices(repository string, snapshot string) error {
 	return err
 }
 
+// Take a snapshot of all indices on the cluster to the given repository with body params
+//
+// Use case: You want to backup all of the indices on the cluster to the given repository with body params
 func (c *Client) SnapshotAllIndicesWithBodyParams(repository string, snapshot string, bodyParams map[string]interface{}) error {
 	if repository == "" {
 		return errors.New("empty string for repository is not allowed")