Use named arguments for rest routes

Author: nickygerritsen

webapp/src/Controller/API/AccessController.php

@@ -12,7 +12,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 
-#[Rest\Route('/contests/{cid}/access')]
+#[Rest\Route(path: '/contests/{cid}/access')]
 #[OA\Tag(name: 'Access')]
 #[OA\Parameter(ref: '#/components/parameters/cid')]
 #[OA\Parameter(ref: '#/components/parameters/strict')]
@@ -31,7 +31,7 @@ class AccessController extends AbstractApiController
      * @return Access
      */
     #[IsGranted('ROLE_API_READER')]
-    #[Rest\Get('')]
+    #[Rest\Get(path: '')]
     #[OA\Response(
         response: 200,
         description: 'Access information for the given contest',

webapp/src/Controller/API/AccountController.php

@@ -17,7 +17,7 @@
 /**
  * @extends AbstractRestController<User, User>
  */
-#[Rest\Route('/contests/{cid}')]
+#[Rest\Route(path: '/contests/{cid}')]
 #[OA\Tag(name: 'Accounts')]
 #[OA\Parameter(ref: '#/components/parameters/cid')]
 #[OA\Parameter(ref: '#/components/parameters/strict')]
@@ -38,7 +38,7 @@ class AccountController extends AbstractRestController
      * @throws NonUniqueResultException
      */
     #[IsGranted(new Expression("is_granted('ROLE_ADMIN') or is_granted('ROLE_API_READER')"))]
-    #[Rest\Get('/accounts')]
+    #[Rest\Get(path: '/accounts')]
     #[OA\Response(
         response: 200,
         description: 'Returns all the accounts for this contest',
@@ -66,7 +66,7 @@ public function listAction(Request $request): Response
      * @throws NonUniqueResultException
      */
     #[IsGranted(new Expression("is_granted('ROLE_ADMIN') or is_granted('ROLE_API_READER')"))]
-    #[Rest\Get('/accounts/{id}')]
+    #[Rest\Get(path: '/accounts/{id}')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given account',
@@ -83,7 +83,7 @@ public function singleAction(Request $request, string $id): Response
     /**
      * Get information about the currently logged in account.
      */
-    #[Rest\Get('/account')]
+    #[Rest\Get(path: '/account')]
     #[OA\Response(
         response: 200,
         description: 'Information about the logged in account',

webapp/src/Controller/API/AwardsController.php

@@ -19,7 +19,7 @@
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
-#[Rest\Route('/contests/{cid}/awards')]
+#[Rest\Route(path: '/contests/{cid}/awards')]
 #[OA\Tag(name: 'Awards')]
 #[OA\Parameter(ref: '#/components/parameters/cid')]
 #[OA\Parameter(ref: '#/components/parameters/strict')]
@@ -46,7 +46,7 @@ public function __construct(
      *
      * @return Award[]
      */
-    #[Rest\Get('')]
+    #[Rest\Get(path: '')]
     #[OA\Response(
         response: 200,
         description: 'Returns the current teams qualifying for each award',
@@ -66,7 +66,7 @@ public function listAction(Request $request): array
      *
      * @throws Exception
      */
-    #[Rest\Get('/{id}')]
+    #[Rest\Get(path: '/{id}')]
     #[OA\Response(
         response: 200,
         description: 'Returns the award for this contest',

webapp/src/Controller/API/BalloonController.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 
 #[IsGranted(new Expression("is_granted('ROLE_JURY') or is_granted('ROLE_API_READER') or is_granted('ROLE_BALLOON')"))]
-#[Rest\Route('/contests/{cid}/balloons')]
+#[Rest\Route(path: '/contests/{cid}/balloons')]
 #[OA\Tag(name: 'Balloons')]
 #[OA\Parameter(ref: '#/components/parameters/cid')]
 #[OA\Response(ref: '#/components/responses/NotFound', response: 404)]
@@ -31,7 +31,7 @@ class BalloonController extends AbstractApiController
      * @throws NonUniqueResultException
      * @return Balloon[]
      */
-    #[Rest\Get('')]
+    #[Rest\Get(path: '')]
     #[OA\Response(
         response: 200,
         description: 'Returns the balloons for this contest.',
@@ -84,7 +84,7 @@ public function listAction(
      * Mark a specific balloon as done.
      */
     #[IsGranted(new Expression("is_granted('ROLE_JURY') or is_granted('ROLE_BALLOON')"))]
-    #[Rest\Post('/{balloonId<\d+>}/done')]
+    #[Rest\Post(path: '/{balloonId<\d+>}/done')]
     #[OA\Response(
         response: 204,
         description: 'The balloon was now marked as done or already marked as such.'

webapp/src/Controller/API/ClarificationController.php

@@ -24,7 +24,7 @@
 /**
  * @extends AbstractRestController<Clarification, Clarification>
  */
-#[Rest\Route('/contests/{cid}/clarifications')]
+#[Rest\Route(path: '/contests/{cid}/clarifications')]
 #[OA\Tag(name: 'Clarifications')]
 #[OA\Parameter(ref: '#/components/parameters/cid')]
 #[OA\Parameter(ref: '#/components/parameters/strict')]
@@ -40,7 +40,7 @@ class ClarificationController extends AbstractRestController
      * Note that we restrict the returned clarifications in the query builder.
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('')]
+    #[Rest\Get(path: '')]
     #[OA\Response(
         response: 200,
         description: 'Returns all the clarifications for this contest',
@@ -69,7 +69,7 @@ public function listAction(Request $request): Response
      * team user gets general clarifications plus those sent from or to the team.
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('/{id}')]
+    #[Rest\Get(path: '/{id}')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given clarification for this contest',
@@ -89,8 +89,8 @@ public function singleAction(Request $request, string $id): Response
         new Expression("is_granted('ROLE_TEAM') or is_granted('ROLE_API_WRITER')"),
         message: 'You need to have the Team Member role to add a clarification'
     )]
