Adding condition attributes for response headers to Declarative WebRequest

chrome/common/extensions/api/declarative_web_request.json

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 [
   {
     "namespace": "declarativeWebRequest",
-    "documentation_permissions_required": ["declarative", "declarativeWebRequest"],
+    "description_permissions_required": ["declarative", "declarativeWebRequest"],

[battre, 2012/08/23 12:32:11]

I think this change is wrong.

[vabr (Chromium), 2012/08/24 14:48:59]

Sorry, that was unintentional. Wrongly written substitute regexp gone wild.
Reverted.

     "types": [
       {
+        "id": "HeaderFilter",
+        "type": "object",
+        "description": "Filters request headers for various criteria.",
+        "properties": {
+          "namePrefix": {
+            "description" : "Matches if the header name starts with a specified string.",

[battre, 2012/08/23 12:32:11]

This does not cover the array.

[vabr (Chromium), 2012/08/24 14:48:59]

I amended the comments, and also removed the choice of array at everything but
*Contains, because elsewhere it makes little sense (e.g., prefix: "abc" &&
prefix: "abcde" is just prefix: "abcde").

+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true
+          },
+          "nameSuffix": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header name ends with a specified string."
+          },
+          "nameContains": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header name contains a specified string."
+          },
+          "nameEquals": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header name is equal to a specified string."
+          },
+          "valuePrefix": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header value starts with a specified string."
+          },
+          "valueSuffix": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header value ends with a specified string."
+          },
+          "valueContains": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header value contains a specified string."
+          },
+          "valueEquals": {
+            "choices": [
+             {"type": "array", "items": {"type": "string"}},
+             {"type": "string"}
+            ],
+            "optional": true,
+            "description" : "Matches if the header value is equal to a specified string."
+          }
+        }
+      },
+      {
         "id": "RequestMatcher",
         "type": "object",
         "description": "Matches network events by various criteria.",
         "properties": {
           "url": {
             "$ref": "events.UrlFilter",
             "description": "Matches if the condition of the UrlFilter are fulfilled for the URL of the request.",
             "optional": true
           },
           "resourceType": {
             "type": "array",
             "optional": true,
             "description": "Matches if the request type of a request is contained in the list. Requests that cannot match any of the types will be filtered out.",
             "items": { "type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"] }
           },
           "contentType": {
             "type": "array",
             "optional": true,
             "description": "Matches if the MIME media type of a response (from the HTTP Content-Type header) is contained in the list.",
             "items": { "type": "string" }
           },
           "excludeContentType": {
             "type": "array",
             "optional": true,
             "description": "Matches if the MIME media type of a response (from the HTTP Content-Type header) is <em>not</em> contained in the list.",
             "items": { "type": "string" }
           },
+          "containsHeaders": {

[battre, 2012/08/23 12:32:11]

I would rename this to "responseHeaders"

[vabr (Chromium), 2012/08/24 14:48:59]

Done.

+            "type": "array",
+            "optional": true,
+            "description": "Matches if some of the headers is matched by one of the HeaderFilters.",

[battre, 2012/08/23 12:32:11]

response headers

[vabr (Chromium), 2012/08/24 14:48:59]

Done.

+            "items": { "$ref": "HeaderFilter" }
+          },
+          "doesNotContainHeaders": {

[battre, 2012/08/23 12:32:11]

I would rename this to "excludeResponseHeaders"

[vabr (Chromium), 2012/08/24 14:48:59]

Done.

+            "type": "array",
+            "optional": true,
+            "description": "Matches if none of the headers is matched by one of the HeaderFilters.",

[battre, 2012/08/23 12:32:11]

response headers

[vabr (Chromium), 2012/08/24 14:48:59]

Done.

+            "items": { "$ref": "HeaderFilter" }
+          },
           "instanceType": {
             "type": "string", "enum": ["declarativeWebRequest.RequestMatcher"],
             "nodoc": true
           }
         }
       },
       {
         "id": "CancelRequest",
         "description": "Declarative event action that cancels a network request.",
         "type": "object",
@@ skipping 333 matching lines @@
             "declarativeWebRequest.RemoveRequestHeader",
             "declarativeWebRequest.RemoveResponseHeader",
             "declarativeWebRequest.SetRequestHeader",
             "declarativeWebRequest.IgnoreRules"
           ]
         }
       }
     ]
   }
 ]