fix(OpenApi): Fixed getByPath operation overlap with get by setti…

…ng `id` request attribute and api_resource operation configuration
roadiz · Jun 23, 2023 · 54a378d · 54a378d
1 parent 22ed7f5
commit 54a378d
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 3 deletions.
diff --git a/config/api_resources/nsarticle.yml b/config/api_resources/nsarticle.yml
@@ -28,7 +28,11 @@ App\GeneratedEntity\NSArticle:
                     - document_thumbnails
                     - document_display_sources
         getByPath:
-            method: GET
+            method: 'GET'
+            path: '/web_response_by_path'
+            read: false
+            controller: RZ\Roadiz\CoreBundle\Api\Controller\GetWebResponseByPathController
+            pagination_enabled: false
             normalization_context:
                 enable_max_depth: true
                 groups:

diff --git a/config/api_resources/nsoffer.yml b/config/api_resources/nsoffer.yml
@@ -28,7 +28,11 @@ App\GeneratedEntity\NSOffer:
                     - document_thumbnails
                     - document_display_sources
         getByPath:
-            method: GET
+            method: 'GET'
+            path: '/web_response_by_path'
+            read: false
+            controller: RZ\Roadiz\CoreBundle\Api\Controller\GetWebResponseByPathController
+            pagination_enabled: false
             normalization_context:
                 enable_max_depth: true
                 groups:

diff --git a/config/api_resources/nspage.yml b/config/api_resources/nspage.yml
@@ -32,7 +32,11 @@ App\GeneratedEntity\NSPage:
                     - nodes_sources_images
                     - nodes_sources_boolean
         getByPath:
-            method: GET
+            method: 'GET'
+            path: '/web_response_by_path'
+            read: false
+            controller: RZ\Roadiz\CoreBundle\Api\Controller\GetWebResponseByPathController
+            pagination_enabled: false
             normalization_context:
                 enable_max_depth: true
                 groups:

diff --git a/lib/RoadizCoreBundle/config/services.yaml b/lib/RoadizCoreBundle/config/services.yaml
@@ -124,6 +124,11 @@ services:
         arguments: [ '@RZ\Roadiz\CoreBundle\Api\OpenApi\JwtDecorator.inner' ]
         autoconfigure: false
 
+    RZ\Roadiz\CoreBundle\Api\OpenApi\WebResponseDecorator:
+        decorates: 'api_platform.openapi.factory'
+        arguments: [ '@RZ\Roadiz\CoreBundle\Api\OpenApi\WebResponseDecorator.inner' ]
+        autoconfigure: false
+
     #
     # API Platform normalizers
     #

diff --git a/lib/RoadizCoreBundle/src/Api/Controller/GetWebResponseByPathController.php b/lib/RoadizCoreBundle/src/Api/Controller/GetWebResponseByPathController.php
@@ -54,7 +54,11 @@ public function __invoke(): ?WebResponseInterface
             $resource = $this->normalizeResourcePath(
                 (string) $this->requestStack->getMainRequest()->query->get('path')
             );
+            if (null === $resource) {
+                throw new ResourceNotFoundException('Resource not found');
+            }
             $this->requestStack->getMainRequest()->attributes->set('data', $resource);
+            $this->requestStack->getMainRequest()->attributes->set('id', $resource->getId());
             /*
              * Force API Platform to look for real resource configuration and serialization
              * context. You must define "itemOperations.getByPath" for your API resource configuration.

diff --git a/lib/RoadizCoreBundle/src/Api/OpenApi/WebResponseDecorator.php b/lib/RoadizCoreBundle/src/Api/OpenApi/WebResponseDecorator.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\CoreBundle\Api\OpenApi;
+
+use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
+use ApiPlatform\OpenApi\Model;
+use ApiPlatform\OpenApi\OpenApi;
+
+final class WebResponseDecorator implements OpenApiFactoryInterface
+{
+    private OpenApiFactoryInterface $decorated;
+
+    public function __construct(
+        OpenApiFactoryInterface $decorated
+    ) {
+        $this->decorated = $decorated;
+    }
+
+    public function __invoke(array $context = []): OpenApi
+    {
+        $openApi = ($this->decorated)($context);
+        $schemas = $openApi->getComponents()->getSchemas();
+        $pathItem = $openApi->getPaths()->getPath('/api/web_response_by_path');
+        $operation = $pathItem->getGet();
+
+        $openApi->getPaths()->addPath('/api/web_response_by_path', $pathItem->withGet(
+            $operation->withParameters([new Model\Parameter(
+                'path',
+                'query',
+                'Resource path, or `/` for home page',
+                true,
+            )])
+        ));
+
+        return $openApi;
+    }
+}
diff --git a/lib/RoadizCoreBundle/src/NodeType/ApiResourceGenerator.php b/lib/RoadizCoreBundle/src/NodeType/ApiResourceGenerator.php
@@ -138,6 +138,10 @@ protected function getItemOperations(NodeTypeInterface $nodeType): array
         if ($nodeType->isReachable()) {
             $operations['getByPath'] = [
                 'method' => 'GET',
+                'path' => '/web_response_by_path',
+                'read' => 'false',
+                'controller' => 'RZ\Roadiz\CoreBundle\Api\Controller\GetWebResponseByPathController',
+                'pagination_enabled' => 'false',
                 'normalization_context' => [
                     'enable_max_depth' => true,
                     'groups' => array_merge(array_values(array_filter(array_unique($groups))), [