Docserver: Display enum value descriptions in API docs.

components/json_schema/json_schema_validator.cc

 // Copyright 2013 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.
 
 #include "components/json_schema/json_schema_validator.h"
 
 #include <algorithm>
 #include <cfloat>
 #include <cmath>
 
@@ skipping 177 matching lines @@
         return false;
       }
     }
 
     // Validate the values contained in an "enum" attribute.
     if (it.key() == schema::kEnum) {
       it.value().GetAsList(&list_value);
       for (size_t i = 0; i < list_value->GetSize(); ++i) {
         const base::Value* value = NULL;
         list_value->Get(i, &value);
+        const base::DictionaryValue* value_dict;

[not at google - send to devlin, 2013/10/28 18:00:25]

= NULL

[Sam McNally, 2013/10/29 00:39:02]

Done.

+        if (value->GetAsDictionary(&value_dict)) {
+          if (!value_dict->Get("name", &value)) {
+            *error = "Invalid value in enum attribute";
+            return false;
+          }
+        }
         switch (value->GetType()) {
           case base::Value::TYPE_NULL:
           case base::Value::TYPE_BOOLEAN:
           case base::Value::TYPE_INTEGER:
           case base::Value::TYPE_DOUBLE:
           case base::Value::TYPE_STRING:
             break;
           default:
             *error = "Invalid value in enum attribute";
             return false;

[not at google - send to devlin, 2013/10/28 18:00:25]

rather than the GetAsDictionary above, include TYPE_DICTIONARY in the switch
here.

[Sam McNally, 2013/10/29 00:39:02]

I think I need to keep it before the switch so the name attribute is checked.

[not at google - send to devlin, 2013/10/29 16:25:16]

Ah right. Could you add a comment ("sometimes the enum declaration is a
dictionary with the enum value under "name")? In fact, since there is code below
which does basically the same thing, you could pull that out into a small
function.

[Sam McNally, 2013/10/30 03:08:37]

Done.

         }
       }
     }
 
     // Validate the schemas contained in a "choices" attribute.
     if (it.key() == schema::kChoices) {
       it.value().GetAsList(&list_value);
       for (size_t i = 0; i < list_value->GetSize(); ++i) {
         if (!list_value->GetDictionary(i, &dictionary_value)) {
           *error = "Invalid choices attribute";
@@ skipping 254 matching lines @@
   errors_.push_back(Error(path, kInvalidChoice));
   return;
 }
 
 void JSONSchemaValidator::ValidateEnum(const base::Value* instance,
                                        const base::ListValue* choices,
                                        const std::string& path) {
   for (size_t i = 0; i < choices->GetSize(); ++i) {
     const base::Value* choice = NULL;
     CHECK(choices->Get(i, &choice));
+    const base::DictionaryValue* choice_dict;
+    if (choice->GetAsDictionary(&choice_dict)) {
+      if (!choice_dict->Get("name", &choice)) {
+        NOTREACHED();
+      }
+    }

[not at google - send to devlin, 2013/10/28 18:00:25]

likewise

[not at google - send to devlin, 2013/10/29 16:25:16]

(still applicable)

[Sam McNally, 2013/10/30 03:08:37]

Done (before the switch for the same reason).

     switch (choice->GetType()) {
       case base::Value::TYPE_NULL:
       case base::Value::TYPE_BOOLEAN:
       case base::Value::TYPE_STRING:
         if (instance->Equals(choice))
           return;
         break;
 
       case base::Value::TYPE_INTEGER:
       case base::Value::TYPE_DOUBLE:
@@ skipping 226 matching lines @@
 
   if (*additional_properties_schema) {
     std::string additional_properties_type(schema::kAny);
     CHECK((*additional_properties_schema)->GetString(
         schema::kType, &additional_properties_type));
     return additional_properties_type == schema::kAny;
   } else {
     return default_allow_additional_properties_;
   }
 }