Adding openapi_context attribute

Author: antograssiot

src/Annotation/ApiProperty.php

@@ -26,6 +26,7 @@
  *     @Attribute("deprecationReason", type="string"),
  *     @Attribute("fetchable", type="bool"),
  *     @Attribute("fetchEager", type="bool"),
+ *     @Attribute("openapiContext", type="array"),
  *     @Attribute("jsonldContext", type="array"),
  *     @Attribute("swaggerContext", type="array")
  * )
@@ -109,6 +110,13 @@ final class ApiProperty
      */
     private $swaggerContext;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var array
+     */
+    private $openapiContext;
+
     /**
      * @throws InvalidArgumentException
      */

src/Annotation/ApiResource.php

@@ -43,6 +43,7 @@
  *     @Attribute("maximumItemsPerPage", type="int"),
  *     @Attribute("mercure", type="mixed"),
  *     @Attribute("normalizationContext", type="array"),
+ *     @Attribute("openapiContext", type="array"),
  *     @Attribute("order", type="array"),
  *     @Attribute("outputClass", type="string"),
  *     @Attribute("paginationClientEnabled", type="bool"),
@@ -288,6 +289,13 @@ final class ApiResource
      */
     private $outputClass;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var array
+     */
+    private $openapiContext;
+
     /**
      * @throws InvalidArgumentException
      */

src/OpenAPI/Serializer/AbstractDocumentationNormalizer.php

