Remove body param from batch requests, unify MappedParams

pimcore · Jun 4, 2024 · a5b0bcd · a5b0bcd
1 parent c50f4d7
commit a5b0bcd
Show file tree

Hide file tree

Showing 22 changed files with 52 additions and 151 deletions.
diff --git a/src/OpenApi/Attributes/Parameters/Path/IdParameter.php b/src/OpenApi/Attributes/Parameters/Path/IdParameter.php
@@ -20,13 +20,13 @@
 use OpenApi\Attributes\PathParameter;
 use OpenApi\Attributes\Schema;
 
-#[Attribute(Attribute::TARGET_METHOD)]
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
 final class IdParameter extends PathParameter
 {
-    public function __construct(string $type = 'element', Schema $schema = new Schema(type: 'integer', example: 83))
+    public function __construct(string $type = 'element', string $name = 'id', Schema $schema = new Schema(type: 'integer', example: 83))
     {
         parent::__construct(
-            name: 'id',
+            name: $name,
             description: 'ID of the ' . $type,
             in: 'path',
             required: true,

diff --git a/src/Tag/Attributes/Request/CreateTagRequestBody.php b/src/Tag/Attributes/Request/CreateTagRequestBody.php
@@ -19,7 +19,7 @@
 use Attribute;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\RequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\CreateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\CreateTagParameters;
 
 #[Attribute(Attribute::TARGET_METHOD)]
 final class CreateTagRequestBody extends RequestBody

diff --git a/src/Tag/Attributes/Request/ElementTagRequestBody.php b/src/Tag/Attributes/Request/ElementTagRequestBody.php
diff --git a/src/Tag/Attributes/Request/UpdateTagRequestBody.php b/src/Tag/Attributes/Request/UpdateTagRequestBody.php
@@ -19,7 +19,7 @@
 use Attribute;
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\RequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\UpdateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\UpdateTagParameters;
 
 #[Attribute(Attribute::TARGET_METHOD)]
 final class UpdateTagRequestBody extends RequestBody

diff --git a/src/Tag/Controller/CollectionController.php b/src/Tag/Controller/CollectionController.php
@@ -32,7 +32,7 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\Error\UnsupportedMediaTypeResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\TagsParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\TagsParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\Tag;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;

diff --git a/src/Tag/Controller/CreateController.php b/src/Tag/Controller/CreateController.php
@@ -28,7 +28,7 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\CreateTagRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\CreateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\CreateTagParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\Tag;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;

diff --git a/src/Tag/Controller/Element/AssignController.php b/src/Tag/Controller/Element/AssignController.php
@@ -24,16 +24,11 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\ElementTagRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\ElementParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\TagId;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\ElementParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
-use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
@@ -52,28 +47,28 @@ public function __construct(
     /**
      * @throws ElementSavingFailedException|ElementNotFoundException
      */
-    #[Route('/tags/{elementType}/{id}', name: 'pimcore_studio_api_assign_element_tag', methods: ['POST'])]
+    #[Route('/tags/{elementType}/{id}/{tagId}', name: 'pimcore_studio_api_assign_element_tag', methods: ['POST'])]
     //#[IsGranted(UserPermissions::TAGS_ASSIGNMENT->value)]
     #[Post(
-        path: self::API_PATH . '/tags/{elementType}/{id}',
+        path: self::API_PATH . '/tags/{elementType}/{id}/{tagId}',
         operationId: 'assignTagForElement',
         summary: 'Assign tag for element',
         security: self::SECURITY_SCHEME,
         tags: [Tags::TagsForElement->value]
     )]
     #[ElementTypeParameter]
     #[IdParameter(type: 'element')]
-    #[ElementTagRequestBody]
+    #[IdParameter(type: 'tag', name: 'tagId')]
     #[DefaultResponses([
         HttpResponseCodes::UNAUTHORIZED
     ])]
     public function assignTag(
         string $elementType,
         int $id,
-        #[MapRequestPayload] TagId $assignTag
+        int $tagId
     ): JsonResponse
     {
-        $this->tagService->assignTagToElement(new ElementParameters($elementType, $id), $assignTag->getTagId());
+        $this->tagService->assignTagToElement(new ElementParameters($elementType, $id), $tagId);
         return $this->jsonResponse(['id' => $id]);
     }
 }