-    #[Rest\Post('')]
-    #[Rest\Put('/{id}')]
+    #[Rest\Post(path: '')]
+    #[Rest\Put(path: '/{id}')]
     #[OA\RequestBody(
         required: true,
         content: [

webapp/src/Controller/API/ContestController.php

@@ -50,7 +50,7 @@
 /**
  * @extends AbstractRestController<Contest, Contest>
  */
-#[Rest\Route('/contests')]
+#[Rest\Route(path: '/contests')]
 #[OA\Tag(name: 'Contests')]
 #[OA\Parameter(ref: '#/components/parameters/strict')]
 #[OA\Response(ref: '#/components/responses/InvalidResponse', response: 400)]
@@ -76,7 +76,7 @@ public function __construct(
      * @throws BadRequestHttpException
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Post('')]
+    #[Rest\Post(path: '')]
     #[OA\RequestBody(
         required: true,
         content: new OA\MediaType(
@@ -126,7 +126,7 @@ public function addContestAction(Request $request): string
      * Get all the contests.
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('')]
+    #[Rest\Get(path: '')]
     #[OA\Response(
         response: 200,
         description: 'Returns all contests visible to the user (all contests for privileged users, active contests otherwise)',
@@ -151,7 +151,7 @@ public function listAction(Request $request): Response
      * Get the given contest.
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('/{cid}')]
+    #[Rest\Get(path: '/{cid}')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given contest',
@@ -166,7 +166,7 @@ public function singleAction(Request $request, string $cid): Response
     /**
      * Get the banner for the given contest.
      */
-    #[Rest\Get('/{cid}/banner', name: 'contest_banner')]
+    #[Rest\Get(path: '/{cid}/banner', name: 'contest_banner')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given contest banner in PNG, JPG or SVG format',
@@ -202,7 +202,7 @@ public function bannerAction(Request $request, string $cid): Response
      * Delete the banner for the given contest.
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Delete('/{cid}/banner', name: 'delete_contest_banner')]
+    #[Rest\Delete(path: '/{cid}/banner', name: 'delete_contest_banner')]
     #[OA\Response(response: 204, description: 'Deleting banner succeeded')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     public function deleteBannerAction(Request $request, string $cid): Response
@@ -270,7 +270,7 @@ public function setBannerAction(Request $request, string $cid, ValidatorInterfac
      * Delete the problemset document for the given contest.
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Delete('/{cid}/problemset', name: 'delete_contest_problemset')]
+    #[Rest\Delete(path: '/{cid}/problemset', name: 'delete_contest_problemset')]
     #[OA\Response(response: 204, description: 'Deleting problemset document succeeded')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     public function deleteProblemsetAction(Request $request, string $cid): Response
