Skip type resolving on Schema with items set (#1916) the

Author: DerManoMann

src/Type/LegacyTypeResolver.php

@@ -57,6 +57,10 @@ protected function doAugment(Analysis $analysis, OA\Schema $schema, \Reflector $
 
         $this->type2ref($schema, $analysis);
 
+        if ($schema->items instanceof OA\Items) {
+            $schema->type = 'array';
+        }
+
         if (!Generator::isDefault($schema->const) && Generator::isDefault($schema->type)) {
             if (!$this->mapNativeType($schema, gettype($schema->const))) {
                 $schema->type = Generator::UNDEFINED;

src/Type/TypeInfoTypeResolver.php

@@ -59,6 +59,10 @@ protected function doAugment(Analysis $analysis, OA\Schema $schema, \Reflector $
 
         $this->type2ref($schema, $analysis, $sourceClass);
 
+        if ($schema->items instanceof OA\Items) {
+            $schema->type = 'array';
+        }
+
         if (!Generator::isDefault($schema->const) && Generator::isDefault($schema->type)) {
             if (!$this->mapNativeType($schema, gettype($schema->const))) {
                 $schema->type = Generator::UNDEFINED;
@@ -93,6 +97,11 @@ protected function setSchemaType(OA\Schema $schema, Type $type, Analysis $analys
                         $builtinTypes = array_filter($types, static fn (Type $t): bool => $t instanceof BuiltinType);
                         $otherTypes = array_filter($types, static fn (Type $t): bool => !$t instanceof BuiltinType);
 
+                        if ($schema->items instanceof OA\Items) {
+                            // nothing more we can do here
+                            return $schema;
+                        }
+
                         $schema->type = Generator::UNDEFINED;
                         $schema->oneOf = [];
 

tests/Fixtures/PHP/DocblockAndTypehintTypes.php

@@ -219,4 +219,19 @@ public function blah(
 
     #[OAT\Property]
     public FirstInterface&SecondInterface $intersectionVar;
+
+    /**
+     * @var array<DocblockAndTypehintTypes>|array<string>
+     */
+    #[OAT\Property]
+    public array $nestedOneOf;
+
+    /**
+     * @var array<DocblockAndTypehintTypes>|array<string>
+     */
+    #[OAT\Property(items: new OAT\Items(oneOf: [
+        new OAT\Schema(type: DocblockAndTypehintTypes::class),
+        new OAT\Schema(type: 'string'),
+    ]))]
+    public array $nestedOneOfWithItems;
 }

tests/Fixtures/Scratch/NestedSchema.php

@@ -18,6 +18,22 @@ class NestedSchemaTwo
 {
 }
 
+#[OAT\Schema]
+class MultipleOneOf
+{
+    /**
+     * @param array<MultipleOneOf>|array<NestedSchemaTwo> $values
+     */
+    public function __construct(
+        #[OAT\Property(items: new OAT\Items(oneOf: [
+            new OAT\Schema(type: MultipleOneOf::class, description: 'Recursive nested item'),
+            new OAT\Schema(type: NestedSchemaTwo::class, description: 'Another item'),
+        ]))]
+        public array $values
+    ) {
+    }
+}
+
 #[OAT\Info(
     title: 'Parameter Content Scratch',
     version: '1.0'

tests/Fixtures/Scratch/NestedSchema3.0.0.yaml

@@ -26,6 +26,17 @@ components:
   schemas:
     NestedSchemaOne: {  }
     NestedSchemaTwo: {  }
+    MultipleOneOf:
+      properties:
+        values:
+          type: array
+          items:
+            oneOf:
+              -
+                $ref: '#/components/schemas/MultipleOneOf'
+              -
+                $ref: '#/components/schemas/NestedSchemaTwo'
+      type: object
     NestedSchema:
       required:
         - errors

tests/Fixtures/Scratch/NestedSchema3.1.0.yaml

@@ -26,6 +26,19 @@ components:
   schemas:
     NestedSchemaOne: {  }
     NestedSchemaTwo: {  }
+    MultipleOneOf:
+      properties:
+        values:
+          type: array
+          items:
+            oneOf:
+              -
+                $ref: '#/components/schemas/MultipleOneOf'
+                description: 'Recursive nested item'
+              -
+                $ref: '#/components/schemas/NestedSchemaTwo'
+                description: 'Another item'
+      type: object
     NestedSchema:
       required:
         - errors

tests/Fixtures/Scratch/NestedSchema3.2.0.yaml

@@ -26,6 +26,19 @@ components:
   schemas:
     NestedSchemaOne: {  }
     NestedSchemaTwo: {  }
+    MultipleOneOf:
+      properties:
+        values:
+          type: array
+          items:
+            oneOf:
+              -
+                $ref: '#/components/schemas/MultipleOneOf'
+                description: 'Recursive nested item'
+              -
+                $ref: '#/components/schemas/NestedSchemaTwo'
+                description: 'Another item'
+      type: object
     NestedSchema:
       required:
         - errors

tests/Type/TypeResolverTest.php

@@ -62,6 +62,10 @@ public static function resolverAugmentCases(): iterable
                 'reflectionvalue' => '{ "example": true, "nullable": true, "property": "reflectionValue" }',
                 'legacy:intersectionvar' => '{ "property": "intersectionVar" }',
                 'type-info:intersectionvar' => '{ "allOf": [ { "$ref": "#/components/schemas/FirstInterface" }, { "$ref": "#/components/schemas/SecondInterface" } ], "property": "intersectionVar" }',
+                'legacy:nestedoneof' => '{ "property": "nestedOneOf" }',
+                'type-info:nestedoneof' => '{ "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DocblockAndTypehintTypes" } }, { "type": "array", "items": { "type": "string" } } ], "property": "nestedOneOf" }',
+                'legacy:nestedoneofwithitems' => '{ "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DocblockAndTypehintTypes" }, { "type": "string" } ] }, "property": "nestedOneOfWithItems" }',
+                'type-info:nestedoneofwithitems' => '{ "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DocblockAndTypehintTypes" }, { "type": "string" } ] }, "property": "nestedOneOfWithItems" }',
             ],
             OA\OpenApi::VERSION_3_1_0 => [
                 'nothing' => '{ "property": "nothing" }',
@@ -104,6 +108,10 @@ public static function resolverAugmentCases(): iterable
                 'type-info:reflectionvalue' => '{ "type": [ "boolean", "integer", "null" ], "example": true, "property": "reflectionValue" }',
                 'legacy:intersectionvar' => '{ "property": "intersectionVar" }',
                 'type-info:intersectionvar' => '{ "allOf": [ { "$ref": "#/components/schemas/FirstInterface" }, { "$ref": "#/components/schemas/SecondInterface" } ], "property": "intersectionVar" }',
+                'legacy:nestedoneof' => '{ "property": "nestedOneOf" }',
+                'type-info:nestedoneof' => '{ "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DocblockAndTypehintTypes" } }, { "type": "array", "items": { "type": "string" } } ], "property": "nestedOneOf" }',
+                'legacy:nestedoneofwithitems' => '{ "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DocblockAndTypehintTypes" }, { "type": "string" } ] }, "property": "nestedOneOfWithItems" }',
+                'type-info:nestedoneofwithitems' => '{ "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DocblockAndTypehintTypes" }, { "type": "string" } ] }, "property": "nestedOneOfWithItems" }',
             ],
         ];