grid config listing fixes (#1711)

Author: lukmzig

src/Asset/Controller/Grid/Configuration/DeleteConfigurationController.php

@@ -37,6 +37,8 @@
  */
 final class DeleteConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configuration/{configurationId}/delete';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ConfigurationServiceInterface $gridConfigurationService,
@@ -48,13 +50,13 @@ public function __construct(
      * @throws ForbiddenException|InvalidArgumentException|NotFoundException
      */
     #[Route(
-        '/assets/grid/configuration/{configurationId}/delete',
+        self::ROUTE,
         name: 'pimcore_studio_api_delete_asset_grid_configuration',
         methods: ['DELETE'],
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Delete(
-        path: self::PREFIX . '/assets/grid/configuration/{configurationId}/delete',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_delete_grid_configuration_by_configurationId',
         description: 'asset_delete_grid_configuration_by_configurationId_description',
         summary: 'asset_delete_grid_configuration_by_configurationId_summary',

src/Asset/Controller/Grid/Configuration/GetAvailableColumnsController.php

@@ -37,6 +37,8 @@
  */
 final class GetAvailableColumnsController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/available-columns';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ColumnConfigurationServiceInterface $columnConfigurationService,
@@ -48,13 +50,13 @@ public function __construct(
      * @throws NotFoundException|SearchException
      */
     #[Route(
-        '/assets/grid/available-columns',
+        self::ROUTE,
         name: 'pimcore_studio_api_get_asset_grid_available_configuration',
         methods: ['GET']
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Get(
-        path: self::PREFIX . '/assets/grid/available-columns',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_get_available_grid_columns',
         description: 'asset_get_available_grid_columns_description',
         summary: 'asset_get_available_grid_columns_summary',

src/Asset/Controller/Grid/Configuration/GetConfigurationController.php

@@ -38,6 +38,8 @@
  */
 final class GetConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configuration/{folderId}';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ConfigurationServiceInterface $gridConfigurationService,
@@ -49,13 +51,13 @@ public function __construct(
      * @throws NotFoundException
      */
     #[Route(
-        '/assets/grid/configuration/{folderId}',
+        self::ROUTE,
         name: 'pimcore_studio_api_get_asset_grid_configuration',
         methods: ['GET'],
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Get(
-        path: self::PREFIX . '/assets/grid/configuration/{folderId}',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_get_grid_configuration_by_folderId',
         description: 'asset_get_grid_configuration_by_folderId_description',
         summary: 'asset_get_grid_configuration_by_folderId_summary',

src/Asset/Controller/Grid/Configuration/ListSavedConfigurationsController.php

@@ -36,6 +36,8 @@
  */
 final class ListSavedConfigurationsController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configurations';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ConfigurationServiceInterface $configurationService,
@@ -47,13 +49,13 @@ public function __construct(
      * @throws NotFoundException|SearchException
      */
     #[Route(
-        '/assets/grid/configurations',
+        self::ROUTE,
         name: 'pimcore_studio_api_get_asset_saved_grid_configurations',
         methods: ['GET']
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Get(
-        path: self::PREFIX . '/assets/grid/configurations',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_get_saved_grid_configurations',
         description: 'asset_get_saved_grid_configurations_description',
         summary: 'asset_get_saved_grid_configurations_summary',

src/Asset/Controller/Grid/Configuration/RemoveFavoriteController.php

@@ -0,0 +1,87 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Asset\Controller\Grid\Configuration;
+
+use OpenApi\Attributes\Delete;
+use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\ForbiddenException;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidArgumentException;
+use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\Grid\Service\UpdateConfigurationServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Parameter\Path\IdParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\DefaultResponses;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attribute\Response\SuccessResponse;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constant\HttpResponseCodes;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constant\UserPermissions;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ */
+final class RemoveFavoriteController extends AbstractApiController
+{
+    private const string ROUTE = '/assets/grid/configuration/remove-favorite/{configurationId}/{folderId}';
+
+    public function __construct(
+        SerializerInterface $serializer,
+        private readonly UpdateConfigurationServiceInterface $updateConfigurationService
+    ) {
+        parent::__construct($serializer);
+    }
+
+    /**
+     * @throws NotFoundException|ForbiddenException|InvalidArgumentException
+     */
+    #[Route(
+        self::ROUTE,
+        name: 'pimcore_studio_api_asset_remove_grid_configuration_as_favorite',
+        methods: ['DELETE'],
+    )]
+    #[IsGranted(UserPermissions::ASSETS->value)]
+    #[Delete(
+        path: self::PREFIX . self::ROUTE,
+        operationId: 'asset_remove_grid_configuration_as_favorite',
+        description: 'asset_remove_grid_configuration_as_favorite_description',
+        summary: 'asset_remove_grid_configuration_as_favorite_summary',
+        tags: [Tags::AssetGrid->value]
+    )]
+    #[IdParameter(
+        type: 'configurationId',
+        name: 'configurationId'
+    )]
+    #[IdParameter(
+        type: 'folderId',
+        name: 'folderId'
+    )]
+    #[SuccessResponse(
+        description: 'asset_remove_grid_configuration_as_favorite_success_response'
+    )]
+    #[DefaultResponses([
+        HttpResponseCodes::UNAUTHORIZED,
+        HttpResponseCodes::FORBIDDEN,
+        HttpResponseCodes::NOT_FOUND,
+    ])]
+    public function removeAssetGridConfigurationAsFavorite(
+        int $configurationId,
+        int $folderId
+    ): Response {
+        $this->updateConfigurationService->removeAssetGridConfigurationAsFavorite($configurationId, $folderId);
+
+        return new Response();
+    }
+}

