Allow a ref to be nullable (#1391)

zircote · Feb 20, 2023 · f2bcbd5 · f2bcbd5
1 parent 9983523
commit f2bcbd5
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 8 deletions.
diff --git a/src/Annotations/AbstractAnnotation.php b/src/Annotations/AbstractAnnotation.php
@@ -356,8 +356,8 @@ public function jsonSerialize()
         if (isset($data->ref)) {
             // Only specific https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#reference-object
             $ref = ['$ref' => $data->ref];
-            if ($this->_context->version == OpenApi::VERSION_3_1_0) {
-                $defaultValues = get_class_vars(get_class($this));
+            $defaultValues = get_class_vars(get_class($this));
+            if ($this->_context->version === OpenApi::VERSION_3_1_0) {
                 foreach (['summary', 'description'] as $prop) {
                     if (property_exists($this, $prop)) {
                         if ($this->{$prop} !== $defaultValues[$prop]) {
@@ -366,10 +366,19 @@ public function jsonSerialize()
                     }
                 }
             }
+            if (property_exists($this, 'nullable') && $this->nullable === true) {
+                $ref = ['oneOf' => [$ref]];
+                if ($this->_context->version == OpenApi::VERSION_3_1_0) {
+                    $ref['oneOf'][] = ['type' => 'null'];
+                } else {
+                    $ref['nullable'] = $data->nullable;
+                }
+                unset($data->nullable);
+            }
             $data = (object) $ref;
         }
 
-        if ($this->_context->version == OpenApi::VERSION_3_1_0) {
+        if ($this->_context->version === OpenApi::VERSION_3_1_0) {
             if (isset($data->nullable)) {
                 if (true === $data->nullable) {
                     $data->type = (array) $data->type;

diff --git a/tests/Fixtures/Scratch/NullRef.yaml b/tests/Fixtures/Scratch/NullRef.yaml
@@ -12,7 +12,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/repository'
+                oneOf:
+                  - { $ref: '#/components/schemas/repository' }
+                nullable: true
   /api/refplus:
     get:
       operationId: refplus
@@ -22,7 +24,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/repository'
+                oneOf:
+                  - { $ref: '#/components/schemas/repository' }
+                nullable: true
 components:
   schemas:
     repository: {  }
diff --git a/tests/Fixtures/Scratch/NullRef31.yaml b/tests/Fixtures/Scratch/NullRef31.yaml
@@ -12,7 +12,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/repository'
+                oneOf:
+                  - { $ref: '#/components/schemas/repository' }
+                  - { type: 'null' }
   /api/refplus:
     get:
       operationId: refplus
@@ -22,8 +24,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/repository'
-                description: 'The repository'
+                oneOf:
+                  - { $ref: '#/components/schemas/repository', description: 'The repository' }
+                  - { type: 'null' }
 components:
   schemas:
     repository: {  }