Add deprecations for v6 (#1772)

Author: DerManoMann

docs/examples/processors/schema-query-parameter/scan.php

@@ -23,7 +23,7 @@
 };
 
 $openapi = (new Generator())
-    ->withProcessor(function (Pipeline $pipeline) use ($insertMatch) { $pipeline->insert(new SchemaQueryParameter(), $insertMatch); })
+    ->withProcessorPipeline(function (Pipeline $pipeline) use ($insertMatch) { $pipeline->insert(new SchemaQueryParameter(), $insertMatch); })
     ->generate([__DIR__ . '/app']);
 // file_put_contents(__DIR__ . '/schema-query-parameter.yaml', $openapi->toYaml());
 echo $openapi->toYaml();

src/Generator.php

@@ -267,13 +267,21 @@ public function setProcessorPipeline(?Pipeline $processor): Generator
      *
      * @param callable $with callable with the current processor pipeline passed in
      */
-    public function withProcessor(callable $with): Generator
+    public function withProcessorPipeline(callable $with): Generator
     {
         $with($this->getProcessorPipeline());
 
         return $this;
     }
 
+    /**
+     * @deprecated use `withProcessorPipeline()` instead
+     */
+    public function withProcessor(callable $with): Generator
+    {
+        return $this->withProcessorPipeline($with);
+    }
+
     public function getLogger(): ?LoggerInterface
     {
         return $this->logger ?: new DefaultLogger();
@@ -291,6 +299,9 @@ public function setVersion(?string $version): Generator
         return $this;
     }
 
+    /**
+     * @deprecated use non-static `generate()` instead
+     */
     public static function scan(iterable $sources, array $options = []): ?OA\OpenApi
     {
         // merge with defaults

src/Util.php

@@ -10,6 +10,8 @@
 
 /**
  * Convenient utility functions that don't neatly fit anywhere else.
+ *
+ * @deprecated
  */
 class Util
 {

tests/Annotations/AttachableTest.php

@@ -32,7 +32,7 @@ public function testCustomAttachableImplementationsAreAttached(): void
         (new Generator())
             ->addAlias('oaf', 'OpenApi\Tests\Fixtures\Annotations')
             ->addNamespace('OpenApi\Tests\Fixtures\Annotations\\')
-            ->withProcessor(function (Pipeline $processor) { $processor->remove(null, function ($pipe) { return !$pipe instanceof CleanUnusedComponents; }); })
+            ->withProcessorPipeline(function (Pipeline $processor) { $processor->remove(null, function ($pipe) { return !$pipe instanceof CleanUnusedComponents; }); })
             ->generate($this->fixtures(['UsingCustomAttachables.php']), $analysis);
 
         $schemas = $analysis->getAnnotationsOfType(OA\Schema::class, true);

tests/DocSnippetsTest.php

@@ -54,7 +54,7 @@ public function testSnippets(array $filenames, string $version): void
             require_once $tmp;
             $openapi = (new Generator($this->getTrackingLogger()))
                 ->setVersion($version)
-                ->withProcessor(fn (Pipeline $processorPipeline) => $processorPipeline->remove(OperationId::class))
+                ->withProcessorPipeline(fn (Pipeline $processorPipeline) => $processorPipeline->remove(OperationId::class))
                 ->generate([$tmp], null, false);
             if ($lastSpec) {
                 $this->assertSpecEquals(

tests/Fixtures/Scratch/PromotedProperty.php

@@ -63,7 +63,7 @@ public function __construct(
          * Intentionally not promoted!
          */
         #[OAT\Property()]
-        MyEnum $myEnum,
+        MyEnum $myEnum = MyEnum::AA,
     ) {
     }
 }