Add URL query arg matching to the route configuration schema. (#320)

brian-pane · ggreenway · commit 05384e069b3e · 2017-12-21T11:47:52.000-08:00
Signed-off-by: Brian Pane &lt;bpane@pinterest.com&gt;
diff --git a/api/rds.proto b/api/rds.proto
@@ -280,6 +280,14 @@ message RouteMatch {
   // the request with the same values (or based on presence if the value field
   // is not in the config).
   repeated HeaderMatcher headers = 6;
+
+  // [#not-implemented-hide:]
+  // Specifies a set of URL query parameters on which the route should
+  // match. The router will check the query string from the *path* header
+  // against all the specified query parameters. If the number of specified
+  // query parameters is nonzero, they all must match the *path* header's
+  // query string for a match to occur.
+  repeated QueryParameterMatcher query_parameters = 7;
 }
 
 message CorsPolicy {
@@ -802,3 +810,22 @@ message HeaderMatcher {
   // * The regex *\d{3}* does not match the value *123.456*
   google.protobuf.BoolValue regex = 3;
 }
+
+// Query parameter matching treats the query string of a request's :path header
+// as an ampersand-separated list of keys and/or key=value elements.
+message QueryParameterMatcher {
+  // Specifies the name of a key that must be present in the requested
+  // *path*'s query string.
+  string name = 1 [(validate.rules).string.min_bytes = 1];
+
+  // Specifies the value of the key. If the value is absent, a request
+  // that contains the key in its query string will match, whether the
+  // key appears with a value (e.g., "?debug=true") or not (e.g., "?debug")
+  string value = 3;
+
+  // Specifies whether the query parameter value is a regular expression.
+  // Defaults to false. The entire query parameter value (i.e., the part to
+  // the right of the equals sign in "key=value") must match the regex.
+  // E.g., the regex "\d+$" will match "123" but not "a123" or "123a".
+  google.protobuf.BoolValue regex = 4;
+}
