Response attribute takes precedence over doc block (#531)

* The response attribute takes precedence over doc blocks * update pipeline for cakephp 4.5 * pipeline cleanup
cnizzardini · Oct 17, 2023 · 5a62174 · 5a62174
1 parent d7321ee
commit 5a62174
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 10 deletions.
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -5,13 +5,12 @@ on:
 
 jobs:
   build:
+    name: PHP ${{ matrix.php-versions }} Test 
     runs-on: ubuntu-latest
     strategy:
       matrix:
         operating-system: [ ubuntu-20.04 ]
         php-versions: ['8.0', '8.1', '8.2']
-
-    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -58,10 +57,11 @@ jobs:
   # CakePHP version compatability
   #
   compatibility:
+    name: CakePHP ${{ matrix.version }} Test
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['~4.2.0', '~4.3.0', '^4.4']
+        version: ['~4.2.0', '~4.3.0', '~4.4', '~4.5']
     steps:
       - name: Checkout
         uses: actions/checkout@v2

diff --git a/src/Lib/Operation/OperationFromRouteFactory.php b/src/Lib/Operation/OperationFromRouteFactory.php
@@ -93,8 +93,6 @@ public function create(RouteDecorator $route, string $httpMethod, ?Schema $schem
 
         $operation = $this->createOperation($operation, $route, $openApiOperation);
 
-        $operation = (new OperationDocBlock($this->swagger, $config, $operation, $docBlock))->getOperation();
-
         $operation = (new OperationPathParameter($operation, $route, $refMethod, $schema))
             ->getOperationWithPathParameters();
 
@@ -119,6 +117,8 @@ public function create(RouteDecorator $route, string $httpMethod, ?Schema $schem
             $refMethod,
         ))->getOperationWithResponses();
 
+        $operation = (new OperationDocBlock($this->swagger, $config, $operation, $docBlock))->getOperation();
+
         EventManager::instance()->dispatch(
             new Event('SwaggerBake.Operation.created', $operation, [
                 'config' => $config,

diff --git a/tests/TestCase/Lib/Attribute/OpenApiOperationTest.php b/tests/TestCase/Lib/Attribute/OpenApiOperationTest.php
@@ -36,27 +36,32 @@ public function setUp(): void
                     'isVisible' => [
                         'action' => 'isVisible',
                         'method' => 'GET',
-                        'path' => 'is-visible'
+                        'path' => 'is-visible',
                     ],
                     'tagNames' => [
                         'action' => 'tagNames',
                         'method' => 'GET',
-                        'path' => 'tag-names'
+                        'path' => 'tag-names',
                     ],
                     'deprecated' => [
                         'action' => 'deprecated',
                         'method' => 'GET',
-                        'path' => 'deprecated'
+                        'path' => 'deprecated',
                     ],
                     'externalDocs' => [
                         'action' => 'externalDocs',
                         'method' => 'GET',
-                        'path' => 'external-docs'
+                        'path' => 'external-docs',
                     ],
                     'descriptions' => [
                         'action' => 'descriptions',
                         'method' => 'GET',
-                        'path' => 'descriptions'
+                        'path' => 'descriptions',
+                    ],
+                    'throwPrecedence' => [
+                        'action' => 'throwPrecedence',
+                        'method' => 'GET',
+                        'path' => 'throw-precedence',
                     ],
                 ]
             ]);
@@ -127,4 +132,11 @@ public function test_path_tags_should_take_precedence(): void
         $this->assertCount(2, $arr['paths']['/operations/deprecated']['get']['tags']);
         $this->assertCount(2, $arr['paths']['/operations/external-docs']['get']['tags']);
     }
+
+    public function test_response_attribute_takes_precedence_over_docblock_tag(): void
+    {
+        $arr = json_decode($this->swagger->toString(), true);
+        $response = $arr['paths']['/operations/throw-precedence']['get']['responses'][400];
+        $this->assertEquals('This should take precedence over throw tag', $response['description']);
+    }
 }
diff --git a/tests/test_app/src/Controller/OperationsController.php b/tests/test_app/src/Controller/OperationsController.php
@@ -5,6 +5,7 @@
 
 use SwaggerBake\Lib\Attribute\OpenApiOperation;
 use SwaggerBake\Lib\Attribute\OpenApiPath;
+use SwaggerBake\Lib\Attribute\OpenApiResponse;
 
 #[OpenApiPath(tags: ['Test', 'Another Test'])]
 class OperationsController extends AppController
@@ -38,4 +39,14 @@ public function descriptions(): void
     {
 
     }
+
+    /**
+     * @link https://github.com/cnizzardini/cakephp-swagger-bake/issues/525
+     * @throws \Cake\Http\Exception\BadRequestException
+     */
+    #[OpenApiResponse(schemaType: 'string', statusCode: '400', description: 'This should take precedence over throw tag')]
+    public function throwPrecedence()
+    {
+
+    }
 }