@@ -36,6 +36,7 @@
 abstract class AbstractDocumentationNormalizer implements NormalizerInterface, CacheableSupportsMethodInterface
 {
     const FORMAT = 'json';
+    const ATTRIBUTE_NAME = 'openapi_context';
 
     protected $resourceMetadataFactory;
     protected $propertyNameCollectionFactory;
@@ -212,7 +213,7 @@ protected function getDefinitionSchema(string $resourceClass, ResourceMetadata $
      */
     protected function getPropertySchema(PropertyMetadata $propertyMetadata, \ArrayObject $definitions, array $serializerContext = null): \ArrayObject
     {
-        $propertySchema = new \ArrayObject($propertyMetadata->getAttributes()['swagger_context'] ?? []);
+        $propertySchema = new \ArrayObject($propertyMetadata->getAttributes()[static::ATTRIBUTE_NAME] ?? []);
 
         if (false === $propertyMetadata->isWritable() && !$propertyMetadata->isInitializable()) {
             $propertySchema['readOnly'] = true;
@@ -249,7 +250,7 @@ protected function getPropertySchema(PropertyMetadata $propertyMetadata, \ArrayO
      */
     protected function getPathOperation(string $operationName, array $operation, string $method, string $operationType, string $resourceClass, ResourceMetadata $resourceMetadata, array $mimeTypes, \ArrayObject $definitions): \ArrayObject
     {
-        $pathOperation = new \ArrayObject($operation['swagger_context'] ?? []);
+        $pathOperation = new \ArrayObject($operation[static::ATTRIBUTE_NAME] ?? []);
         $resourceShortName = $resourceMetadata->getShortName();
         $pathOperation['tags'] ?? $pathOperation['tags'] = [$resourceShortName];
         $pathOperation['operationId'] ?? $pathOperation['operationId'] = lcfirst($operationName).ucfirst($resourceShortName).ucfirst($operationType);

src/Swagger/Serializer/DocumentationNormalizer.php

@@ -44,6 +44,7 @@ final class DocumentationNormalizer extends AbstractDocumentationNormalizer
 
     const SWAGGER_VERSION = '2.0';
     const SWAGGER_DEFINITION_NAME = 'swagger_definition_name';
+    const ATTRIBUTE_NAME = 'swagger_context';
 
     /**
      * @param ContainerInterface|FilterCollection|null $filterLocator The new filter locator or the deprecated filter collection

tests/Annotation/ApiPropertyTest.php

@@ -53,6 +53,7 @@ public function testConstruct()
             'fetchEager' => false,
             'jsonldContext' => ['foo' => 'bar'],
             'swaggerContext' => ['foo' => 'baz'],
+            'openapiContext' => ['foo' => 'baz'],
             'attributes' => ['unknown' => 'unknown', 'fetchable' => false],
         ]);
         $this->assertEquals([
@@ -61,6 +62,7 @@ public function testConstruct()
             'fetch_eager' => false,
             'jsonld_context' => ['foo' => 'bar'],
             'swagger_context' => ['foo' => 'baz'],
+            'openapi_context' => ['foo' => 'baz'],
             'unknown' => 'unknown',
         ], $property->attributes);
     }

tests/Annotation/ApiResourceTest.php

@@ -44,6 +44,7 @@ public function testConstruct()
             'mercure' => '[\'foo\', object.owner]',
             'normalizationContext' => ['groups' => ['bar']],
             'order' => ['foo', 'bar' => 'ASC'],
+            'openapiContext' => ['description' => 'foo'],
             'paginationClientEnabled' => true,
             'paginationClientItemsPerPage' => true,
             'paginationClientPartial' => true,
@@ -54,6 +55,7 @@ public function testConstruct()
             'routePrefix' => '/foo',
             'shortName' => 'shortName',
             'subresourceOperations' => [],
+            'swaggerContext' => ['description' => 'bar'],
             'validationGroups' => ['foo', 'bar'],
             'sunset' => 'Thu, 11 Oct 2018 00:00:00 +0200',
         ]);
@@ -78,6 +80,7 @@ public function testConstruct()
             'mercure' => '[\'foo\', object.owner]',
             'normalization_context' => ['groups' => ['bar']],
             'order' => ['foo', 'bar' => 'ASC'],
+            'openapi_context' => ['description' => 'foo'],
             'pagination_client_enabled' => true,
             'pagination_client_items_per_page' => true,
             'pagination_client_partial' => true,
@@ -86,6 +89,7 @@ public function testConstruct()
             'pagination_items_per_page' => 42,
             'pagination_partial' => true,
             'route_prefix' => '/foo',
+            'swagger_context' => ['description' => 'bar'],
             'validation_groups' => ['baz', 'qux'],
             'cache_headers' => ['max_age' => 0, 'shared_max_age' => 0],
             'sunset' => 'Thu, 11 Oct 2018 00:00:00 +0200',

tests/Fixtures/TestBundle/Entity/DummyCar.php

@@ -26,7 +26,7 @@
 
 /**
  * @ApiResource(
- *     itemOperations={"get"={"swagger_context"={"tags"={}}}, "put", "delete"},
+ *     itemOperations={"get"={"swagger_context"={"tags"={}}, "openapi_context"={"tags"={}}}, "put", "delete"},
  *     attributes={
  *         "normalization_context"={"groups"={"colors"}},
  *         "sunset"="2050-01-01"

tests/OpenAPI/Serializer/DocumentationNormalizerTest.php

@@ -2034,7 +2034,7 @@ public function testNormalizeWithPropertyOpenAPIContext()
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
         $propertyMetadataFactoryProphecy->create(Dummy::class, 'id')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_INT), 'This is an id.', true, false));
-        $propertyMetadataFactoryProphecy->create(Dummy::class, 'name')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), 'This is a name.', true, true, true, true, false, false, null, null, ['swagger_context' => ['type' => 'string', 'enum' => ['one', 'two'], 'example' => 'one']]));
+        $propertyMetadataFactoryProphecy->create(Dummy::class, 'name')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), 'This is a name.', true, true, true, true, false, false, null, null, ['openapi_context' => ['type' => 'string', 'enum' => ['one', 'two'], 'example' => 'one']]));
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(Dummy::class)->willReturn(true);
 
@@ -2128,7 +2128,7 @@ public function testNormalizeWithPaginationClientEnabled()
 
         $propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
         $propertyMetadataFactoryProphecy->create(Dummy::class, 'id')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_INT), 'This is an id.', true, false));
-        $propertyMetadataFactoryProphecy->create(Dummy::class, 'name')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), 'This is a name.', true, true, true, true, false, false, null, null, ['swagger_context' => ['type' => 'string', 'enum' => ['one', 'two'], 'example' => 'one']]));
+        $propertyMetadataFactoryProphecy->create(Dummy::class, 'name')->shouldBeCalled()->willReturn(new PropertyMetadata(new Type(Type::BUILTIN_TYPE_STRING), 'This is a name.', true, true, true, true, false, false, null, null, ['openapi_context' => ['type' => 'string', 'enum' => ['one', 'two'], 'example' => 'one']]));
         $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
         $resourceClassResolverProphecy->isResourceClass(Dummy::class)->willReturn(true);