Add support for collections in OpenApiResponse (#566)

* Add support for collections in OpenApiResponse

Author: cnizzardini

docs/attributes.md

@@ -404,16 +404,16 @@ order of operations is used to build the response:
 3. `associations`
 4. The schema inferred from CakePHP conventions.
 
-| Property                      | Type / Default    | OA Spec | Description                                                                                                                                                           |
-|-------------------------------|-------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| schemaType                    | string `"object"` | Y       | The schema response type, generally `"object"` or `"array"`                                                                                                           |
-| statusCode                    | string `"200"`    | Y       | The HTTP response code                                                                                                                                                |
-| ref                           | ?string `null`    | Y       | The OpenAPI schema (e.g. `"#/components/schemas/ModelName"`                                                                                                           |
-| [schema](#Schema)             | ?string `null`    | Y       | An FQN describing a custom response schema. The class must have either one or more `#[OpenApiSchemaProperty]` attribute, implement `CustomSchemaInterface` or both.   |
-| description                   | ?string `null`    | Y       | Description of the response                                                                                                                                           |
-| mimeTypes                     | ?array `null`     | Y       | An array of mime types the response can, if null settings from swagger_bake config are used.                                                                          |
-| [associations](#Associations) | ?array `null`     | N       | Adds associated tables to the response sample schema, see examples below.                                                                                             |
-| schemaFormat                  | ?string `null`    | Y       | The schema format, generally only used for schemaType of string.                                                                                                      |
+| Property                      | Type / Default    | OA Spec | Description                                                                                                                                                         |
+|-------------------------------|-------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| schemaType                    | string `"object"` | Y       | The schema response type: `"object"`, `"array"` or `"collection"`                                                                                                   |
+| statusCode                    | string `"200"`    | Y       | The HTTP response code                                                                                                                                              |
+| ref                           | ?string `null`    | Y       | The OpenAPI schema (e.g. `"#/components/schemas/ModelName"`                                                                                                         |
+| [schema](#Schema)             | ?string `null`    | Y       | An FQN describing a custom response schema. The class must have either one or more `#[OpenApiSchemaProperty]` attribute, implement `CustomSchemaInterface` or both. |
+| description                   | ?string `null`    | Y       | Description of the response                                                                                                                                         |
+| mimeTypes                     | ?array `null`     | Y       | An array of mime types the response can, if null settings from swagger_bake config are used.                                                                        |
+| [associations](#Associations) | ?array `null`     | N       | Adds associated tables to the response sample schema, see examples below.                                                                                           |
+| schemaFormat                  | ?string `null`    | Y       | The schema format, generally only used for schemaType of string.                                                                                                    |
 
 Defining a multiple mimeTypes and 400-409 status code range and an expected 200 response:
 

src/Command/CommandTrait.php

@@ -30,7 +30,7 @@ public function loadConfig(Arguments $args): void
             Configure::load($config, 'default');
         } catch (CakeException $e) {
             throw new SwaggerBakeRunTimeException(
-                "SwaggerBake config file `$config` is missing or " . get_class($e) . ' ' . $e->getMessage()
+                "SwaggerBake config file `$config` is missing or " . get_class($e) . ' ' . $e->getMessage(),
             );
         }
 

src/Command/InstallCommand.php

@@ -42,7 +42,7 @@ public function execute(Arguments $args, ConsoleIo $io): void
         $continue = $io->ask(
             'If your API exists in a plugin or you have some other non-standard setup, please follow ' .
             'the manual installation steps. Do you want to continue?',
-            'Y'
+            'Y',
         );
 
         if (strtoupper($continue) !== 'Y') {

src/Lib/Attribute/AbstractOpenApiParameter.php

@@ -83,7 +83,7 @@ public function create(): Parameter
                 (new Schema())
                     ->setType($this->type)
                     ->setEnum($this->enum)
-                    ->setFormat($this->format)
+                    ->setFormat($this->format),
             );
 
         return $parameter;

src/Lib/Attribute/AbstractSchemaProperty.php

@@ -72,7 +72,7 @@ public function __construct(
         public readonly ?int $minProperties = null,
         public readonly ?int $maxProperties = null,
         public readonly array $enum = [],
-        public readonly array $items = []
+        public readonly array $items = [],
     ) {
     }
 

src/Lib/Attribute/AttributeFactory.php

@@ -14,7 +14,7 @@ final class AttributeFactory
      */
     public function __construct(
         private Reflector $reflection,
-        private string $attributeClass
+        private string $attributeClass,
     ) {
     }
 

src/Lib/Attribute/OpenApiHeader.php

@@ -43,7 +43,7 @@ public function __construct(
         public readonly bool $explode = false,
         public readonly string $style = '',
         public readonly string|bool|int $example = '',
-        public readonly bool $allowEmptyValue = false
+        public readonly bool $allowEmptyValue = false,
     ) {
         if (empty($ref) && empty($name)) {
             throw new SwaggerBakeRunTimeException('One of ref or name must be defined');
@@ -55,8 +55,8 @@ public function __construct(
                     'Invalid Data Type, given %s for %s but must be one of: %s',
                     $type,
                     $name,
-                    implode(',', OpenApiDataType::TYPES)
-                )
+                    implode(',', OpenApiDataType::TYPES),
+                ),
             );
         }
     }
@@ -81,7 +81,7 @@ public function createParameter(): Parameter
                 (new Schema())
                     ->setType($this->type)
                     ->setEnum($this->enum)
-                    ->setFormat($this->format)
+                    ->setFormat($this->format),
             );
     }
 }

src/Lib/Attribute/OpenApiPaginator.php

@@ -16,7 +16,7 @@ class OpenApiPaginator
      */
     public function __construct(
         public readonly array $sortEnum = [],
-        public readonly bool $useSortTextInput = false
+        public readonly bool $useSortTextInput = false,
     ) {
     }
 }

src/Lib/Attribute/OpenApiPath.php

@@ -25,7 +25,7 @@ public function __construct(
         public readonly ?string $ref = null,
         public readonly ?string $summary = null,
         public readonly ?string $description = null,
-        public readonly array $tags = []
+        public readonly array $tags = [],
     ) {
     }
 }

src/Lib/Attribute/OpenApiPathParam.php

@@ -43,7 +43,7 @@ public function __construct(
             description: $description,
             example: $example,
             isRequired: $isRequired,
-            allowReserved: $allowReserved
+            allowReserved: $allowReserved,
         );
     }
 
@@ -62,7 +62,7 @@ public function createParameter(): Parameter
             ->setSchema(
                 (new Schema())
                     ->setType($this->type)
-                    ->setFormat($this->format)
+                    ->setFormat($this->format),
             );
     }
 }