From 874c9098fb530435f05646e4c18c62a406cb58e1 Mon Sep 17 00:00:00 2001
From: Martin Rademacher <mano@radebatz.net>
Date: Mon, 23 Sep 2024 10:11:45 +1200
Subject: [PATCH] Fix processor option default (#1653)

---
 docs/reference/attributes.md   | 38 +++++++++++++++++-----------------
 docs/reference/processors.md   |  8 +++++++
 src/Processors/AugmentTags.php |  2 +-
 3 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/docs/reference/attributes.md b/docs/reference/attributes.md
index d1e364c0..b6b28be5 100644
--- a/docs/reference/attributes.md
+++ b/docs/reference/attributes.md
@@ -157,13 +157,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
@@ -207,7 +207,7 @@ These will be ignored but can be used for custom processing.</p><table class="ta
 #### Parameters
 ---
 <dl>
-  <dt><strong>schemas</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;|null</span></dt>
+  <dt><strong>schemas</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;|null</span></dt>
   <dd><p>Reusable Schemas.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>responses</strong> : <span style="font-family: monospace;">Response[]|null</span></dt>
   <dd><p>Reusable Responses.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
@@ -1127,13 +1127,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
@@ -1298,13 +1298,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
@@ -2192,13 +2192,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
@@ -2656,13 +2656,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
@@ -3179,13 +3179,13 @@ instead make the "type" property an array and add "null" as a possible type.</p>
   <dt><strong>deprecated</strong> : <span style="font-family: monospace;">bool|null</span></dt>
   <dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br />
 Default value is false.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>allOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>anyOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against at least one<br />
 schema defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
-  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt>
+  <dt><strong>oneOf</strong> : <span style="font-family: monospace;">array&lt;Schema|OA\Schema&gt;</span></dt>
   <dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br />
 defined by this property's value.</p><table class="table-plain"><tr><td><i>Required</i>:</td><td style="padding-left: 0;"><b>no</b></td></tr></table></dd>
   <dt><strong>additionalProperties</strong> : <span style="font-family: monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt>
diff --git a/docs/reference/processors.md b/docs/reference/processors.md
index ba7c9ca7..da775e27 100644
--- a/docs/reference/processors.md
+++ b/docs/reference/processors.md
@@ -151,3 +151,11 @@ Tracks the use of all <code>Components</code> and removed unused schemas.
 ### [AugmentTags](https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php)
 
 Ensures that all tags used on operations also exist in the global <code>tags</code> list.
+#### Config settings
+<dl>
+  <dt><strong>augmentTags.whitelist</strong> : <span style="font-family: monospace;">array</span></dt>
+  <dt><strong>default</strong> : <span style="font-family: monospace;">[]</span></dt>
+  <dd><p>Whitelist tags to keep even if not used. <code>*</code> may be used to keep all unused.</p>  </dd>
+</dl>
+
+
diff --git a/src/Processors/AugmentTags.php b/src/Processors/AugmentTags.php
index 25290081..22a2e49f 100644
--- a/src/Processors/AugmentTags.php
+++ b/src/Processors/AugmentTags.php
@@ -17,7 +17,7 @@ class AugmentTags implements ProcessorInterface
 {
 
     /** @var array<string> */
-    protected $whitelist;
+    protected $whitelist = [];
 
     public function __construct(array $whitelist = [])
     {