src/Asset/Controller/Grid/Configuration/SaveConfigurationController.php

@@ -37,6 +37,8 @@
  */
 final class SaveConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configuration/save';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly SaveConfigurationServiceInterface $gridSaveConfigurationService
@@ -48,13 +50,13 @@ public function __construct(
      * @throws NotFoundException
      */
     #[Route(
-        '/assets/grid/configuration/save',
+        self::ROUTE,
         name: 'pimcore_studio_api_save_asset_grid_configuration',
         methods: ['POST'],
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Post(
-        path: self::PREFIX . '/assets/grid/configuration/save',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_save_grid_configuration',
         description: 'asset_save_grid_configuration_description',
         summary: 'asset_save_grid_configuration_description',

src/Asset/Controller/Grid/Configuration/SetAsFavoriteController.php

@@ -35,9 +35,11 @@
  */
 final class SetAsFavoriteController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configuration/set-as-favorite/{configurationId}/{folderId}';
+
     public function __construct(
         SerializerInterface $serializer,
-        private UpdateConfigurationServiceInterface $updateConfigurationService
+        private readonly UpdateConfigurationServiceInterface $updateConfigurationService
     ) {
         parent::__construct($serializer);
     }
@@ -46,13 +48,13 @@ public function __construct(
      * @throws NotFoundException|ForbiddenException|InvalidArgumentException
      */
     #[Route(
-        '/assets/grid/configuration/set-as-favorite/{configurationId}/{folderId}',
+        self::ROUTE,
         name: 'pimcore_studio_api_asset_set_grid_configuration_as_favorite',
         methods: ['POST'],
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Post(
-        path: self::PREFIX . '/assets/grid/configuration/set-as-favorite/{configurationId}/{folderId}',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_set_grid_configuration_as_favorite',
         description: 'asset_set_grid_configuration_as_favorite_description',
         summary: 'asset_set_grid_configuration_as_favorite_summary',
@@ -67,7 +69,7 @@ public function __construct(
         name: 'folderId'
     )]
     #[SuccessResponse(
-        description: 'asset_set_grid_configuration_as_favorite_response'
+        description: 'asset_set_grid_configuration_as_favorite_success_response'
     )]
     #[DefaultResponses([
         HttpResponseCodes::UNAUTHORIZED,

src/Asset/Controller/Grid/Configuration/UpdateConfigurationController.php

@@ -38,6 +38,8 @@
  */
 final class UpdateConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/assets/grid/configuration/update/{configurationId}';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly UpdateConfigurationServiceInterface $gridSaveConfigurationService
@@ -49,13 +51,13 @@ public function __construct(
      * @throws NotFoundException|InvalidArgumentException|ForbiddenException
      */
     #[Route(
-        '/assets/grid/configuration/update/{configurationId}',
+        self::ROUTE,
         name: 'pimcore_studio_api_update_asset_grid_configuration',
         methods: ['PUT'],
     )]
     #[IsGranted(UserPermissions::ASSETS->value)]
     #[Put(
-        path: self::PREFIX . '/assets/grid/configuration/update/{configurationId}',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'asset_update_grid_configuration',
         description: 'asset_update_grid_configuration_description',
         summary: 'asset_update_grid_configuration_summary',

src/DataObject/Controller/Grid/Configuration/DeleteConfigurationController.php

@@ -36,6 +36,8 @@
  */
 final class DeleteConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/data-object/grid/configuration/{configurationId}';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ConfigurationServiceInterface $gridConfigurationService,
@@ -47,13 +49,13 @@ public function __construct(
      * @throws ForbiddenException|NotFoundException
      */
     #[Route(
-        '/data-object/grid/configuration/{configurationId}',
+        self::ROUTE,
         name: 'pimcore_studio_api_delete_data_object_grid_configuration',
         methods: ['DELETE'],
     )]
     #[IsGranted(UserPermissions::DATA_OBJECTS->value)]
     #[Delete(
-        path: self::PREFIX . '/data-object/grid/configuration/{configurationId}',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'data_object_delete_grid_configuration_by_configurationId',
         description: 'data_object_delete_grid_configuration_by_configurationId_description',
         summary: 'data_object_delete_grid_configuration_by_configurationId_summary',

src/DataObject/Controller/Grid/Configuration/GetConfigurationController.php

@@ -39,6 +39,8 @@
  */
 final class GetConfigurationController extends AbstractApiController
 {
+    private const string ROUTE = '/data-object/grid/configuration/{folderId}/{classId}';
+
     public function __construct(
         SerializerInterface $serializer,
         private readonly ConfigurationServiceInterface $gridConfigurationService,
@@ -50,13 +52,13 @@ public function __construct(
      * @throws NotFoundException
      */
     #[Route(
-        '/data-object/grid/configuration/{folderId}/{classId}',
+        self::ROUTE,
         name: 'pimcore_studio_api_get_data_object_grid_configuration',
         methods: ['GET'],
     )]
     #[IsGranted(UserPermissions::DATA_OBJECTS->value)]
     #[Get(
-        path: self::PREFIX . '/data-object/grid/configuration/{folderId}/{classId}',
+        path: self::PREFIX . self::ROUTE,
         operationId: 'data_object_get_grid_configuration',
         description: 'data_object_get_grid_configuration_description',
         summary: 'data_object_get_grid_configuration_summary',