Docserver: Display enum value descriptions in API docs.

This modifies the json schema to allow both primitive types and
dictionaries with properties "name" and optional "description" for enum
values.

BUG=310454

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=231982

Review URL: https://codereview.chromium.org/39113003

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@232297 0039d316-1c4b-4281-b951-d872f2087c98

2 files changed, 33 insertions, 2 deletions

diff --git a/components/json_schema/json_schema_validator.cc b/components/json_schema/json_schema_validator.cc
index 3816a76..3cc9e2b 100644
--- a/components/json_schema/json_schema_validator.cc
+++ b/components/json_schema/json_schema_validator.cc
@@ -53,6 +53,18 @@ bool CompareToString(const ExpectedType& entry, const std::string& key) {
   return entry.key < key;
 }
 
+// If |value| is a dictionary, returns the "name" attribute of |value| or NULL
+// if |value| does not contain a "name" attribute. Otherwise, returns |value|.
+const base::Value* ExtractNameFromDictionary(const base::Value* value) {
+  const base::DictionaryValue* value_dict = NULL;
+  const base::Value* name_value = NULL;
+  if (value->GetAsDictionary(&value_dict)) {
+    value_dict->Get("name", &name_value);
+    return name_value;
+  }
+  return value;
+}
+
 bool IsValidSchema(const base::DictionaryValue* dict, std::string* error) {
   // This array must be sorted, so that std::lower_bound can perform a
   // binary search.
@@ -195,6 +207,13 @@ bool IsValidSchema(const base::DictionaryValue* dict, std::string* error) {
       for (size_t i = 0; i < list_value->GetSize(); ++i) {
         const base::Value* value = NULL;
         list_value->Get(i, &value);
+        // Sometimes the enum declaration is a dictionary with the enum value
+        // under "name".
+        value = ExtractNameFromDictionary(value);
+        if (!value) {
+          *error = "Invalid value in enum attribute";
+          return false;
+        }
         switch (value->GetType()) {
           case base::Value::TYPE_NULL:
           case base::Value::TYPE_BOOLEAN:
@@ -479,6 +498,12 @@ void JSONSchemaValidator::ValidateEnum(const base::Value* instance,
   for (size_t i = 0; i < choices->GetSize(); ++i) {
     const base::Value* choice = NULL;
     CHECK(choices->Get(i, &choice));
+    // Sometimes the enum declaration is a dictionary with the enum value under
+    // "name".
+    choice = ExtractNameFromDictionary(choice);
+    if (!choice) {
+      NOTREACHED();
+    }
     switch (choice->GetType()) {
       case base::Value::TYPE_NULL:
       case base::Value::TYPE_BOOLEAN:
diff --git a/components/json_schema/json_schema_validator_unittest.cc b/components/json_schema/json_schema_validator_unittest.cc
index 4844ed1..6372032 100644
--- a/components/json_schema/json_schema_validator_unittest.cc
+++ b/components/json_schema/json_schema_validator_unittest.cc
@@ -77,10 +77,16 @@ TEST(JSONSchemaValidator, IsValidSchema) {
   EXPECT_FALSE(JSONSchemaValidator::IsValidSchema(
       "{"
       "  \"type\": \"string\","
-      "  \"enum\": [ {} ],"  // "enum" must contain simple values.
+      "  \"enum\": [ {} ]"  // "enum" dict values must contain "name".
       "}", &error));
   EXPECT_FALSE(JSONSchemaValidator::IsValidSchema(
       "{"
+      "  \"type\": \"string\","
+      "  \"enum\": [ { \"name\": {} } ]"  // "enum" name must be a simple value.
+      "}",
+      &error));
+  EXPECT_FALSE(JSONSchemaValidator::IsValidSchema(
+      "{"
       "  \"type\": \"array\","
       "  \"items\": [ 123 ],"  // "items" must contain a schema or schemas.
       "}", &error));
@@ -106,7 +112,7 @@ TEST(JSONSchemaValidator, IsValidSchema) {
       "    },"
       "    \"enum-property\": {"
       "      \"type\": \"integer\","
-      "      \"enum\": [0, 1, 10, 100]"
+      "      \"enum\": [0, 1, {\"name\": 10}, 100]"
       "    },"
       "    \"items-property\": {"
       "      \"type\": \"array\","