Merge from 2.x (#541)

* Mepeiso/add false option to associations white list (#538) Allow empty whitelist of OpenApiResponse(associations: $var) --------- Co-authored-by: Manuel Peiso <[email protected]> * Fix extra slash being added to test src path * Update how swagger is constructed in the test --------- Co-authored-by: Manuel Enrique Peiso Cruz <[email protected]> Co-authored-by: Manuel Peiso <[email protected]>
cnizzardini · Feb 25, 2024 · 0668328 · 0668328
1 parent 28de36b
commit 0668328
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 2 deletions.
diff --git a/docs/attributes.md b/docs/attributes.md
@@ -500,7 +500,13 @@ add the `#[OpenApiSchema]` attribute to your schema class to change the default
 #### Associations
 
 The association property allows you to include associations defined in your Table class within your OpenAPI response
-sample schema. To include all immediately associated tables (depth of one):
+sample schema. To not include associations:
+
+```php
+#[OpenApiResponse(associations: false)]
+```
+
+To include all immediately associated tables (depth of one):
 
 ```php
 #[OpenApiResponse(associations: [])]

diff --git a/src/Lib/Operation/OperationResponseAssociation.php b/src/Lib/Operation/OperationResponseAssociation.php
@@ -72,6 +72,14 @@ public function build(OpenApiResponse $openApiResponse): Schema
                 ->setProperties([]);
         }
 
+        // if $associations['whiteList'] is set to false no associations need to be loaded
+        if (isset($associations['whiteList']) && $associations['whiteList'] === false) {
+            $entity = $this->inflector::singularize($table->getAlias());
+            $schema = $this->getOrCreateAssociatedSchema($entity, $table->getAlias());
+
+            return $schema;
+        }
+
         if (!isset($associations['whiteList']) || !count($associations['whiteList'])) {
             $associations['whiteList'] = [];
             /** @var \Cake\ORM\Association $association */

diff --git a/tests/TestCase/Lib/Operation/OperationResponseAssociationTest.php b/tests/TestCase/Lib/Operation/OperationResponseAssociationTest.php
@@ -102,6 +102,26 @@ public function test_white_list(): void
         $this->assertArrayHasKey('employee_titles', $schema->getProperties()['employee']->getProperties());
     }
 
+    public function test_false_white_list(): void
+    {
+        $swagger = (new SwaggerFactory($this->config, new RouteScanner(new Router(), $this->config)))->create();
+        $assoc = new OperationResponseAssociation(
+            $swagger,
+            $this->routes['employees:view'],
+            null
+        );
+
+        $schema = $assoc->build(new OpenApiResponse(
+            schemaType: 'object',
+            associations: ['whiteList' => false]
+        ));
+
+        $this->assertInstanceOf(Schema::class, $schema);
+        $this->assertArrayNotHasKey('department_employees', $schema->getProperties());
+        $this->assertArrayNotHasKey('employee_salaries', $schema->getProperties());
+        $this->assertArrayNotHasKey('employee_titles', $schema->getProperties());
+    }
+
     public function test_null_schema(): void
     {
         $assoc = new OperationResponseAssociation(

diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -18,7 +18,7 @@
 define('CAKE', CORE_PATH . 'src' . DS);
 define('TEST_APP', SWAGGER_BAKE_TEST_APP);
 define('WWW_ROOT', SWAGGER_BAKE_TEST_APP . DS . 'webroot');
-define('APP', SWAGGER_BAKE_TEST_APP . DS . 'src' . DS);
+define('APP', SWAGGER_BAKE_TEST_APP . 'src' . DS);
 define('CONFIG', SWAGGER_BAKE_TEST_APP . 'config' . DS);
 
 ini_set('error_reporting', E_ALL);