fix support for references in Responses object

Author: cebe

src/spec/OpenApi.php

@@ -18,7 +18,7 @@
  * @property-read string $openapi
  * @property-read Info $info
  * @property-read Server[] $servers
- * @property-read Paths $paths
+ * @property-read Paths|PathItem[] $paths
  * @property-read Components|null $components
  * @property-read SecurityRequirement[] $security
  * @property-read Tag[] $tags

src/spec/Responses.php

@@ -42,7 +42,11 @@ public function __construct(array $data)
             // From Spec: This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML.
             $statusCode = (string) $statusCode;
             if (preg_match('~^(?:default|[1-5](?:[0-9][0-9]|XX))$~', $statusCode)) {
-                $this->_responses[$statusCode] = new Response($response);
+                if (isset($response['$ref'])) {
+                    $this->_responses[$statusCode] = new Reference($response, Response::class);
+                } else {
+                    $this->_responses[$statusCode] = new Response($response);
+                }
             } else {
                 $this->_errors[] = "Responses: $statusCode is not a valid HTTP status code.";
             }
@@ -60,15 +64,15 @@ public function hasResponse($statusCode): bool
 
     /**
      * @param string $statusCode HTTP status code
-     * @return PathItem
+     * @return Response|Reference
      */
-    public function getResponse($statusCode): ?Response
+    public function getResponse($statusCode)
     {
         return $this->_responses[$statusCode] ?? null;
     }
 
     /**
-     * @return Response[]
+     * @return Response[]|Reference[]
      */
     public function getResponses(): array
     {

tests/spec/ReferenceTest.php

@@ -3,6 +3,7 @@
 use cebe\openapi\Reader;
 use cebe\openapi\spec\OpenApi;
 use cebe\openapi\spec\Reference;
+use cebe\openapi\spec\Response;
 use cebe\openapi\spec\Schema;
 use cebe\openapi\spec\Example;
 
@@ -29,6 +30,9 @@ public function testResolveInDocument()
   examples:
     frog-example:
       description: a frog
+  responses:
+    Pet:
+      description: returns a pet
 paths:
   '/pet':
     get:
@@ -42,25 +46,33 @@ public function testResolveInDocument()
               examples:
                 frog:
                   $ref: "#/components/examples/frog-example"
+  '/pet/1':
+    get:
+      responses:
+        200:
+          $ref: "#/components/responses/Pet"
 YAML
             , OpenApi::class);
 
         $result = $openapi->validate();
         $this->assertEquals([], $openapi->getErrors());
         $this->assertTrue($result);
 
-        /** @var $response \cebe\openapi\spec\Response */
-        $response = $openapi->paths->getPath('/pet')->get->responses['200'];
-        $this->assertInstanceOf(Reference::class, $response->content['application/json']->schema);
-        $this->assertInstanceOf(Reference::class, $response->content['application/json']->examples['frog']);
+        /** @var $petResponse Response */
+        $petResponse = $openapi->paths->getPath('/pet')->get->responses['200'];
+        $this->assertInstanceOf(Reference::class, $petResponse->content['application/json']->schema);
+        $this->assertInstanceOf(Reference::class, $petResponse->content['application/json']->examples['frog']);
+        $this->assertInstanceOf(Reference::class, $openapi->paths->getPath('/pet/1')->get->responses['200']);
 
         $openapi->resolveReferences(new \cebe\openapi\ReferenceContext($openapi, 'file:///tmp/openapi.yaml'));
 
-        $this->assertInstanceOf(Schema::class, $refSchema = $response->content['application/json']->schema);
-        $this->assertInstanceOf(Example::class, $refExample = $response->content['application/json']->examples['frog']);
+        $this->assertInstanceOf(Schema::class, $refSchema = $petResponse->content['application/json']->schema);
+        $this->assertInstanceOf(Example::class, $refExample = $petResponse->content['application/json']->examples['frog']);
+        $this->assertInstanceOf(Response::class, $refResponse = $openapi->paths->getPath('/pet/1')->get->responses['200']);
 
         $this->assertSame($openapi->components->schemas['Pet'], $refSchema);
         $this->assertSame($openapi->components->examples['frog-example'], $refExample);
+        $this->assertSame($openapi->components->responses['Pet'], $refResponse);
     }
 
     public function testResolveCyclicReferenceInDocument()
@@ -105,7 +117,7 @@ public function testResolveCyclicReferenceInDocument()
         $this->assertEquals([], $openapi->getErrors());
         $this->assertTrue($result);
 
-        /** @var $response \cebe\openapi\spec\Response */
+        /** @var $response Response */
         $response = $openapi->paths->getPath('/pet')->get->responses['200'];
         $this->assertInstanceOf(Reference::class, $response->content['application/json']->schema);
         $this->assertInstanceOf(Reference::class, $response->content['application/json']->examples['frog']);