Support passing name filter to ListStores (#213)

* Add filter by name for list stores

* fix

* Make sure to pass along the query parameter

Author: Oscmage

README.md

@@ -238,6 +238,7 @@ Get a paginated list of stores.
 options := ClientListStoresOptions{
   PageSize:          openfga.PtrInt32(10),
   ContinuationToken: openfga.PtrString("..."),
+  Name:              openfga.PtrString("FGA Demo Store"), // Optional: filter stores by name
 }
 stores, err := fgaClient.ListStores(context.Background()).Options(options).Execute()
 

api_open_fga.go

@@ -2501,17 +2501,24 @@ type ApiListStoresRequest struct {
 	ApiService        OpenFgaApi
 	pageSize          *int32
 	continuationToken *string
+	name              *string
 }
 
 func (r ApiListStoresRequest) PageSize(pageSize int32) ApiListStoresRequest {
 	r.pageSize = &pageSize
 	return r
 }
+
 func (r ApiListStoresRequest) ContinuationToken(continuationToken string) ApiListStoresRequest {
 	r.continuationToken = &continuationToken
 	return r
 }
 
+func (r ApiListStoresRequest) Name(name string) ApiListStoresRequest {
+	r.name = &name
+	return r
+}
+
 func (r ApiListStoresRequest) Execute() (ListStoresResponse, *http.Response, error) {
 	return r.ApiService.ListStoresExecute(r)
 }
@@ -2558,6 +2565,9 @@ func (a *OpenFgaApiService) ListStoresExecute(r ApiListStoresRequest) (ListStore
 	if r.continuationToken != nil {
 		localVarQueryParams.Add("continuation_token", parameterToString(*r.continuationToken, ""))
 	}
+	if r.name != nil {
+		localVarQueryParams.Add("name", parameterToString(*r.name, ""))
+	}
 	// to determine the Content-Type header
 	localVarHTTPContentTypes := []string{}
 

client/client.go

@@ -181,6 +181,13 @@ func getContinuationTokenFromRequest(options *ClientPaginationOptions) *string {
 	return options.ContinuationToken
 }
 
+func getNameFromRequest(options *ClientListStoresOptions) *string {
+	if options == nil {
+		return nil
+	}
+	return options.Name
+}
+
 type SdkClient interface {
 	/* Stores */
 
@@ -579,6 +586,7 @@ type SdkClientListStoresRequestInterface interface {
 type ClientListStoresOptions struct {
 	PageSize          *int32  `json:"page_size,omitempty"`
 	ContinuationToken *string `json:"continuation_token,omitempty"`
+	Name              *string `json:"name,omitempty"`
 }
 
 type ClientListStoresResponse = fgaSdk.ListStoresResponse
@@ -602,13 +610,17 @@ func (request *SdkClientListStoresRequest) GetOptions() *ClientListStoresOptions
 
 func (client *OpenFgaClient) ListStoresExecute(request SdkClientListStoresRequestInterface) (*ClientListStoresResponse, error) {
 	req := client.OpenFgaApi.ListStores(request.GetContext())
-	pageSize := getPageSizeFromRequest((*ClientPaginationOptions)(request.GetOptions()))
-	if pageSize != nil {
-		req = req.PageSize(*pageSize)
-	}
-	continuationToken := getContinuationTokenFromRequest((*ClientPaginationOptions)(request.GetOptions()))
-	if continuationToken != nil {
-		req = req.ContinuationToken(*continuationToken)
+	options := request.GetOptions()
+	if options != nil {
+		if options.PageSize != nil {
+			req = req.PageSize(*options.PageSize)
+		}
+		if options.ContinuationToken != nil {
+			req = req.ContinuationToken(*options.ContinuationToken)
+		}
+		if options.Name != nil {
+			req = req.Name(*options.Name)
+		}
 	}
 	data, _, err := req.Execute()
 	if err != nil {

client/client_test.go

@@ -23,7 +23,7 @@ import (
 
 	"github.com/jarcoal/httpmock"
 
-	"github.com/openfga/go-sdk"
+	openfga "github.com/openfga/go-sdk"
 	. "github.com/openfga/go-sdk/client"
 )
 
@@ -218,6 +218,53 @@ func TestOpenFgaClient(t *testing.T) {
 		}
 	})
 
+	t.Run("ListStoresWithNameFilter", func(t *testing.T) {
+		filteredStoreName := "Filtered Store"
+		test := TestDefinition{
+			Name:           "ListStoresWithNameFilter",
+			JsonResponse:   fmt.Sprintf(`{"stores":[{"id":"01GXSA8YR785C4FYS3C0RTG7B1","name":"%s","created_at":"2023-01-01T23:23:23.000000000Z","updated_at":"2023-01-01T23:23:23.000000000Z"}]}`, filteredStoreName),
+			ResponseStatus: http.StatusOK,
+			Method:         http.MethodGet,
+		}
+
+		var expectedResponse openfga.ListStoresResponse
+		if err := json.Unmarshal([]byte(test.JsonResponse), &expectedResponse); err != nil {
+			t.Fatalf("%v", err)
+		}
+
+		httpmock.Activate()
+		defer httpmock.DeactivateAndReset()
+		httpmock.RegisterResponder(test.Method, fmt.Sprintf("%s/stores", fgaClient.GetConfig().ApiUrl),
+			func(req *http.Request) (*http.Response, error) {
+				// Verify that the name parameter is included in the query
+				if req.URL.Query().Get("name") != filteredStoreName {
+					t.Fatalf("expected name parameter to be '%s', got %s", filteredStoreName, req.URL.Query().Get("name"))
+				}
+				resp, err := httpmock.NewJsonResponse(test.ResponseStatus, expectedResponse)
+				if err != nil {
+					return httpmock.NewStringResponse(http.StatusInternalServerError, ""), nil
+				}
+				return resp, nil
+			},
+		)
+
+		options := ClientListStoresOptions{
+			Name: openfga.PtrString(filteredStoreName),
+		}
+		got, err := fgaClient.ListStores(context.Background()).Options(options).Execute()
+		if err != nil {
+			t.Fatalf("%v", err)
+		}
+
+		if len(got.Stores) != 1 {
+			t.Fatalf("expected stores of length 1, got %v", len(got.Stores))
+		}
+
+		if got.Stores[0].Name != filteredStoreName {
+			t.Fatalf("expected store name to be '%s', got %s", filteredStoreName, got.Stores[0].Name)
+		}
+	})
+
 	t.Run("CreateStore", func(t *testing.T) {
 		test := TestDefinition{
 			Name:           "CreateStore",

example/example1/example1.go

@@ -68,6 +68,16 @@ func mainInner() error {
 	}
 	fmt.Printf("Stores Count: %d\n", len(stores.Stores))
 
+	// ListStores with name filter
+	fmt.Println("Listing Stores with name filter")
+	storesWithFilter, err := fgaClient.ListStores(ctx).Options(client.ClientListStoresOptions{
+		Name: openfga.PtrString("Test Store"),
+	}).Execute()
+	if err != nil {
+		return err
+	}
+	fmt.Printf("Stores with name filter Count: %d\n", len(storesWithFilter.Stores))
+
 	// GetStore
 	fmt.Println("Getting Current Store")
 	currentStore, err := fgaClient.GetStore(ctx).Execute()