Support the "deprecationReason" attribute in the ApiProperty annotati…

…on (#1983) * Fix ApiProperty annot, support deprecationReason attr * Remove useless use
api-platform · May 29, 2018 · e0e639e · e0e639e
1 parent 9a3e6e2
commit e0e639e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/src/Annotation/ApiProperty.php b/src/Annotation/ApiProperty.php
@@ -14,7 +14,6 @@
 namespace ApiPlatform\Core\Annotation;
 
 use ApiPlatform\Core\Exception\InvalidArgumentException;
-use Doctrine\Common\Annotations\Annotation\Attribute;
 
 /**
  * ApiProperty annotation.
@@ -24,6 +23,7 @@
  * @Annotation
  * @Target({"METHOD", "PROPERTY"})
  * @Attributes(
+ *     @Attribute("deprecationReason", type="string"),
  *     @Attribute("fetchable", type="bool"),
  *     @Attribute("fetchEager", type="bool"),
  *     @Attribute("jsonldContext", type="array"),
@@ -74,6 +74,13 @@ final class ApiProperty
      */
     public $identifier;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var string
+     */
+    private $deprecationReason;
+
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *

diff --git a/src/Annotation/ApiResource.php b/src/Annotation/ApiResource.php
@@ -14,7 +14,6 @@
 namespace ApiPlatform\Core\Annotation;
 
 use ApiPlatform\Core\Exception\InvalidArgumentException;
-use Doctrine\Common\Annotations\Annotation\Attribute;
 
 /**
  * ApiResource annotation.

diff --git a/tests/Annotation/ApiPropertyTest.php b/tests/Annotation/ApiPropertyTest.php
@@ -48,13 +48,15 @@ public function testAssignation()
     public function testConstruct()
     {
         $property = new ApiProperty([
+            'deprecationReason' => 'this field is deprecated',
             'fetchable' => true,
             'fetchEager' => false,
             'jsonldContext' => ['foo' => 'bar'],
             'swaggerContext' => ['foo' => 'baz'],
             'attributes' => ['unknown' => 'unknown', 'fetchable' => false],
         ]);
         $this->assertEquals([
+            'deprecation_reason' => 'this field is deprecated',
             'fetchable' => false,
             'fetch_eager' => false,
             'jsonld_context' => ['foo' => 'bar'],