api: extract examples for nested write payload ourselves

With
- api-platform/core#6960
generating the nested write payload objects via the schema completely broke.
The examples in the OpenApi Webui are still broken.

Author: BacLuc

api/tests/Api/Activities/CreateActivityTest.php

@@ -693,7 +693,12 @@ public function getExampleReadPayload($attributes = [], $except = []) {
             Activity::class,
             Get::class,
             $attributes,
-            ['category', 'progressLabel'],
+            [
+                'category',
+                'progressLabel',
+                'camp',
+                'rootContentNode',
+            ],
             $except
         );
     }

api/tests/Api/Categories/CreateCategoryTest.php

@@ -648,7 +648,11 @@ public function getExampleReadPayload($attributes = [], $except = []) {
             Category::class,
             Get::class,
             $attributes,
-            ['camp', 'preferredContentTypes'],
+            [
+                'camp',
+                'preferredContentTypes',
+                'rootContentNode',
+            ],
             $except
         );
     }

api/tests/Api/Comments/CreateCommentTest.php

@@ -173,7 +173,7 @@ public function getExampleWritePayload($attributes = [], $except = []) {
                 'camp' => $this->getIriFor('camp1'),
                 'activity' => $this->getIriFor('activity1'),
             ], $attributes),
-            [],
+            ['author'],
             $except
         );
     }

api/tests/Api/Comments/ListCommentsTest.php

@@ -52,7 +52,9 @@ public function testListCommentsSortyByCreateTime() {
                 'camp' => $this->getIriFor('camp1'),
                 'activity' => $this->getIriFor('activity1'),
             ],
-            [],
+            [
+                'author',
+            ],
             []
         )])->toArray();
 

api/tests/Api/ECampApiTestCase.php

@@ -184,6 +184,8 @@ protected function getExamplePayload(string $resourceClass, string $operationCla
             $schemaName = $matches[1];
             $properties = $schema->getDefinitions()[$schemaName]['properties'] ?? [];
             $writableProperties = array_filter($properties, fn ($property) => !($property['readOnly'] ?? false));
+            $exampleExtractor = new ExampleExtractor($resourceClass);
+            array_walk($writableProperties, fn (&$property, $key) => $property['example'] = $exampleExtractor->getExampleFor($key, $property));
             $writablePropertiesWithExample = array_filter($writableProperties, fn ($property) => ($property['example'] ?? false));
             $examples = array_map(fn ($property) => $property['example'] ?? $property['default'] ?? null, $writablePropertiesWithExample);
             $examples = array_map(function ($example) {

api/tests/Api/ExampleExtractor.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace App\Tests\Api;
+
+use ApiPlatform\Metadata\ApiProperty;
+
+readonly class ExampleExtractor {
+    private \ReflectionClass $reflectionClass;
+
+    /**
+     * @throws \ReflectionException
+     */
+    public function __construct(
+        string $resourceClass
+    ) {
+        $this->reflectionClass = new \ReflectionClass($resourceClass);
+    }
+
+    /**
+     * @throws \ReflectionException
+     */
+    public function getExampleFor($propertyName, $schemaProperty) {
+        if (isset($schemaProperty['example'])) {
+            return $schemaProperty['example'];
+        }
+        $reflectionProperty = $this->reflectionClass->getProperty($propertyName);
+        $reflectionAttributes = $reflectionProperty->getAttributes(ApiProperty::class);
+        if (empty($reflectionAttributes)) {
+            return null;
+        }
+        if (count($reflectionAttributes) > 1) {
+            $apiPropertyClass = ApiProperty::class;
+
+            throw new \RuntimeException("More than one {$apiPropertyClass} annotation found for property {$this->reflectionClass->name}->{$propertyName}");
+        }
+
+        return $reflectionAttributes[0]->newInstance()->getExample();
+    }
+}

api/tests/Api/MaterialItems/CreateMaterialItemTest.php

@@ -386,7 +386,7 @@ public function testCreateMaterialItemValidatesInvalidQuantity() {
 
         $this->assertResponseStatusCodeSame(400);
         $this->assertJsonContains([
-            'detail' => 'The type of the "quantity" attribute must be "float", "string" given.',
+            'detail' => 'The type of the "quantity" attribute must be "float|null", "string" given.',
         ]);
     }
 
@@ -521,7 +521,12 @@ public function getExampleReadPayload($attributes = [], $except = []) {
             MaterialItem::class,
             Get::class,
             $attributes,
-            ['materialList', 'period', 'materialNode'],
+            [
+                'materialList',
+                'period',
+                'materialNode',
+                'camp',
+            ],
             $except
         );
     }