Merge pull request #2257 from softwaremill/byte-buffer-example

Support examples for byte buffer bodies
softwaremill · Jun 21, 2022 · 25fc32e · 25fc32e
2 parents 7b84410 + 854b107
commit 25fc32e
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 1 deletion.
diff --git a/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/package.scala b/docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/package.scala
@@ -4,6 +4,9 @@ import sttp.apispec.{ExampleMultipleValue, ExampleSingleValue, ExampleValue, Sec
 import sttp.tapir.Schema.SName
 import sttp.tapir.{AnyEndpoint, Codec, EndpointInput, Schema, SchemaType}
 
+import java.nio.ByteBuffer
+import java.nio.charset.Charset
+
 package object apispec {
   private[docs] type SchemeName = String
   private[docs] type SecuritySchemes = Map[EndpointInput.Auth[_, _], (SchemeName, SecurityScheme)]
@@ -23,7 +26,11 @@ package object apispec {
     result
   }
 
-  private def rawToString[T](v: Any): String = v.toString
+  private def rawToString[T](v: Any): String = v match {
+    case a: Array[Byte] => new String(a, "UTF-8")
+    case b: ByteBuffer  => Charset.forName("UTF-8").decode(b).toString
+    case _              => v.toString
+  }
 
   private[docs] def exampleValue[T](v: String): ExampleValue = ExampleSingleValue(v)
   private[docs] def exampleValue[T](codec: Codec[_, T, _], e: T): Option[ExampleValue] = exampleValue(codec.schema, codec.encode(e))

diff --git a/docs/openapi-docs/src/test/resources/example/expected_byte_buffer_example.yml b/docs/openapi-docs/src/test/resources/example/expected_byte_buffer_example.yml
@@ -0,0 +1,22 @@
+openapi: 3.0.3
+info:
+  title: Users
+  version: '1.0'
+paths:
+  /:
+    get:
+      operationId: getRoot
+      responses:
+        '200':
+          description: ''
+          headers:
+            Content-Type:
+              required: true
+              schema:
+                type: string
+          content:
+            text/csv:
+              schema:
+                type: string
+                format: binary
+              example: a,b,c,1024,e,f,42,g h,i
diff --git a/docs/openapi-docs/src/test/scalajvm/sttp/tapir/docs/openapi/VerifyYamlExampleTest.scala b/docs/openapi-docs/src/test/scalajvm/sttp/tapir/docs/openapi/VerifyYamlExampleTest.scala
@@ -14,6 +14,7 @@ import sttp.tapir.json.circe._
 import sttp.tapir.tests.data.{Entity, Organization, Person}
 import sttp.tapir.{endpoint, _}
 
+import java.nio.ByteBuffer
 import java.time.ZoneOffset.UTC
 import java.time.ZonedDateTime
 
@@ -183,4 +184,17 @@ class VerifyYamlExampleTest extends AnyFunSuite with Matchers {
 
     noIndentation(actualYaml) shouldBe expectedYaml
   }
+
+  test("should support byte buffer examples") {
+    val e = endpoint.out(
+      byteBufferBody
+        .example(Example.of(ByteBuffer.wrap("a,b,c,1024,e,f,42,g h,i".getBytes("UTF-8"))))
+        .and(header("Content-Type", "text/csv"))
+    )
+
+    val expectedYaml = load("example/expected_byte_buffer_example.yml")
+    val actualYaml = OpenAPIDocsInterpreter().toOpenAPI(e, Info("Users", "1.0")).toYaml
+
+    noIndentation(actualYaml) shouldBe expectedYaml
+  }
 }