From 026716eddab602157b6722a9887804dc3945bce5 Mon Sep 17 00:00:00 2001
From: Sarwaan Ansari <31755174+sarwaan001@users.noreply.github.com>
Date: Mon, 30 Dec 2024 16:44:11 +0000
Subject: [PATCH] fix: added docstring

---
 es.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/es.go b/es.go
index 8f4c704..3def58c 100644
--- 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")