doc: tidy up

Author: Muhammad Ikhsan

README.md

@@ -23,20 +23,20 @@ steinClient = gostein.New("http://yourstein.host/v1/storage/your-api-id", nil)
 ```go
 ...
 // Get all data
-data, err := steinClient.Get("sheet1", gostein.SearchParams{})
+data, err := steinClient.Get("sheet1", gostein.GetParams{})
 
 // Get with offset and limit
-data, err := steinClient.Get("sheet1", gostein.SearchParams{Offset: 0, Limit: 10})
+data, err := steinClient.Get("sheet1", gostein.GetParams{Offset: 0, Limit: 10})
 ...
 ```
 The `data` will be in type of `[]map[string]interface{}`. To convert the data to specific struct, I recomended using [maptostructure package](https://github.com/mitchellh/mapstructure).
 
 #### Search data
 Look up rows in a sheet by a specific value on column(s).
 ```go
-data, err := steinClient.Get("sheet1", gostein.SearchParams{
+data, err := steinClient.Get("sheet1", gostein.GetParams{
     Limit: 10,
-    Conditions: map[string]string{
+    Search: map[string]string{
             "column_1": "value_column_1",
             "column_2": "value_column_2",
         }

stein.go

@@ -9,18 +9,18 @@ import (
 	"strings"
 )
 
-type SearchParams struct {
-	Offset     int64
-	Limit      int64
-	Conditions map[string]string
+type GetParams struct {
+	Offset int64
+	Limit  int64
+	Search map[string]string
 }
 
 type AddResponse struct {
 	UpdatedRange string `json:"updatedRange"`
 }
 
 // builds the query string from the given params with query string escaping
-func (sp SearchParams) queryString() string {
+func (sp GetParams) queryString() string {
 	queryString := ""
 	if sp.Offset > 0 {
 		queryString = queryString + fmt.Sprintf("offset=%d&", sp.Offset)
@@ -30,8 +30,8 @@ func (sp SearchParams) queryString() string {
 		queryString = queryString + fmt.Sprintf("limit=%d&", sp.Limit)
 	}
 
-	if len(sp.Conditions) > 0 {
-		jsonSearch, err := json.Marshal(sp.Conditions)
+	if len(sp.Search) > 0 {
+		jsonSearch, err := json.Marshal(sp.Search)
 		if err != nil {
 			return ""
 		}
@@ -46,7 +46,7 @@ func (sp SearchParams) queryString() string {
 
 // Interface is the interface for the stein client
 type Interface interface {
-	Get(sheet string, params SearchParams) ([]map[string]interface{}, error)
+	Get(sheet string, params GetParams) ([]map[string]interface{}, error)
 	Add(sheet string, rows ...map[string]interface{}) (AddResponse, error)
 }
 
@@ -77,7 +77,7 @@ func (s *stein) decodeJSON(r io.Reader, v interface{}) error {
 }
 
 // Get returns the rows in the given sheet
-func (s *stein) Get(sheet string, params SearchParams) ([]map[string]interface{}, error) {
+func (s *stein) Get(sheet string, params GetParams) ([]map[string]interface{}, error) {
 	resource := fmt.Sprintf("%s/%s", s.url, removePrefix(sheet, "/"))
 
 	queryParams := params.queryString()

stein_test.go

@@ -27,7 +27,7 @@ func Test_stein_Get(t *testing.T) {
 		defer ts.Close()
 
 		sc := New(ts.URL, nil)
-		resp, err := sc.Get("/sheetname", SearchParams{})
+		resp, err := sc.Get("/sheetname", GetParams{})
 		if err != nil {
 			t.Errorf("Error: %v", err)
 		}
@@ -47,7 +47,7 @@ func Test_stein_Get(t *testing.T) {
 		defer ts.Close()
 
 		sc := New(ts.URL, nil)
-		_, err := sc.Get("/sheetname", SearchParams{})
+		_, err := sc.Get("/sheetname", GetParams{})
 		assert.NotNil(t, err)
 		if !errors.As(err, &ErrNot2XX{}) {
 			t.Errorf("Expected ErrNot2XX, got %v", err)
@@ -65,7 +65,7 @@ func Test_stein_Get(t *testing.T) {
 		defer ts.Close()
 
 		sc := New(ts.URL, nil)
-		_, err := sc.Get("/sheetname", SearchParams{})
+		_, err := sc.Get("/sheetname", GetParams{})
 		assert.NotNil(t, err)
 		if !errors.As(err, &ErrDecodeJSON{}) {
 			t.Errorf("Expected ErrDecode, got %v", err)
@@ -75,10 +75,10 @@ func Test_stein_Get(t *testing.T) {
 
 func TestSearchParams_queryString(t *testing.T) {
 	t.Run("should return the correct query string", func(t *testing.T) {
-		params := SearchParams{
+		params := GetParams{
 			Offset: 20,
 			Limit:  10,
-			Conditions: map[string]string{
+			Search: map[string]string{
 				"column_1": "value_column_1",
 				"column_2": "value_column_2",
 			},