diff --git a/src/Tag/Controller/Element/BatchAssignController.php b/src/Tag/Controller/Element/BatchAssignController.php
@@ -24,15 +24,13 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\ElementsTagsCollectionRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\BatchCollectionParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\BatchCollectionParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\ElementTagIdCollection;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
-use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**

diff --git a/src/Tag/Controller/Element/BatchReplaceController.php b/src/Tag/Controller/Element/BatchReplaceController.php
@@ -24,15 +24,13 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\ElementsTagsCollectionRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\BatchCollectionParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\BatchCollectionParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\ElementTagIdCollection;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
-use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**

diff --git a/src/Tag/Controller/Element/CollectionController.php b/src/Tag/Controller/Element/CollectionController.php
@@ -20,26 +20,19 @@
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\ElementTypeParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\FieldFilterParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\FilterParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\PageParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\PageSizeParameter;
-use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Query\SortOrderParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\Content\CollectionJson;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Response\Property\TagCollection;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\ElementParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\TagsParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\ElementParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\TagsParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
-use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
 use Pimcore\Bundle\StudioBackendBundle\Util\Traits\PaginatedResponseTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Attribute\MapQueryString;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
 use function count;
 

diff --git a/src/Tag/Controller/Element/UnassignController.php b/src/Tag/Controller/Element/UnassignController.php
@@ -24,16 +24,11 @@
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\ElementTagRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\ElementParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\TagId;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\ElementParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
-use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
 use Symfony\Component\Routing\Attribute\Route;
-use Symfony\Component\Security\Http\Attribute\IsGranted;
 use Symfony\Component\Serializer\SerializerInterface;
 
 /**
@@ -52,28 +47,28 @@ public function __construct(
     /**
      * @throws ElementSavingFailedException|ElementNotFoundException
      */
-    #[Route('/tags/{elementType}/{id}', name: 'pimcore_studio_api_unassign_element_tag', methods: ['DELETE'])]
+    #[Route('/tags/{elementType}/{id}/{tagId}', name: 'pimcore_studio_api_unassign_element_tag', methods: ['DELETE'])]
     //#[IsGranted(UserPermissions::TAGS_ASSIGNMENT->value)]
     #[Delete(
-        path: self::API_PATH . '/tags/{elementType}/{id}',
+        path: self::API_PATH . '/tags/{elementType}/{id}/{tagId}',
         operationId: 'unassignTagFromElement',
         summary: 'Unassign tag from element',
         security: self::SECURITY_SCHEME,
         tags: [Tags::TagsForElement->value]
     )]
     #[ElementTypeParameter]
     #[IdParameter(type: 'element')]
-    #[ElementTagRequestBody]
+    #[IdParameter(type: 'tag', name: 'tagId')]
     #[DefaultResponses([
         HttpResponseCodes::UNAUTHORIZED
     ])]
     public function unassignTag(
         string $elementType,
         int $id,
-        #[MapRequestPayload] TagId $unassignTag
+        int $tagId
     ): JsonResponse
     {
-        $this->tagService->unassignTagFromElement(new ElementParameters($elementType, $id), $unassignTag->getTagId());
+        $this->tagService->unassignTagFromElement(new ElementParameters($elementType, $id), $tagId);
         return $this->jsonResponse(['id' => $id]);
     }
 }
diff --git a/src/Tag/Controller/UpdateController.php b/src/Tag/Controller/UpdateController.php
@@ -18,14 +18,13 @@
 
 use OpenApi\Attributes\JsonContent;
 use OpenApi\Attributes\Put;
