plugins/ism: add refresh_search_analyzers action

Signed-off-by: Stefano Arlandini <[email protected]>

Author: ste93cry

CHANGELOG.md

@@ -7,6 +7,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Added
 - Adds `InnerHits` field to `SearchResp` ([#672](https://github.com/opensearch-project/opensearch-go/pull/672))
 - Adds `FilterPath` param ([#673](https://github.com/opensearch-project/opensearch-go/pull/673))
+- Adds the action to reload the search analyzers to the ISM plugin ([#686](https://github.com/opensearch-project/opensearch-go/pull/686))
 
 ### Changed
 ### Deprecated

plugins/ism/api_refresh_search_analyzers-params.go

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// The OpenSearch Contributors require contributions made to
+// this file be licensed under the Apache-2.0 license or a
+// compatible open source license.
+
+package ism
+
+import "strings"
+
+// ReloadSearchAnalyzersParams represents possible parameters for the RefreshSearchAnalyzersReq
+type ReloadSearchAnalyzersParams struct {
+	Pretty     bool
+	Human      bool
+	ErrorTrace bool
+	FilterPath []string
+}
+
+func (r ReloadSearchAnalyzersParams) get() map[string]string {
+	params := make(map[string]string)
+
+	if r.Pretty {
+		params["pretty"] = "true"
+	}
+
+	if r.Human {
+		params["human"] = "true"
+	}
+
+	if r.ErrorTrace {
+		params["error_trace"] = "true"
+	}
+
+	if len(r.FilterPath) > 0 {
+		params["filter_path"] = strings.Join(r.FilterPath, ",")
+	}
+
+	return params
+}

plugins/ism/api_refresh_search_analyzers.go

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: Apache-2.0
+//
+// The OpenSearch Contributors require contributions made to
+// this file be licensed under the Apache-2.0 license or a
+// compatible open source license.
+
+package ism
+
+import (
+	"context"
+	"net/http"
+	"strings"
+
+	"github.com/opensearch-project/opensearch-go/v4"
+)
+
+// RefreshSearchAnalyzers executes a request to refresh search analyzers with the required RefreshSearchAnalyzersReq
+func (c Client) RefreshSearchAnalyzers(ctx context.Context, req RefreshSearchAnalyzersReq) (RefreshSearchAnalyzersResp, error) {
+	var (
+		data RefreshSearchAnalyzersResp
+		err  error
+	)
+	if data.response, err = c.do(ctx, req, &data); err != nil {
+		return data, err
+	}
+
+	return data, nil
+}
+
+// RefreshSearchAnalyzersReq represents possible options for the /_plugins/_refresh_search_analyzers/<indices> request
+type RefreshSearchAnalyzersReq struct {
+	Indices []string
+
+	Header http.Header
+	Params ReloadSearchAnalyzersParams
+}
+
+// GetRequest returns the *http.Request that gets executed by the client
+func (r RefreshSearchAnalyzersReq) GetRequest() (*http.Request, error) {
+	indices := strings.Join(r.Indices, ",")
+
+	var path strings.Builder
+	path.Grow(len("/_plugins/_refresh_search_analyzers/") + len(indices))
+	path.WriteString("_plugins/_refresh_search_analyzers")
+	if len(r.Indices) > 0 {
+		path.WriteString("/")
+		path.WriteString(indices)
+	}
+
+	return opensearch.BuildRequest(
+		http.MethodPost,
+		path.String(),
+		nil,
+		r.Params.get(),
+		r.Header,
+	)
+}
+
+// RefreshSearchAnalyzersResp represents the returned struct of the refreshed search analyzers response
+type RefreshSearchAnalyzersResp struct {
+	Shards                   RefreshSearchAnalyzersShards                     `json:"_shards"`
+	SuccessfulRefreshDetails []RefreshSearchAnalyzersSuccessfulRefreshDetails `json:"successful_refresh_details"`
+	response                 *opensearch.Response
+}
+
+// Inspect returns the Inspect type containing the raw *opensearch.Reponse
+func (r RefreshSearchAnalyzersResp) Inspect() Inspect {
+	return Inspect{Response: r.response}
+}
+
+// RefreshSearchAnalyzersShards is a subtype of RefreshSearchAnalyzersResp representing information about the updated shards
+type RefreshSearchAnalyzersShards struct {
+	Total      int `json:"total"`
+	Successful int `json:"successful"`
+	Failed     int `json:"failed"`
+}
+
+// RefreshSearchAnalyzersSuccessfulRefreshDetails is a subtype of RefreshSearchAnalyzersResp representing information about the analyzers
+type RefreshSearchAnalyzersSuccessfulRefreshDetails struct {
+	Index              string   `json:"index"`
+	RefreshedAnalyzers []string `json:"refreshed_analyzers"`
+}

plugins/ism/api_test.go

@@ -209,6 +209,23 @@ func TestClient(t *testing.T) {
 				},
 			},
 		},
+		{
+			Name: "ReloadSearchAnalyzers",
+			Tests: []clientTests{
+				{
+					Name: "with request",
+					Results: func() (osismtest.Response, error) {
+						return client.RefreshSearchAnalyzers(nil, ism.RefreshSearchAnalyzersReq{Indices: testIndex})
+					},
+				},
+				{
+					Name: "inspect",
+					Results: func() (osismtest.Response, error) {
+						return failingClient.RefreshSearchAnalyzers(nil, ism.RefreshSearchAnalyzersReq{Indices: []string{"*"}})
+					},
+				},
+			},
+		},
 	}
 	for _, value := range testCases {
 		t.Run(value.Name, func(t *testing.T) {