docs(gateway): explain the exact semantics of a PREFIX match

Signed-off-by: Mike Beaumont <mjboamail@gmail.com>
kumahq · Sep 15, 2022 · a15956d · a15956d
1 parent 4cc7092
commit a15956d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/api/mesh/v1alpha1/gateway_route.pb.go b/api/mesh/v1alpha1/gateway_route.pb.go
diff --git a/api/mesh/v1alpha1/gateway_route.proto b/api/mesh/v1alpha1/gateway_route.proto
@@ -84,6 +84,9 @@ message MeshGatewayRoute {
         // Value is the path to match against. For EXACT and PREFIX match
         // types, it must be a HTTP URI path. For the REGEX match type,
         // it must be a RE2 regular expression.
+        // Note that a PREFIX match succeeds only if the prefix is the
+        // the entire path or is followed by a /. I.e. a prefix of the
+        // path in terms of path elements.
         string value = 2 [
           (doc.required) = true,
           (validate.rules).message = {required : true},

diff --git a/docs/generated/resources/policy_meshgatewayroute.md b/docs/generated/resources/policy_meshgatewayroute.md
@@ -63,7 +63,10 @@
 
                         Value is the path to match against. For EXACT and PREFIX match
                         types, it must be a HTTP URI path. For the REGEX match type,
-                        it must be a RE2 regular expression.    
+                        it must be a RE2 regular expression.
+                        Note that a PREFIX match succeeds only if the prefix is the
+                        the entire path or is followed by a /. I.e. a prefix of the
+                        path in terms of path elements.    
 
                 - `method` (optional, enum)