refactor: change key name (#75)

Author: whoAbhishekSah

rql/README.md

@@ -26,8 +26,8 @@ Frontend should send the parameters and operator like this schema to the backend
   "limit": 50,
   "search": "abcd",
   "sort": [
-    { "key": "title", "order": "desc" },
-    { "key": "created_at", "order": "asc" }
+    { "name": "title", "order": "desc" },
+    { "name": "created_at", "order": "asc" }
   ]
 }
 ```

rql/parser.go

@@ -40,7 +40,7 @@ type Filter struct {
 }
 
 type Sort struct {
-	Key   string `json:"key"`
+	Name  string `json:"name"`
 	Order string `json:"order"`
 }
 
@@ -185,12 +185,12 @@ func isValidOperator(filterItem Filter) bool {
 
 func validateSortKey(q *Query, val reflect.Value) error {
 	for _, item := range q.Sort {
-		filterIdx := searchKeyInsideStruct(item.Key, val)
+		filterIdx := searchKeyInsideStruct(item.Name, val)
 		if filterIdx < 0 {
-			return fmt.Errorf("'%s' is not a valid sort key", item.Key)
+			return fmt.Errorf("'%s' is not a valid sort key", item.Name)
 		}
 		if !slices.Contains(validSortOrder, item.Order) {
-			return fmt.Errorf("'%s' is not a valid sort key", item.Key)
+			return fmt.Errorf("'%s' is not a valid sort key", item.Name)
 		}
 	}
 	return nil

rql/parser_test.go

@@ -29,7 +29,7 @@ func TestValidateQuery(t *testing.T) {
 					{Name: "CreatedAt", Operator: "eq", Value: "2021-09-15T15:53:00Z"},
 				},
 				Sort: []Sort{
-					{Key: "ID", Order: "asc"},
+					{Name: "ID", Order: "asc"},
 				},
 			},
 			checkStruct: TestStruct{},
@@ -69,7 +69,7 @@ func TestValidateQuery(t *testing.T) {
 			name: "Invalid sort key",
 			query: Query{
 				Sort: []Sort{
-					{Key: "NonExistentKey", Order: "asc"},
+					{Name: "NonExistentKey", Order: "asc"},
 				},
 			},
 			checkStruct: TestStruct{},