Add support for content to Parameter attribute (#1344)

* Add support for `content` to `Parameter` attribute * .
zircote · Nov 8, 2022 · 03ea107 · 03ea107
1 parent e3e07b4
commit 03ea107
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 7 deletions.
diff --git a/src/Annotations/Parameter.php b/src/Annotations/Parameter.php
@@ -163,7 +163,7 @@ class Parameter extends AbstractAnnotation
      * The key is the media type and the value describes it.
      * The map must only contain one entry.
      *
-     * @var MediaType[]
+     * @var array<MediaType>|JsonContent|XmlContent|Attachable
      */
     public $content = Generator::UNDEFINED;
 

diff --git a/src/Attributes/ParameterTrait.php b/src/Attributes/ParameterTrait.php
@@ -11,9 +11,10 @@
 trait ParameterTrait
 {
     /**
-     * @param array<string,Examples>   $examples
-     * @param array<string,mixed>|null $x
-     * @param Attachable[]|null        $attachables
+     * @param array<string,Examples>                                  $examples
+     * @param array<MediaType>|JsonContent|XmlContent|Attachable|null $content
+     * @param array<string,mixed>|null                                $x
+     * @param Attachable[]|null                                       $attachables
      */
     public function __construct(
         ?string $parameter = null,
@@ -27,6 +28,7 @@ public function __construct(
         ?Schema $schema = null,
         mixed $example = Generator::UNDEFINED,
         ?array $examples = null,
+        array|JsonContent|XmlContent|Attachable|null $content = null,
         ?string $style = null,
         ?bool $explode = null,
         ?bool $allowReserved = null,
@@ -52,7 +54,7 @@ public function __construct(
                 'spaceDelimited' => $spaceDelimited ?? Generator::UNDEFINED,
                 'pipeDelimited' => $pipeDelimited ?? Generator::UNDEFINED,
                 'x' => $x ?? Generator::UNDEFINED,
-                'value' => $this->combine($schema, $examples, $attachables),
+                'value' => $this->combine($schema, $examples, $content, $attachables),
             ]);
     }
 }
diff --git a/tests/Annotations/AttributesSyncTest.php b/tests/Annotations/AttributesSyncTest.php
@@ -16,7 +16,7 @@ class AttributesSyncTest extends OpenApiTestCase
 {
     public static $SCHEMA_EXCLUSIONS = ['const', 'maxProperties', 'minProperties', 'multipleOf', 'not', 'additionalItems', 'contains', 'patternProperties', 'dependencies', 'propertyNames'];
     public static $PATHITEM_EXCLUSIONS = ['ref', 'get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'];
-    public static $PARAMETER_EXCLUSIONS = ['content', 'matrix', 'label', 'form', 'simple', 'deepObject'];
+    public static $PARAMETER_EXCLUSIONS = ['matrix', 'label', 'form', 'simple', 'deepObject'];
 
     public function testCounts(): void
     {

diff --git a/tests/Fixtures/Scratch/ParameterContent.php b/tests/Fixtures/Scratch/ParameterContent.php
@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+use OpenApi\Attributes as OAT;
+
+/**
+ * An API endpoint.
+ */
+#[OAT\Info(
+    title: 'Parameter Content Scratch',
+    version: '1.0'
+)]
+#[OAT\Get(
+    path: '/api/endpoint',
+    tags: ['endpoints'],
+    description: 'An endpoint',
+    operationId: 'endpoint',
+    parameters: [
+        new OAT\Parameter(
+            name: 'filter',
+            in: 'query',
+            content: new OAT\JsonContent(
+                properties: [
+                    new OAT\Property(property: 'type', type: 'string'),
+                    new OAT\Property(property: 'color', type: 'string'),
+                ]
+            )
+        ),
+    ],
+    responses: [new OAT\Response(response: 200, description: 'OK')]
+)]
+class Endpoint
+{
+}
diff --git a/tests/Fixtures/Scratch/ParameterContent.yaml b/tests/Fixtures/Scratch/ParameterContent.yaml
@@ -0,0 +1,26 @@
+openapi: 3.0.0
+info:
+  title: 'Parameter Content Scratch'
+  version: '1.0'
+paths:
+  /api/endpoint:
+    get:
+      tags:
+        - endpoints
+      summary: 'An API endpoint.'
+      description: 'An endpoint'
+      operationId: endpoint
+      parameters:
+        -
+          name: filter
+          in: query
+          content:
+            application/json:
+              schema:
+                properties:
+                  type: { type: string }
+                  color: { type: string }
+                type: object
+      responses:
+        '200':
+          description: OK
diff --git a/tests/ScratchTest.php b/tests/ScratchTest.php
@@ -29,7 +29,7 @@ public function scratchTests(): iterable
      *
      * @dataProvider scratchTests
      *
-     * @requires     PHP 7.4
+     * @requires     PHP 8.1
      */
     public function testScratch(string $version, string $scratch, string $spec, array $expectedLog): void
     {