[schema_util] better error messages for enum variants used as params (#…

…828) I've hit this twice in the last few months and forgot how to fix it already after the first time scratching my head against it -- enums need to be wrapped in a struct. Provide a more helpful message, and add tests.
oxidecomputer · Nov 30, 2023 · 164f2ed · 164f2ed
1 parent 98f311e
commit 164f2ed
Show file tree

Hide file tree

Showing 4 changed files with 283 additions and 53 deletions.
diff --git a/dropshot/src/extractor/metadata.rs b/dropshot/src/extractor/metadata.rs
@@ -48,26 +48,32 @@ where
     };
 
     // Convert our collection of struct members list of parameters.
-    let parameters = schema2struct(&schema, &generator, true)
-        .into_iter()
-        .map(|struct_member| {
-            let mut s = struct_member.schema;
-            let mut visitor = ReferenceVisitor::new(&generator);
-            schemars::visit::visit_schema(&mut visitor, &mut s);
-
-            ApiEndpointParameter::new_named(
-                loc,
-                struct_member.name,
-                struct_member.description,
-                struct_member.required,
-                ApiSchemaGenerator::Static {
-                    schema: Box::new(s),
-                    dependencies: visitor.dependencies(),
-                },
-                Vec::new(),
-            )
-        })
-        .collect::<Vec<_>>();
+    let parameters = schema2struct(
+        &ParamType::schema_name(),
+        "parameters",
+        &schema,
+        &generator,
+        true,
+    )
+    .into_iter()
+    .map(|struct_member| {
+        let mut s = struct_member.schema;
+        let mut visitor = ReferenceVisitor::new(&generator);
+        schemars::visit::visit_schema(&mut visitor, &mut s);
+
+        ApiEndpointParameter::new_named(
+            loc,
+            struct_member.name,
+            struct_member.description,
+            struct_member.required,
+            ApiSchemaGenerator::Static {
+                schema: Box::new(s),
+                dependencies: visitor.dependencies(),
+            },
+            Vec::new(),
+        )
+    })
+    .collect::<Vec<_>>();
 
     ExtractorMetadata { extension_mode, parameters }
 }

diff --git a/dropshot/src/handler.rs b/dropshot/src/handler.rs
@@ -986,23 +986,29 @@ impl<
         );
         let schema = generator.root_schema_for::<H>().schema.into();
 
-        let headers = schema2struct(&schema, &generator, true)
-            .into_iter()
-            .map(|struct_member| {
-                let mut s = struct_member.schema;
-                let mut visitor = ReferenceVisitor::new(&generator);
-                schemars::visit::visit_schema(&mut visitor, &mut s);
-                ApiEndpointHeader {
-                    name: struct_member.name,
-                    description: struct_member.description,
-                    schema: ApiSchemaGenerator::Static {
-                        schema: Box::new(s),
-                        dependencies: visitor.dependencies(),
-                    },
-                    required: struct_member.required,
-                }
-            })
-            .collect::<Vec<_>>();
+        let headers = schema2struct(
+            &H::schema_name(),
+            "headers",
+            &schema,
+            &generator,
+            true,
+        )
+        .into_iter()
+        .map(|struct_member| {
+            let mut s = struct_member.schema;
+            let mut visitor = ReferenceVisitor::new(&generator);
+            schemars::visit::visit_schema(&mut visitor, &mut s);
+            ApiEndpointHeader {
+                name: struct_member.name,
+                description: struct_member.description,
+                schema: ApiSchemaGenerator::Static {
+                    schema: Box::new(s),
+                    dependencies: visitor.dependencies(),
+                },
+                required: struct_member.required,
+            }
+        })
+        .collect::<Vec<_>>();
 
         metadata.headers = headers;
         metadata