-use OpenApi\Attributes\Schema;
 use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\DefaultResponses;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\SuccessResponse;
 use Pimcore\Bundle\StudioBackendBundle\OpenApi\Config\Tags;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Attributes\Request\UpdateTagRequestBody;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\UpdateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\UpdateTagParameters;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\Tag;
 use Pimcore\Bundle\StudioBackendBundle\Tag\Service\TagServiceInterface;
 use Pimcore\Bundle\StudioBackendBundle\Util\Constants\HttpResponseCodes;
@@ -57,7 +56,7 @@ public function __construct(
         tags: [Tags::Tags->name]
     )]
     #[IsGranted(UserPermissions::TAGS_CONFIGURATION->value)]
-    #[IdParameter(type: 'tag', schema: new Schema(type: 'integer', example: 10))]
+    #[IdParameter(type: 'tag')]
     #[UpdateTagRequestBody]
     #[SuccessResponse(
         description: 'Updated tag data as json',

diff --git a/...Tag/Request/BatchCollectionParameters.php → ...edParameter/BatchCollectionParameters.php b/...Tag/Request/BatchCollectionParameters.php → ...edParameter/BatchCollectionParameters.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Tag\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter;
 
 /**
  * @internal

diff --git a/src/Tag/Request/CreateTagParameters.php → ...g/MappedParameter/CreateTagParameters.php b/src/Tag/Request/CreateTagParameters.php → ...g/MappedParameter/CreateTagParameters.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Tag\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter;
 
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\Schema;

diff --git a/src/Tag/Request/ElementParameters.php → ...Tag/MappedParameter/ElementParameters.php b/src/Tag/Request/ElementParameters.php → ...Tag/MappedParameter/ElementParameters.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Tag\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter;
 
 /**
  * @internal

diff --git a/src/Tag/Request/TagsParameters.php → src/Tag/MappedParameter/TagsParameters.php b/src/Tag/Request/TagsParameters.php → src/Tag/MappedParameter/TagsParameters.php
@@ -14,9 +14,10 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Tag\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter;
 
-use Pimcore\Bundle\StudioBackendBundle\Request\CollectionParameters;
+
+use Pimcore\Bundle\StudioBackendBundle\MappedParameter\CollectionParameters;
 
 /**
  * @internal

diff --git a/src/Tag/Request/UpdateTagParameters.php → ...g/MappedParameter/UpdateTagParameters.php b/src/Tag/Request/UpdateTagParameters.php → ...g/MappedParameter/UpdateTagParameters.php
@@ -14,7 +14,7 @@
  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  */
 
-namespace Pimcore\Bundle\StudioBackendBundle\Tag\Request;
+namespace Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter;
 
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\Schema;

diff --git a/src/Tag/Repository/TagRepository.php b/src/Tag/Repository/TagRepository.php
@@ -20,12 +20,11 @@
 use Pimcore\Bundle\StudioBackendBundle\Exception\ElementDeletingFailedException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Security\Service\SecurityServiceInterface;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\BatchCollectionParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\CreateTagParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\ElementParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\TagsParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\UpdateTagParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Schema\ElementTagIdCollection;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\BatchCollectionParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\CreateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\ElementParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\TagsParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\UpdateTagParameters;
 use Pimcore\Bundle\StudioBackendBundle\Util\Traits\ElementProviderTrait;
 use Pimcore\Model\Element\Tag;
 use Pimcore\Model\Element\Tag\Listing as TagListing;

diff --git a/src/Tag/Repository/TagRepositoryInterface.php b/src/Tag/Repository/TagRepositoryInterface.php
@@ -18,11 +18,11 @@
 
 use Pimcore\Bundle\StudioBackendBundle\Exception\ElementDeletingFailedException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\BatchCollectionParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\CreateTagParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\ElementParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\TagsParameters;
-use Pimcore\Bundle\StudioBackendBundle\Tag\Request\UpdateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\BatchCollectionParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\CreateTagParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\ElementParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\TagsParameters;
+use Pimcore\Bundle\StudioBackendBundle\Tag\MappedParameter\UpdateTagParameters;
 use Pimcore\Model\Element\Tag;
 use Pimcore\Model\Element\Tag\Listing as TagListing;