fix: address PR review comments

- Fix error message scope values to use canonical casing (Query/Header/etc.)
- Fix ScopeBody doc comment: post_arg.* -> post_arg.<name>
- Update Name field comment to be generic across all scopes
- Make Name field optional (omitempty) so scope:Path does not require name
- Fix e2e step description: 'without action field' -> 'wrong action value'
- Fix e2e JSON path test to use actual dot-notation (model.version)

Author: AlinsRan

api/v2/apisixroute_types.go

@@ -313,7 +313,7 @@ func (exprs ApisixRouteHTTPMatchExprs) ToVars() (result adc.Vars, err error) {
 		case ScopeBody:
 			subj = "post_arg." + expr.Subject.Name
 		default:
-			return result, errors.New("invalid http match expr: subject.scope should be one of [query, header, cookie, path, variable, body]")
+			return result, errors.New("invalid http match expr: subject.scope should be one of [Query, Header, Cookie, Path, Variable, Body]")
 		}
 		this.SliceVal = append(this.SliceVal, adc.StringOrSlice{StrVal: subj})
 
@@ -417,13 +417,15 @@ type ApisixRouteHTTPMatchExprSubject struct {
 	// Supported values: `Header`, `Query`, `Path`, `Cookie`, `Variable`, `Body`.
 	// When Scope is `Path`, Name will be ignored.
 	// When Scope is `Body`, Name supports dot-notation JSON path (e.g., "model.version",
-	// "messages[*].role") and maps to APISIX's post_arg.* variable, which works with
+	// "messages[*].role") and maps to APISIX's post_arg.<name> variable, which works with
 	// application/json, application/x-www-form-urlencoded, and multipart/form-data.
 	// +kubebuilder:validation:Enum=Header;Query;Path;Cookie;Variable;Body
 	Scope string `json:"scope" yaml:"scope"`
-	// Name is the name of the header, query parameter, cookie, variable, or body field.
-	// Required for all scopes except Path.
-	Name string `json:"name" yaml:"name"`
+	// Name is the name of the subject within the given scope: the header name, query
+	// parameter name, cookie name, Nginx variable name, or body field name (dot-notation
+	// JSON path supported for Body scope). Optional when Scope is Path.
+	// +kubebuilder:validation:Optional
+	Name string `json:"name,omitempty" yaml:"name,omitempty"`
 }
 
 func init() {

api/v2/shared_types.go

@@ -88,7 +88,7 @@ const (
 	ScopeVariable = "Variable"
 	// ScopeBody means the route match expression subject is in the request body.
 	// Name supports dot-notation JSON path (e.g., "model.version", "messages[*].role"),
-	// and maps to APISIX's post_arg.* variable, which supports application/json,
+	// and maps to APISIX's post_arg.<name> variable, which supports application/json,
 	// application/x-www-form-urlencoded, and multipart/form-data content types.
 	ScopeBody = "Body"
 )

config/crd/bases/apisix.apache.org_apisixroutes.yaml

@@ -207,16 +207,17 @@ spec:
                                 properties:
                                   name:
                                     description: |-
-                                      Name is the name of the header, query parameter, cookie, variable, or body field.
-                                      Required for all scopes except Path.
+                                      Name is the name of the subject within the given scope: the header name, query
+                                      parameter name, cookie name, Nginx variable name, or body field name (dot-notation
+                                      JSON path supported for Body scope). Optional when Scope is Path.
                                     type: string
                                   scope:
                                     description: |-
                                       Scope specifies the subject scope.
                                       Supported values: `Header`, `Query`, `Path`, `Cookie`, `Variable`, `Body`.
                                       When Scope is `Path`, Name will be ignored.
                                       When Scope is `Body`, Name supports dot-notation JSON path (e.g., "model.version",
-                                      "messages[*].role") and maps to APISIX's post_arg.* variable, which works with
+                                      "messages[*].role") and maps to APISIX's post_arg.<name> variable, which works with
                                       application/json, application/x-www-form-urlencoded, and multipart/form-data.
                                     enum:
                                     - Header
@@ -227,7 +228,6 @@ spec:
                                     - Body
                                     type: string
                                 required:
-                                - name
                                 - scope
                                 type: object
                               value:

test/e2e/crds/v2/route.go

@@ -330,7 +330,7 @@ spec:
 			}
 			Eventually(request).WithTimeout(20 * time.Second).ProbeEvery(time.Second).Should(Equal(http.StatusOK))
 
-			By("verify non-matching POST without action field returns 404")
+			By("verify non-matching POST with wrong action value returns 404")
 			s.NewAPISIXClient().POST("/post").
 				WithFormField("action", "logout").
 				Expect().Status(http.StatusNotFound)
@@ -339,7 +339,7 @@ spec:
 			s.NewAPISIXClient().GET("/get").Expect().Status(http.StatusNotFound)
 		})
 
-		It("Test ApisixRoute match by body vars (JSON path)", func() {
+		It("Test ApisixRoute match by body vars (JSON nested path)", func() {
 			const apisixRouteSpec = `
 apiVersion: apisix.apache.org/v2
 kind: ApisixRoute
@@ -358,29 +358,29 @@ spec:
       exprs:
       - subject:
           scope: Body
-          name: model
+          name: model.version
         op: Equal
         value: gpt-4
     backends:
     - serviceName: httpbin-service-e2e-test
       servicePort: 80
 `
-			By("apply ApisixRoute with Body scope JSON path expr")
+			By("apply ApisixRoute with Body scope dot-notation JSON path expr")
 			var apisixRoute apiv2.ApisixRoute
 			applier.MustApplyAPIv2(types.NamespacedName{Namespace: s.Namespace(), Name: "default"},
 				&apisixRoute, fmt.Sprintf(apisixRouteSpec, s.Namespace(), s.Namespace()))
 
-			By("verify matching POST with JSON body model=gpt-4 returns 200")
+			By("verify matching POST with JSON body {model: {version: gpt-4}} returns 200")
 			request := func() int {
 				return s.NewAPISIXClient().POST("/post").
-					WithJSON(map[string]string{"model": "gpt-4"}).
+					WithJSON(map[string]any{"model": map[string]string{"version": "gpt-4"}}).
 					Expect().Raw().StatusCode
 			}
 			Eventually(request).WithTimeout(20 * time.Second).ProbeEvery(time.Second).Should(Equal(http.StatusOK))
 
-			By("verify non-matching JSON body returns 404")
+			By("verify non-matching JSON body with wrong nested value returns 404")
 			s.NewAPISIXClient().POST("/post").
-				WithJSON(map[string]string{"model": "gpt-3"}).
+				WithJSON(map[string]any{"model": map[string]string{"version": "gpt-3"}}).
 				Expect().Status(http.StatusNotFound)
 		})