fix: added docstring

sarwaan001 · sarwaan001 · commit 026716eddab6 · 2024-12-30T16:44:11.000Z
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")

Original file line number	Diff line number	Diff line change
`@@ -1174,6 +1174,9 @@ func (c *Client) SnapshotAllIndices(repository string, snapshot string) error {`
`1174`	`1174`	`return err`
`1175`	`1175`	`}`
`1176`	`1176`
	`1177`	`+// Take a snapshot of all indices on the cluster to the given repository with body params`
	`1178`	`+//`
	`1179`	`+// Use case: You want to backup all of the indices on the cluster to the given repository with body params`
`1177`	`1180`	`func (c *Client) SnapshotAllIndicesWithBodyParams(repository string, snapshot string, bodyParams map[string]interface{}) error {`
`1178`	`1181`	`if repository == "" {`
`1179`	`1182`	`return errors.New("empty string for repository is not allowed")`