update sttp-apispec to pr version and add/update tests

softwaremill · Nov 21, 2023 · c88f4b0 · c88f4b0
1 parent bec6472
commit c88f4b0
Show file tree

Hide file tree

Showing 5 changed files with 122 additions and 2 deletions.
diff --git a/docs/openapi-docs/src/test/resources/expected_nullable_option_class_field.yml b/docs/openapi-docs/src/test/resources/expected_nullable_option_class_field.yml
@@ -41,6 +41,8 @@ components:
       type: object
       properties:
         optionalObjField:
-          $ref: '#/components/schemas/Bar'
+          oneOf:
+            - $ref: '#/components/schemas/Bar'
+            - type: 'null'
         requiredStringField:
           type: string
diff --git a/docs/openapi-docs/src/test/resources/expected_nullable_option_class_field_303.yml b/docs/openapi-docs/src/test/resources/expected_nullable_option_class_field_303.yml
@@ -0,0 +1,48 @@
+openapi: 3.0.3
+info:
+  title: ClassWithOptionClassField
+  version: '1.0'
+paths:
+  /:
+    post:
+      operationId: postRoot
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ClassWithOptionClassField'
+        required: true
+      responses:
+        '200':
+          description: ''
+          content:
+            text/plain:
+              schema:
+                type: string
+        '400':
+          description: 'Invalid value for: body'
+          content:
+            text/plain:
+              schema:
+                type: string
+components:
+  schemas:
+    Bar:
+      required:
+        - bar
+      type: object
+      properties:
+        bar:
+          type: integer
+          format: int32
+    ClassWithOptionClassField:
+      required:
+        - requiredStringField
+      type: object
+      properties:
+        optionalObjField:
+          allOf:
+            - $ref: '#/components/schemas/Bar'
+          nullable: true
+        requiredStringField:
+          type: string
diff --git a/docs/openapi-docs/src/test/resources/expected_nullable_option_field_303.yml b/docs/openapi-docs/src/test/resources/expected_nullable_option_field_303.yml
@@ -0,0 +1,40 @@
+openapi: 3.0.3
+info:
+  title: ClassWithOptionField
+  version: '1.0'
+paths:
+  /:
+    get:
+      operationId: getRoot
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ClassWithOptionField'
+              required: true
+      responses:
+        '200':
+          description: ''
+          content:
+            text/plain:
+              schema:
+                type: string
+        '400':
+          description: 'Invalid value for: body'
+          content:
+            text/plain:
+              schema:
+                type: string
+components:
+  schemas:
+    ClassWithOptionField:
+      required:
+      - requiredStringField
+      type: object
+      properties:
+        optionalIntField:
+          type: integer
+          format: int32
+          nullable: true
+        requiredStringField:
+          type: string
diff --git a/docs/openapi-docs/src/test/scalajvm/sttp/tapir/docs/openapi/VerifyYamlTest.scala b/docs/openapi-docs/src/test/scalajvm/sttp/tapir/docs/openapi/VerifyYamlTest.scala
@@ -676,6 +676,19 @@ class VerifyYamlTest extends AnyFunSuite with Matchers {
     actualYamlNoIndent shouldBe expectedYaml
   }
 
+  test("should mark optional fields as nullable when configured to do so using OpenAPI 3.0") {
+    case class ClassWithOptionField(optionalIntField: Option[Int], requiredStringField: String)
+
+    val e = endpoint.in(jsonBody[ClassWithOptionField]).out(stringBody)
+    val expectedYaml = load("expected_nullable_option_field_303.yml")
+
+    val options = OpenAPIDocsOptions.default.copy(markOptionsAsNullable = true)
+
+    val actualYaml = OpenAPIDocsInterpreter(options).toOpenAPI(e, Info("ClassWithOptionField", "1.0")).copy(openapi = "3.0.3").toYaml3_0_3
+    val actualYamlNoIndent = noIndentation(actualYaml)
+    actualYamlNoIndent shouldBe expectedYaml
+  }
+
   test("should mark optional class fields as nullable when configured to do so") {
     case class Bar(bar: Int)
     case class ClassWithOptionClassField(optionalObjField: Option[Bar], requiredStringField: String)
@@ -686,6 +699,23 @@ class VerifyYamlTest extends AnyFunSuite with Matchers {
     val options = OpenAPIDocsOptions.default.copy(markOptionsAsNullable = true)
 
     val actualYaml = OpenAPIDocsInterpreter(options).toOpenAPI(e, Info("ClassWithOptionClassField", "1.0")).toYaml
+    println(actualYaml)
+    val actualYamlNoIndent = noIndentation(actualYaml)
+    actualYamlNoIndent shouldBe expectedYaml
+  }
+
+  test("should mark optional class fields as nullable when configured to do so using OpenAPI 3.0") {
+    case class Bar(bar: Int)
+    case class ClassWithOptionClassField(optionalObjField: Option[Bar], requiredStringField: String)
+
+    val e = endpoint.in(jsonBody[ClassWithOptionClassField]).out(stringBody).post
+    val expectedYaml = load("expected_nullable_option_class_field_303.yml")
+
+    val options = OpenAPIDocsOptions.default.copy(markOptionsAsNullable = true)
+
+    val actualYaml =
+      OpenAPIDocsInterpreter(options).toOpenAPI(e, Info("ClassWithOptionClassField", "1.0")).copy(openapi = "3.0.3").toYaml3_0_3
+    println(actualYaml)
     val actualYamlNoIndent = noIndentation(actualYaml)
     actualYamlNoIndent shouldBe expectedYaml
   }

diff --git a/project/Versions.scala b/project/Versions.scala
@@ -11,7 +11,7 @@ object Versions {
   val sttp = "3.9.1"
   val sttpModel = "1.7.6"
   val sttpShared = "1.3.16"
-  val sttpApispec = "0.7.1"
+  val sttpApispec = "0.7.1+16-f56e2f94-SNAPSHOT"
   val akkaHttp = "10.2.10"
   val akkaStreams = "2.6.20"
   val pekkoHttp = "1.0.0"