Explicitly naming the data type for requestBody

chrome/common/extensions/api/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": "webRequest",
     "properties": {
       "MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES": {
         "value": 20,
@@ skipping 86 matching lines @@
             "optional": true,
             "description": "An ArrayBuffer with a copy of the data."
           },
           "file": {
             "type": "string",
             "optional": true,
             "description": "A string with the file's path and name."
           }
         },
         "description": "Contains data uploaded in a URL request."
+      },
+      {
+        "id": "RequestBody",
+        "type": "object",
+        "description": "This is a container for request body data.",

[Matt Perry, 2012/09/19 19:07:58]

I would copy part of the description of the variable: "Contains the HTTP request
body data." (or whatever you go with - see below).

[vabr (Chromium), 2012/09/19 19:18:15]

Done.

+        "properties": {
+          "error": {"type": "string", "optional": true, "description": "Errors when obtaining request body data."},
+          "formData": {
+            "type": "object",
+            "optional": true,
+            "description": "If the request method is POST and the body is a sequence of key-value pairs encoded in UTF8, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. An example value of this dictionary is {'key': ['value1', 'value2']}.",
+            "properties": {},
+            "additionalProperties": {
+              "type": "array",
+              "items": { "type": "string" }
+            }
+          },
+          "raw" : {
+            "type": "array",
+            "optional": true,
+            "items": {"$ref": "UploadData"},
+            "description": "If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in this array."
+          }
+        }
       }
     ],
     "functions": [
       {
         "name": "handlerBehaviorChanged",
         "type": "function",
         "description": "Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.",
         "parameters": [
           {"type": "function", "name": "callback", "optional": true, "parameters": []}
         ]
       }
     ],
     "events": [
       {
         "name": "onBeforeRequest",
         "type": "function",
         "description": "Fired when a request is about to occur.",
         "parameters": [
           {
             "type": "object",
             "name": "details",
             "properties": {
               "requestId": {"type": "string", "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
               "url": {"type": "string"},
               "method": {"type": "string", "description": "Standard HTTP method."},
               "frameId": {"type": "integer", "description": "The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab."},
               "parentFrameId": {"type": "integer", "description": "ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists."},
               "requestBody": {
-                "type": "object",
+                "$ref": "RequestBody",
                 "optional": true,
-                "description": "Experimental feature, only available in DEV or CANARY channels. Container for request body data. Only provided if extraInfoSpec contains 'requestBody'. Currently only request body elements containing byte data or files are reported.",

[vabr (Chromium), 2012/09/19 08:16:09]

I removed "Currently only request body elements containing byte data or files
are reported" entirely, because there are no other upload data elements than
TYPE_FILE or TYPE_BYTES.

-                "properties": {
-                  "error": {"type": "string", "optional": true, "description": "Errors when obtaining request body data."},
-                  "formData": {
-                    "type": "object",
-                    "optional": true,
-                    "description": "If the request method is POST and the body is a sequence of key-value pairs encoded in UTF8, encoded as either multipart/form-data, or application/x-www-form-urlencoded, this dictionary is present and for each key contains the list of all values for that key. If the data is of another media type, or if it is malformed, the dictionary is not present. An example value of this dictionary is {'key': ['value1', 'value2']}.",
-                    "properties": {},
-                    "additionalProperties": {
-                      "type": "array",
-                      "items": { "type": "string" }
-                    }
-                  },
-                  "raw" : {
-                    "type": "array",
-                    "optional": true,
-                    "items": {"$ref": "UploadData"},
-                    "description": "If the request method is PUT or POST, and the body is not already parsed in formData, then the unparsed request body elements are contained in this array."
-                  }
-                }
+                "description": "Contains the upload data of the request. Experimental feature, only available in DEV or CANARY channels. Only provided if extraInfoSpec contains 'requestBody'."

[Matt Perry, 2012/09/19 19:07:58]

"Contains the upload data of the request." ? Makes it sound like UploadData. How
about "Contains the HTTP request body data."

[vabr (Chromium), 2012/09/19 19:18:15]

Done.

               },
               "tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab."},
               "type": {"type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"], "description": "How the requested resource will be used."},
               "timeStamp": {"type": "number", "description": "The time when this signal is triggered, in milliseconds since the epoch."}
             }
           }
         ],
         "extraParameters": [
           {
             "$ref": "RequestFilter",
@@ skipping 366 matching lines @@
           {
             "$ref": "RequestFilter",
             "name": "filter",
             "description": "A set of filters that restricts the events that will be sent to this listener."
           }
         ]
       }
     ]
   }
 ]