Fix mismatched parameter expectations between chrome.omnibox setDefaultSuggestion and SuggestResult

chrome/common/extensions/api/omnibox.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": "omnibox",
     "types": [
       {
         "id": "SuggestResult",
         "type": "object",
         "description": "A suggest result.",
         "properties": {
           "content": {
             "type": "string",
             "minLength": 1,
-            "description": "The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry. This field must be blank for $ref:setDefaultSuggestion."
+            "description": "The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry."
           },
           "description": {
             "type": "string",
             "minLength": 1,
             "description": "The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>."
           },
           "descriptionStyles": {
             "nodoc": true,
             "optional": true,
             "type": "array",
-            "description": "The style ranges for the description, as provided by the extension.",
+            "description": "An array of style ranges for the description, as provided by the extension.",
             "items": {
               "type": "object",
               "name": "matchClassification",
-              "description": "Placeholder description.",
+              "description": "The style ranges for the description, as provided by the extension.",
               "properties": {
                 "offset": { "type": "integer" },
                 "type": { "description": "The style type", "type": "string", "enum": ["url", "match", "dim"]},
                 "length": { "type": "integer", "optional": true }
               }
             }
           },
           "descriptionStylesRaw": {
             "nodoc": true,
             "optional": true,
             "type": "array",
-            "description": "The style ranges for the description, as provided by ToValue().",
+            "description": "An array of style ranges for the description, as provided by ToValue().",
             "items": {
               "type": "object",
               "name": "matchClassification",
-              "description": "Placeholder description.",
+              "description": "The style ranges for the description, as provided by ToValue().",
               "properties": {
                 "offset": { "type": "integer" },
                 "type": { "type": "integer" }
+              }
+            }
+          }
+        }
+      },
+      {
+        "id": "DefaultSuggestResult",
+        "inline_doc": true,
+        "type": "object",
+        "description": "A suggest result.",

[not at google - send to devlin, 2013/05/08 22:19:06]

it'd be nice to avoid this repetition, but we can fix that later.

+        "properties": {
+          "description": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>."
+          },
+          "descriptionStyles": {
+            "nodoc": true,
+            "optional": true,
+            "type": "array",
+            "description": "An array of style ranges for the description, as provided by the extension.",
+            "items": {
+              "type": "object",
+              "name": "matchClassification",
+              "description": "The style ranges for the description, as provided by the extension.",
+              "properties": {
+                "offset": { "type": "integer" },
+                "type": { "description": "The style type", "type": "string", "enum": ["url", "match", "dim"]},
+                "length": { "type": "integer", "optional": true }
+              }
+            }
+          },
+          "descriptionStylesRaw": {
+            "nodoc": true,
+            "optional": true,
+            "type": "array",
+            "description": "An array of style ranges for the description, as provided by ToValue().",
+            "items": {
+              "type": "object",
+              "name": "matchClassification",
+              "description": "The style ranges for the description, as provided by ToValue().",
+              "properties": {
+                "offset": { "type": "integer" },
+                "type": { "type": "integer" }
               }
             }
           }
         }
       }
     ],
     "functions": [
       {
         "name": "sendSuggestions",
         "nodoc": true,
@@ skipping 11 matching lines @@
           }
         ]
       },
       {
         "name": "setDefaultSuggestion",
         "type": "function",
         "description": "Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the first suggestion row underneath the URL bar.",
         "parameters": [
           {
             "name": "suggestion",
-            "$ref": "SuggestResult",
-            "description": "A partial SuggestResult object, without the 'content' parameter. See SuggestResult for a description of the parameters."
+            "$ref": "DefaultSuggestResult",
+            "description": "A partial SuggestResult object, without the 'content' parameter."
           }
         ]
       }
     ],
     "events": [
       {
         "name": "onInputStarted",
         "type": "function",
         "description": "User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once per input session, and before any onInputChanged events.",
         "parameters": []
@@ skipping 43 matching lines @@
       },
       {
         "name": "onInputCancelled",
         "type": "function",
         "description": "User has ended the keyword input session without accepting the input.",
         "parameters": []
       }
     ]
   }
 ]