Skip to content

Commit e4d4b0a

Browse files
committed
Update: shorten admin param name
1 parent e4874b2 commit e4d4b0a

File tree

3 files changed

+12
-18
lines changed

3 files changed

+12
-18
lines changed

src/Common/Validator/RequestValidator.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ public function validate(Request $request, string $dtoClass): RequestInterface
3838
if (isset($routeParams['listId'])) {
3939
$routeParams['listId'] = (int) $routeParams['listId'];
4040
}
41-
if (isset($routeParams['administratorId'])) {
42-
$routeParams['administratorId'] = (int) $routeParams['administratorId'];
43-
}
4441

4542
$data = array_merge($routeParams, $body ?? []);
4643

src/Identity/Controller/AdministratorController.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,16 @@ public function createAdministrator(
157157
return $this->json($json, Response::HTTP_CREATED);
158158
}
159159

160-
#[Route('/{administratorId}', name: 'get_one', requirements: ['administratorId' => '\d+'], methods: ['GET'])]
160+
#[Route('/{adminId}', name: 'get_one', requirements: ['adminId' => '\d+'], methods: ['GET'])]
161161
#[OA\Get(
162-
path: '/api/v2/administrators/{administratorId}',
162+
path: '/api/v2/administrators/{adminId}',
163163
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
164164
'Get administrator by ID.',
165165
summary: 'Get Administrator',
166166
tags: ['administrators'],
167167
parameters: [
168168
new OA\Parameter(
169-
name: 'administratorId',
169+
name: 'adminId',
170170
description: 'Administrator ID',
171171
in: 'path',
172172
required: true,
@@ -194,7 +194,7 @@ public function createAdministrator(
194194
)]
195195
public function getAdministrator(
196196
Request $request,
197-
#[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator,
197+
#[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator,
198198
): JsonResponse {
199199
$this->requireAuthentication($request);
200200

@@ -206,9 +206,9 @@ public function getAdministrator(
206206
return $this->json($json, Response::HTTP_OK);
207207
}
208208

209-
#[Route('/{administratorId}', name: 'update', requirements: ['administratorId' => '\d+'], methods: ['PUT'])]
209+
#[Route('/{adminId}', name: 'update', requirements: ['adminId' => '\d+'], methods: ['PUT'])]
210210
#[OA\Put(
211-
path: '/api/v2/administrators/{administratorId}',
211+
path: '/api/v2/administrators/{adminId}',
212212
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
213213
'Update an administrator.',
214214
summary: 'Update Administrator',
@@ -220,7 +220,7 @@ public function getAdministrator(
220220
tags: ['administrators'],
221221
parameters: [
222222
new OA\Parameter(
223-
name: 'administratorId',
223+
name: 'adminId',
224224
description: 'Administrator ID',
225225
in: 'path',
226226
required: true,
@@ -248,7 +248,7 @@ public function getAdministrator(
248248
)]
249249
public function updateAdministrator(
250250
Request $request,
251-
#[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator,
251+
#[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator,
252252
): JsonResponse {
253253
$this->requireAuthentication($request);
254254

@@ -263,16 +263,16 @@ public function updateAdministrator(
263263
return $this->json($this->normalizer->normalize($administrator), Response::HTTP_OK);
264264
}
265265

266-
#[Route('/{administratorId}', name: 'delete', requirements: ['administratorId' => '\d+'], methods: ['DELETE'])]
266+
#[Route('/{adminId}', name: 'delete', requirements: ['adminId' => '\d+'], methods: ['DELETE'])]
267267
#[OA\Delete(
268-
path: '/api/v2/administrators/{administratorId}',
268+
path: '/api/v2/administrators/{adminId}',
269269
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
270270
'Delete an administrator.',
271271
summary: 'Delete Administrator',
272272
tags: ['administrators'],
273273
parameters: [
274274
new OA\Parameter(
275-
name: 'administratorId',
275+
name: 'adminId',
276276
description: 'Administrator ID',
277277
in: 'path',
278278
required: true,
@@ -299,7 +299,7 @@ public function updateAdministrator(
299299
)]
300300
public function deleteAdministrator(
301301
Request $request,
302-
#[MapEntity(mapping: ['administratorId' => 'id'])] ?Administrator $administrator
302+
#[MapEntity(mapping: ['adminId' => 'id'])] ?Administrator $administrator
303303
): JsonResponse {
304304
$this->requireAuthentication($request);
305305

src/Identity/Request/UpdateAdministratorRequest.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,6 @@
5858
)]
5959
class UpdateAdministratorRequest implements RequestInterface
6060
{
61-
public int $administratorId;
62-
6361
#[Assert\Length(min: 3, max: 255)]
6462
#[UniqueLoginName]
6563
public ?string $loginName = null;
@@ -89,7 +87,6 @@ class UpdateAdministratorRequest implements RequestInterface
8987
public function getDto(): UpdateAdministratorDto
9088
{
9189
return new UpdateAdministratorDto(
92-
administratorId: $this->administratorId,
9390
loginName: $this->loginName,
9491
password: $this->password,
9592
email: $this->email,

0 commit comments

Comments
 (0)