WIP: Very first draft for ignoring properties

src/Annotation/Ignore.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the NelmioApiDocBundle package.
+ *
+ * (c) Nelmio
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nelmio\ApiDocBundle\Annotation;
+
+trigger_deprecation('nelmio/api-doc-bundle', 'todo', 'The "%s" class is deprecated and will be removed in 5.0. Use the "\Nelmio\ApiDocBundle\Attribute\Ignore" attribute instead.', Ignore::class);
+
+/**
+ * @Annotation
+ */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PARAMETER | \Attribute::TARGET_PROPERTY)]
+final class Ignore extends \Nelmio\ApiDocBundle\Attribute\Ignore
+{
+}

src/Attribute/Ignore.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the NelmioApiDocBundle package.
+ *
+ * (c) Nelmio
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nelmio\ApiDocBundle\Attribute;
+
+/**
+ * @final
+ */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PARAMETER | \Attribute::TARGET_PROPERTY)]
+class Ignore
+{
+}

src/ModelDescriber/ObjectModelDescriber.php

@@ -12,6 +12,7 @@
 namespace Nelmio\ApiDocBundle\ModelDescriber;
 
 use Doctrine\Common\Annotations\Reader;
+use Nelmio\ApiDocBundle\Attribute\Ignore;
 use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareInterface;
 use Nelmio\ApiDocBundle\Describer\ModelRegistryAwareTrait;
 use Nelmio\ApiDocBundle\Model\Model;
@@ -130,11 +131,24 @@ public function describe(Model $model, OA\Schema $schema)
 
             $reflections = $this->getReflections($reflClass, $propertyName);
 
-            // Check if a custom name is set
+            $ignoredProperty = false;
             foreach ($reflections as $reflection) {
+                if (\PHP_VERSION_ID >= 80000) {
+                    if (0 !== \count($reflection->getAttributes(Ignore::class))) {
+                        $ignoredProperty = true;
+
+                        continue;
+                    }
+                }
+
+                // Check if a custom name is set
                 $serializedName = $annotationsReader->getPropertyName($reflection, $serializedName);
             }
 
+            if ($ignoredProperty) {
+                continue;
+            }
+
             $property = Util::getProperty($schema, $serializedName);
 
             // Interpret additional options