Olivier Massot 1 år sedan
förälder
incheckning
a0c4757478
1 ändrade filer med 14 tillägg och 0 borttagningar
  1. 14 0
      ot_admin/Classes/Http/ApiController.php

+ 14 - 0
ot_admin/Classes/Http/ApiController.php

@@ -268,6 +268,8 @@ class ApiController implements LoggerAwareInterface
      * shall be named 'Confirmation-Token' and its value shall be DEL-XXXX-YYYYMMDD, where XXXX is the id of
      * the organization owning the website, and YYYYMMDD is the date of the current day.
      *
+     * /!\ Warning: this is a destructive operation
+     *
      * @param ServerRequest $request
      * @return JsonResponse
      * @throws \Exception
@@ -479,6 +481,18 @@ class ApiController implements LoggerAwareInterface
         return new JsonResponse($results);
     }
 
+    /**
+     * -- Target of the route 'delete-user-created-pages' --
+     * >> Requires a query param named 'organization-id' (int)
+     *
+     * Delete all user-created pages for the organization's website
+     *
+     * /!\ Warning: this is a destructive operation
+     *
+     * @param ServerRequest $request
+     * @return JsonResponse
+     * @throws \Exception
+     */
     public function deleteUserCreatedPagesAction(ServerRequest $request): JsonResponse
     {
         $this->assertIpAllowed();