Empty response support in openapi docs

softwaremill · Mar 6, 2019 · b8defe4 · b8defe4
1 parent 206662f
commit b8defe4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/docs/openapi-docs/src/main/scala/tapir/docs/openapi/EndpointToOpenApiPaths.scala b/docs/openapi-docs/src/main/scala/tapir/docs/openapi/EndpointToOpenApiPaths.scala
@@ -98,10 +98,11 @@ private[openapi] class EndpointToOpenApiPaths(objectSchemas: ObjectSchemas, secu
   }
 
   private def operationResponse(e: Endpoint[_, _, _, _]): Map[ResponsesKey, Right[Nothing, Response]] = {
+    // There always needs to be at least a 200 empty response
+    val okResponse = outputToResponse(e.output).getOrElse(Response("", Map.empty, Map.empty))
+
     List(
-      outputToResponse(e.output).map { r =>
-        ResponsesCodeKey(200) -> Right(r)
-      },
+      Some(ResponsesCodeKey(200) -> Right(okResponse)),
       outputToResponse(e.errorOutput).map { r =>
         ResponsesDefaultKey -> Right(r)
       }

diff --git a/docs/openapi-docs/src/test/resources/expected_empty.yml b/docs/openapi-docs/src/test/resources/expected_empty.yml
@@ -0,0 +1,11 @@
+openapi: 3.0.1
+info:
+  title: Fruits
+  version: '1.0'
+paths:
+  /:
+    get:
+      operationId: getRoot
+      responses:
+        '200':
+          description: ''
diff --git a/docs/openapi-docs/src/test/scala/tapir/docs/openapi/VerifyYamlTest.scala b/docs/openapi-docs/src/test/scala/tapir/docs/openapi/VerifyYamlTest.scala
@@ -119,6 +119,16 @@ class VerifyYamlTest extends FunSuite with Matchers {
     actualYamlNoIndent shouldBe expectedYaml
   }
 
+  test("should support empty bodies") {
+    val expectedYaml = loadYaml("expected_empty.yml")
+
+    val actualYaml = List(endpoint).toOpenAPI(Info("Fruits", "1.0")).toYaml
+    println(actualYaml)
+    val actualYamlNoIndent = noIndentation(actualYaml)
+
+    actualYamlNoIndent shouldBe expectedYaml
+  }
+
   private def loadYaml(fileName: String): String = {
     noIndentation(Source.fromResource(fileName).getLines().mkString("\n"))
   }