Handle legacy MediaType::encoding values (#1845)

Author: DerManoMann

src/Annotations/MediaType.php

@@ -82,4 +82,29 @@ class MediaType extends AbstractAnnotation
         Response::class,
         RequestBody::class,
     ];
+
+    public function __construct(array $properties)
+    {
+        if (array_key_exists('encoding', $properties)) {
+            $properties['encoding'] = $this->encodingCompat(
+                $properties['encoding'],
+                fn (array $args): Encoding => new Encoding($args),
+            );
+        }
+        parent::__construct($properties);
+    }
+
+    protected function encodingCompat($encoding, callable $factory)
+    {
+        if (!is_array($encoding)) {
+            return $encoding;
+        }
+
+        $compat = [];
+        foreach ($encoding as $name => $value) {
+            $compat[] = is_array($value) ? $factory([...$value, 'property' => $name]) : $value;
+        }
+
+        return $compat;
+    }
 }

src/Attributes/MediaType.php

@@ -33,7 +33,10 @@ public function __construct(
                 'example' => $example,
                 'x' => $x ?? Generator::UNDEFINED,
                 'attachables' => $attachables ?? Generator::UNDEFINED,
-                'value' => $this->combine($schema, $examples, $encoding),
+                'value' => $this->combine($schema, $examples, $this->encodingCompat(
+                    $encoding,
+                    fn (array $args): Encoding => new Encoding(...$args),
+                )),
             ]);
     }
 }

tests/Fixtures/Scratch/Encoding.php

@@ -6,6 +6,7 @@
 
 namespace OpenApi\Tests\Fixtures\Scratch;
 
+use OpenApi\Annotations as OA;
 use OpenApi\Attributes as OAT;
 
 #[OAT\Schema()]
@@ -133,4 +134,57 @@ public function multipartFormDataJsonContent()
     {
 
     }
+
+    #[OAT\Post(
+        path: '/endpoint/bc-encoding-attr',
+        requestBody: new OAT\RequestBody(
+            content: new OAT\MediaType(
+                mediaType: 'multipart/form-data',
+                schema: new OAT\Schema(
+                    properties: [
+                        new OAT\Property(property: 'encname', type: 'string'),
+                        ],
+                ),
+                encoding: [
+                    'encname' => [
+                       'contentType' => 'application/json',
+                    ],
+                ],
+            ),
+        ),
+        responses: [
+            new OAT\Response(
+                response: 200,
+                description: 'All good',
+            ),
+        ]
+    )]
+    public function bcEncodingAttr()
+    {
+
+    }
+
+    /**
+     * @OA\Post(
+     *     path="/endpoint/bc-encoding-annot",
+     *     @OA\RequestBody(
+     *         @OA\MediaType(
+     *             mediaType="multipart-form-data",
+     *             @OA\Schema(
+     *                 @OA\Property(property="encname")
+     *             ),
+     *             encoding={
+     *                 "encname": {
+     *                     "contentType": "application/json"
+     *                 }
+     *             }
+     *         )
+     *     ),
+     *     @OA\Response(response="200", description="OK")
+     * )
+     */
+    public function bcEncodingAnnot()
+    {
+
+    }
 }

tests/Fixtures/Scratch/Encoding3.0.0.yaml

@@ -63,6 +63,39 @@ paths:
       responses:
         '200':
           description: 'All good'
+  /endpoint/bc-encoding-attr:
+    post:
+      operationId: 93c969c0f67dc55b9f7f88f6e46d4230
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              properties:
+                encname:
+                  type: string
+              type: object
+            encoding:
+              encname:
+                contentType: application/json
+      responses:
+        '200':
+          description: 'All good'
+  /endpoint/bc-encoding-annot:
+    post:
+      operationId: efe7afb9b99c111a0d781e14982abcdf
+      requestBody:
+        content:
+          multipart-form-data:
+            schema:
+              properties:
+                encname: {  }
+              type: object
+            encoding:
+              encname:
+                contentType: application/json
+      responses:
+        '200':
+          description: OK
 components:
   schemas:
     EncodingMetadata: {  }

tests/Fixtures/Scratch/Encoding3.1.0.yaml

@@ -63,6 +63,39 @@ paths:
       responses:
         '200':
           description: 'All good'
+  /endpoint/bc-encoding-attr:
+    post:
+      operationId: 93c969c0f67dc55b9f7f88f6e46d4230
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              properties:
+                encname:
+                  type: string
+              type: object
+            encoding:
+              encname:
+                contentType: application/json
+      responses:
+        '200':
+          description: 'All good'
+  /endpoint/bc-encoding-annot:
+    post:
+      operationId: efe7afb9b99c111a0d781e14982abcdf
+      requestBody:
+        content:
+          multipart-form-data:
+            schema:
+              properties:
+                encname: {  }
+              type: object
+            encoding:
+              encname:
+                contentType: application/json
+      responses:
+        '200':
+          description: OK
 components:
   schemas:
     EncodingMetadata: {  }