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.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
@@ -207,7 +207,7 @@ These will be ignored but can be used for custom processing.

array<Schema|\OpenApi\Annotations\Schema>|null +
schemas : array<Schema|OA\Schema>|null

Reusable Schemas.

Required:no
responses : Response[]|null

Reusable Responses.

Required:no
@@ -1127,13 +1127,13 @@ instead make the "type" property an array and add "null" as a possible type.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
@@ -1298,13 +1298,13 @@ instead make the "type" property an array and add "null" as a possible type.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
@@ -2192,13 +2192,13 @@ instead make the "type" property an array and add "null" as a possible type.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
@@ -2656,13 +2656,13 @@ instead make the "type" property an array and add "null" as a possible type.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
@@ -3179,13 +3179,13 @@ instead make the "type" property an array and add "null" as a possible type.

deprecated : bool|null

Specifies that a schema is deprecated and should be transitioned out of usage.
Default value is false.

Required:no
-
allOf : array<Schema|\OpenApi\Annotations\Schema>
+
allOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against all schemas
defined by this property's value.

Required:no
-
anyOf : array<Schema|\OpenApi\Annotations\Schema>
+
anyOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against at least one
schema defined by this property's value.

Required:no
-
oneOf : array<Schema|\OpenApi\Annotations\Schema>
+
oneOf : array<Schema|OA\Schema>

An instance validates successfully against this property if it validates successfully against exactly one schema
defined by this property's value.

Required:no
additionalProperties : OpenApi\Attributes\AdditionalProperties|bool|null
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 Components 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 tags list. +#### Config settings +
+
augmentTags.whitelist : array
+
default : []
+

Whitelist tags to keep even if not used. * may be used to keep all unused.

+
+ + 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 */ - protected $whitelist; + protected $whitelist = []; public function __construct(array $whitelist = []) {