Add delete controller and service methods, update descriptions of pro…

…perty controllers

src/Exception/ElementNotFoundException.php

@@ -21,8 +21,8 @@
  */
 final class ElementNotFoundException extends AbstractApiException
 {
-    public function __construct(int $id)
+    public function __construct(int $id, string $type = 'Element')
     {
-        parent::__construct(404, 'Element with ID ' . $id . ' not found');
+        parent::__construct(404, sprintf('%s with ID %d not found', $type, $id));
     }
 }

src/Note/Controller/DeleteController.php

@@ -0,0 +1,70 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Note\Controller;
+
+use OpenApi\Attributes\Delete;
+use Pimcore\Bundle\StudioBackendBundle\Controller\AbstractApiController;
+use Pimcore\Bundle\StudioBackendBundle\Note\Service\NoteServiceInterface;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Parameters\Path\IdParameter;
+use Pimcore\Bundle\StudioBackendBundle\OpenApi\Attributes\Response\Content\IdJson;
+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\Util\Constants\HttpResponseCodes;
+use Pimcore\Bundle\StudioBackendBundle\Util\Constants\UserPermissions;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ */
+final class DeleteController extends AbstractApiController
+{
+    public function __construct(
+        SerializerInterface $serializer,
+        private readonly NoteServiceInterface $noteService
+    )
+    {
+        parent::__construct($serializer);
+    }
+
+    #[Route('/notes/{id}', name: 'pimcore_studio_api_delete_note', methods: ['DELETE'])]
+    #[IsGranted(UserPermissions::NOTES_EVENTS->value)]
+    #[Delete(
+        path: self::API_PATH . '/notes/{id}',
+        operationId: 'deleteNote',
+        summary: 'Deleting note by id',
+        security: self::SECURITY_SCHEME,
+        tags: [Tags::Notes->name]
+    )]
+    #[IdParameter]
+    #[SuccessResponse(
+        description: 'Id of the note that got deleted',
+        content: new IdJson('ID of deleted note')
+    )]
+    #[DefaultResponses([
+        HttpResponseCodes::NOT_FOUND,
+        HttpResponseCodes::UNAUTHORIZED
+    ])]
+    public function deleteNote(int $id): JsonResponse
+    {
+        $this->noteService->deleteNote($id);
+        return $this->jsonResponse(['id' => $id]);
+    }
+}

src/Note/Repository/NoteRepository.php

@@ -17,6 +17,7 @@
 namespace Pimcore\Bundle\StudioBackendBundle\Note\Repository;
 
 use Pimcore\Bundle\StaticResolverBundle\Models\Element\NoteResolverInterface;
+use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteElement;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteParameters;
 use Pimcore\Bundle\StudioBackendBundle\Note\Schema\CreateNote;
@@ -87,4 +88,16 @@ public function listNotes(NoteElement $noteElement, NoteParameters $parameters):
 
         return $list;
     }
-}
+
+    /**
+     * @throws ElementNotFoundException
+     */
+    public function deleteNote(int $id): void
+    {
+        $note = $this->noteResolver->getById($id);
+        if(!$note) {
+            throw new ElementNotFoundException($id, 'Note');
+        }
+        $note->delete();
+    }
+}

src/Note/Repository/NoteRepositoryInterface.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Note\Repository;
 
+use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteElement;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteParameters;
 use Pimcore\Bundle\StudioBackendBundle\Note\Schema\CreateNote;
@@ -30,4 +31,9 @@ interface NoteRepositoryInterface
     public function createNote(NoteElement $noteElement, CreateNote $createNote): Note;
 
     public function listNotes(NoteElement $noteElement, NoteParameters $parameters): NoteListing;
+
+    /**
+     * @throws ElementNotFoundException
+     */
+    public function deleteNote(int $id): void;
 }

src/Note/Service/NoteService.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Note\Service;
 
+use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Note\Hydrator\NoteHydratorInterface;
 use Pimcore\Bundle\StudioBackendBundle\Note\Repository\NoteRepositoryInterface;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteElement;
@@ -60,6 +61,14 @@ public function listNotes(NoteElement $noteElement, NoteParameters $parameters):
         );
     }
 
+    /**
+     * @throws ElementNotFoundException
+     */
+    public function deleteNote(int $id): void
+    {
+        $this->noteRepository->deleteNote($id);
+    }
+
     private function getNote(int $id): Note
     {
         return $this->noteHydrator->hydrate($this->noteRepository->getNote($id));

src/Note/Service/NoteServiceInterface.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Note\Service;
 
+use Pimcore\Bundle\StudioBackendBundle\Exception\ElementNotFoundException;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteElement;
 use Pimcore\Bundle\StudioBackendBundle\Note\Request\NoteParameters;
 use Pimcore\Bundle\StudioBackendBundle\Note\Response\Collection;
@@ -30,4 +31,9 @@ interface NoteServiceInterface
     public function createNote(NoteElement $noteElement, CreateNote $createNote): Note;
 
     public function listNotes(NoteElement $noteElement, NoteParameters $parameters): Collection;
+
+    /**
+     * @throws ElementNotFoundException
+     */
+    public function deleteNote(int $id): void;
 }

src/Property/Controller/CreateController.php

@@ -57,7 +57,7 @@ public function __construct(
         tags: [Tags::Properties->name]
     )]
     #[SuccessResponse(
-        description: 'Element Properties data as json',
+        description: 'Created predefined property',
         content: new JsonContent(ref: PredefinedProperty::class, type: 'object')
     )]
     #[BadRequestResponse]

src/Property/Controller/DeleteController.php

@@ -60,7 +60,7 @@ public function __construct(
     )]
     #[IdParameter(type: 'property', schema: new Schema(type: 'string', example: 'alpha-numerical'))]
     #[SuccessResponse(
-        description: 'Element Properties data as json',
+        description: 'Id of deleted property',
         content: new IdJson('ID of deleted property')
     )]
     #[UnauthorizedResponse]

src/Property/Controller/Element/UpdateController.php

@@ -62,7 +62,7 @@ public function __construct(
     #[IdParameter(type: 'element')]
     #[ElementPropertyRequestBody]
     #[SuccessResponse(
-        description: 'Element Properties data as json',
+        description: 'Updated Element Properties data as json',
         content: new ItemsJson(ElementProperty::class)
     )]
     #[UnauthorizedResponse]

src/Property/Controller/UpdateController.php

@@ -64,7 +64,7 @@ public function __construct(
     #[IdParameter(type: 'property', schema: new Schema(type: 'string', example: 'alpha-numerical'))]
     #[PredefinedPropertyRequestBody]
     #[SuccessResponse(
-        description: 'Updated property',
+        description: 'Updated predefined property',
         content: new JsonContent(ref: PredefinedProperty::class, type: 'object')
     )]
     #[BadRequestResponse]