improve OpenAPI description for Response<Body> endpoints (#295)

ahl · web-flow · commit 18078c4909d6 · 2022-03-13T18:59:33.000Z
diff --git a/dropshot/src/api_description.rs b/dropshot/src/api_description.rs
@@ -778,15 +778,32 @@ impl<Context: ServerContext> ApiDescription<Context> {
             } else {
                 // If no schema was specified, the response is hand-rolled. In
                 // this case we'll fall back to the default response type which
-                // we assume to be inclusive of errors.
+                // we assume to be inclusive of errors. The media type and
+                // and schema will similarly be maximally permissive.
+                let mut content = indexmap::IndexMap::new();
+                content.insert(
+                    "*/*".to_string(),
+                    openapiv3::MediaType {
+                        schema: Some(openapiv3::ReferenceOr::Item(
+                            openapiv3::Schema {
+                                schema_data: openapiv3::SchemaData::default(),
+                                schema_kind: openapiv3::SchemaKind::Any(
+                                    openapiv3::AnySchema::default(),
+                                ),
+                            },
+                        )),
+                        ..Default::default()
+                    },
+                );
                 operation.responses.default =
                     Some(openapiv3::ReferenceOr::Item(openapiv3::Response {
                         // TODO: perhaps we should require even free-form
                         // responses to have a description since it's required
                         // by OpenAPI.
                         description: "".to_string(),
+                        content,
                         ..Default::default()
-                    }))
+                    }));
             }
 
             // Drop in the operation.
diff --git a/dropshot/tests/test_openapi.json b/dropshot/tests/test_openapi.json
@@ -485,7 +485,12 @@
         "operationId": "handler16",
         "responses": {
           "default": {
-            "description": ""
+            "description": "",
+            "content": {
+              "*/*": {
+                "schema": {}
+              }
+            }
           }
         }
       }
diff --git a/dropshot/tests/test_openapi_fuller.json b/dropshot/tests/test_openapi_fuller.json
@@ -493,7 +493,12 @@
         "operationId": "handler16",
         "responses": {
           "default": {
-            "description": ""
+            "description": "",
+            "content": {
+              "*/*": {
+                "schema": {}
+              }
+            }
           }
         }
       }

Original file line number	Diff line number	Diff line change
`@@ -485,7 +485,12 @@`
`485`	`485`	`"operationId": "handler16",`
`486`	`486`	`"responses": {`
`487`	`487`	`"default": {`
`488`		`- "description": ""`
	`488`	`+ "description": "",`
	`489`	`+ "content": {`
	`490`	`+ "/": {`
	`491`	`+ "schema": {}`
	`492`	`+ }`
	`493`	`+ }`
`489`	`494`	`}`
`490`	`495`	`}`
`491`	`496`	`}`
Original file line number	Diff line number	Diff line change
`@@ -493,7 +493,12 @@`
`493`	`493`	`"operationId": "handler16",`
`494`	`494`	`"responses": {`
`495`	`495`	`"default": {`
`496`		`- "description": ""`
	`496`	`+ "description": "",`
	`497`	`+ "content": {`
	`498`	`+ "/": {`
	`499`	`+ "schema": {}`
	`500`	`+ }`
	`501`	`+ }`
`497`	`502`	`}`
`498`	`503`	`}`
`499`	`504`	`}`