@@ -342,7 +342,7 @@ public function setProblemsetAction(Request $request, string $cid, ValidatorInte
     /**
      * Get the problemset document for the given contest.
      */
-    #[Rest\Get('/{cid}/problemset', name: 'contest_problemset')]
+    #[Rest\Get(path: '/{cid}/problemset', name: 'contest_problemset')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given contest problemset document in PDF, HTML or TXT format',
@@ -386,7 +386,7 @@ public function problemsetAction(Request $request, string $cid): Response
      * @throws NonUniqueResultException
      */
     #[IsGranted('ROLE_API_WRITER')]
-    #[Rest\Patch('/{cid}')]
+    #[Rest\Patch(path: '/{cid}')]
     #[OA\RequestBody(
         required: true,
         content: new OA\MediaType(
@@ -498,7 +498,7 @@ public function changeStartTimeAction(
      * Get the contest in YAML format.
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('/{cid}/contest-yaml')]
+    #[Rest\Get(path: '/{cid}/contest-yaml')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     #[OA\Response(
         response: 200,
@@ -525,7 +525,7 @@ public function getContestYamlAction(Request $request, string $cid): StreamedRes
      * Get the current contest state
      * @throws NonUniqueResultException
      */
-    #[Rest\Get('/{cid}/state')]
+    #[Rest\Get(path: '/{cid}/state')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     #[OA\Response(
         response: 200,
@@ -548,7 +548,7 @@ public function getContestStateAction(Request $request, string $cid): ContestSta
      * @throws NonUniqueResultException
      */
     #[IsGranted(new Expression("is_granted('ROLE_JURY') or is_granted('ROLE_API_READER')"))]
-    #[Rest\Get('/{cid}/event-feed')]
+    #[Rest\Get(path: '/{cid}/event-feed')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     #[OA\Parameter(
         name: 'since_id',
@@ -914,7 +914,7 @@ public function getEventFeedAction(
      * @throws NonUniqueResultException
      */
     #[IsGranted('ROLE_API_READER')]
-    #[Rest\Get('/{cid}/status')]
+    #[Rest\Get(path: '/{cid}/status')]
     #[OA\Parameter(ref: '#/components/parameters/cid')]
     #[OA\Response(
         response: 200,
@@ -926,7 +926,7 @@ public function getStatusAction(Request $request, string $cid): ContestStatus
         return $this->dj->getContestStats($this->getContestWithId($request, $cid));
     }
 
-    #[Rest\Get('/{cid}/samples.zip', name: 'samples_data_zip')]
+    #[Rest\Get(path: '/{cid}/samples.zip', name: 'samples_data_zip')]
     #[OA\Response(
         response: 200,
         description: 'The problem samples, statement & attachments as a ZIP archive',

webapp/src/Controller/API/ExecutableController.php

@@ -13,7 +13,7 @@
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Security\Http\Attribute\IsGranted;
 
-#[Rest\Route('/executables')]
+#[Rest\Route(path: '/executables')]
 #[OA\Tag(name: 'Executables')]
 class ExecutableController extends AbstractFOSRestController
 {
@@ -26,7 +26,7 @@ public function __construct(protected readonly EntityManagerInterface $em, prote
      * @throws NonUniqueResultException
      */
     #[IsGranted(new Expression("is_granted('ROLE_JURY') or is_granted('ROLE_JUDGEHOST')"))]
-    #[Rest\Get('/{id}')]
+    #[Rest\Get(path: '/{id}')]
     #[OA\Parameter(ref: '#/components/parameters/id')]
     #[OA\Response(
         response: 200,

webapp/src/Controller/API/GeneralInfoController.php

@@ -59,7 +59,7 @@ public function __construct(
     /**
      * Get the current API version
      */
-    #[Rest\Get('/version')]
+    #[Rest\Get(path: '/version')]
     #[OA\Response(
         response: 200,
         description: 'The current API version information',
@@ -73,8 +73,8 @@ public function getVersionAction(): ApiVersion
     /**
      * Get information about the API and DOMjudge
      */
-    #[Rest\Get('/info')]
-    #[Rest\Get('', name: 'api_root')]
+    #[Rest\Get(path: '/info')]
+    #[Rest\Get(path: '', name: 'api_root')]
     #[OA\Response(
         response: 200,
         description: 'Information about the API and DOMjudge',
@@ -115,7 +115,7 @@ public function getInfoAction(
      * @return ExtendedContestStatus[]
      */
     #[IsGranted('ROLE_API_READER')]
-    #[Rest\Get('/status')]
+    #[Rest\Get(path: '/status')]
     #[OA\Response(
         response: 200,
         description: 'General status information for the currently active contests',
@@ -147,7 +147,7 @@ public function getStatusAction(): array
      * Get information about the currently logged in user.
      */
     #[IsGranted('IS_AUTHENTICATED_FULLY')]
-    #[Rest\Get('/user')]
+    #[Rest\Get(path: '/user')]
     #[OA\Response(
         response: 200,
         description: 'Information about the logged in user',
@@ -163,7 +163,7 @@ public function getUserAction(): User
      *
      * @return array<string, bool|int|string|array<string, string>>
      */
-    #[Rest\Get('/config')]
+    #[Rest\Get(path: '/config')]
     #[OA\Response(
         response: 200,
         description: 'The configuration variables',
@@ -206,7 +206,7 @@ public function getDatabaseConfigurationAction(
      * @throws NonUniqueResultException
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Put('/config')]
+    #[Rest\Put(path: '/config')]
     #[OA\Response(
         response: 200,
         description: 'The full configuration after change',
@@ -244,7 +244,7 @@ public function updateConfigurationAction(Request $request): JsonResponse|array
      * Check the DOMjudge configuration.
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Get('/config/check')]
+    #[Rest\Get(path: '/config/check')]
     #[OA\Response(
         response: 200,
         description: 'Result of the various checks performed, no problems found',
@@ -288,7 +288,7 @@ public function getConfigCheckAction(SerializerInterface $serializer): Response
     /**
      * Get the flag for the given country.
      */
-    #[Rest\Get('/country-flags/{countryCode}/{size}')]
+    #[Rest\Get(path: '/country-flags/{countryCode}/{size}')]
     #[OA\Response(
         response: 200,
         description: 'Returns the given country flag in SVG format',
@@ -333,7 +333,7 @@ public function countryFlagAction(
      * @return array{problem_id: string, messages: array<string, string[]>}
      */
     #[IsGranted('ROLE_ADMIN')]
-    #[Rest\Post('/problems')]
+    #[Rest\Post(path: '/problems')]
     #[OA\Tag(name: 'Problems')]
     #[OA\RequestBody(
         required: true,