get response ref object

Author: hauner

openapi-parser/src/main/java/io/openapiparser/model/v30/Response.java

@@ -38,6 +38,10 @@ public String getRef () {
         return getStringOrThrow (REF);
     }
 
+    public Response getRefObject () {
+        return getRefObjectOrThrow (Response.class);
+    }
+
     @Required
     public String getDescription () {
         return getStringOrThrow (DESCRIPTION);

openapi-parser/src/main/java/io/openapiparser/model/v31/Response.java

@@ -38,6 +38,10 @@ public String getRef () {
         return getStringOrThrow (REF);
     }
 
+    public Response getRefObject () {
+        return getRefObjectOrThrow (Response.class);
+    }
+
     @Override
     public @Nullable String getSummary () {
         return getStringOrNull (SUMMARY);

openapi-parser/src/test/kotlin/io/openapiparser/RefSpec.kt

@@ -6,10 +6,12 @@
 package io.openapiparser
 
 import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.booleans.shouldBeTrue
 import io.kotest.matchers.shouldBe
 import io.openapiparser.support.ApiBuilder
 import io.openapiparser.support.getParameters
 import io.openapiparser.support.getResponseSchema
+import io.openapiparser.support.getResponses
 import io.openapiparser.model.v30.Schema as Schema30
 
 class RefSpec: StringSpec({
@@ -124,6 +126,21 @@ class RefSpec: StringSpec({
         parameterRef.name shouldBe "bar"
     }
 
+    "parses ref in response" {
+        val api = ApiBuilder()
+            .buildOpenApi30("/v30/ref-response/openapi.yaml")
+
+        val responses = api.getResponses("/foo")
+        val responseRef = responses.getResponse("200")!!
+
+        responseRef.isRef.shouldBeTrue()
+        val response = responseRef.refObject
+
+        val content = response.content
+        content.size shouldBe 1
+        content.containsKey("plain/text") shouldBe true
+    }
+
     "parses ref relative to current file" {
         val api = ApiBuilder()
             .buildOpenApi30("/v30/ref-is-relative-to-current-file/openapi.yaml")

openapi-parser/src/test/kotlin/io/openapiparser/support/OpenApi.kt

@@ -6,6 +6,7 @@
 package io.openapiparser.support
 
 import io.kotest.matchers.nulls.shouldNotBeNull
+import io.openapiparser.model.v30.Responses as Responses30
 import io.openapiparser.model.v30.OpenApi as OpenApi30
 import io.openapiparser.model.v30.Parameter as Parameter30
 import io.openapiparser.model.v30.Schema as Schema30
@@ -39,3 +40,13 @@ fun OpenApi30.getParameters(path: String): Collection<Parameter30> {
     return operation.parameters
 }
 
+fun OpenApi30.getResponses(path: String): Responses30 {
+    val pathItem = paths.getPathItem(path)
+    pathItem.shouldNotBeNull()
+
+    val operation = pathItem.get
+    operation.shouldNotBeNull()
+
+    return operation.responses
+}
+

openapi-parser/src/test/resources/v30/ref-response/openapi.yaml

@@ -0,0 +1,20 @@
+openapi: 3.0.3
+info:
+  title: ref responses
+  version: 1.0.0
+
+paths:
+  /foo:
+    get:
+      responses:
+        '200':
+          $ref: '#/components/responses/Bar'
+
+components:
+  responses:
+    Bar:
+      description: plain text response
+      content:
+        plain/text:
+          schema:
+            type: string