Skip to content

Commit 510f067

Browse files
committed
ISSUE-344: fix parameter names
1 parent 5596e2f commit 510f067

File tree

3 files changed

+28
-25
lines changed

3 files changed

+28
-25
lines changed

src/Controller/ListController.php

+20-17
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
*
2525
* @author Oliver Klee <[email protected]>
2626
* @author Xheni Myrtaj <[email protected]>
27+
* @author Tatevik Grigoryan <[email protected]>
2728
*/
2829
class ListController extends AbstractController
2930
{
@@ -119,15 +120,15 @@ public function getLists(Request $request): JsonResponse
119120
return new JsonResponse($json, Response::HTTP_OK, [], true);
120121
}
121122

122-
#[Route('/lists/{id}', name: 'get_list', methods: ['GET'])]
123+
#[Route('/lists/{listId}', name: 'get_list', methods: ['GET'])]
123124
#[OA\Get(
124-
path: '/lists/{list}',
125+
path: '/lists/{listId}',
125126
description: 'Returns a single subscriber list with specified ID.',
126127
summary: 'Gets a subscriber list.',
127128
tags: ['lists'],
128129
parameters: [
129130
new OA\Parameter(
130-
name: 'list',
131+
name: 'listId',
131132
description: 'List ID',
132133
in: 'path',
133134
required: true,
@@ -189,8 +190,10 @@ public function getLists(Request $request): JsonResponse
189190
)
190191
]
191192
)]
192-
public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list): JsonResponse
193-
{
193+
public function getList(
194+
Request $request,
195+
#[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
196+
): JsonResponse {
194197
$this->requireAuthentication($request);
195198
$json = $this->serializer->serialize($list, 'json', [
196199
AbstractNormalizer::GROUPS => 'SubscriberList',
@@ -199,9 +202,9 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
199202
return new JsonResponse($json, Response::HTTP_OK, [], true);
200203
}
201204

202-
#[Route('/lists/{id}', name: 'delete_list', methods: ['DELETE'])]
205+
#[Route('/lists/{listId}', name: 'delete_list', methods: ['DELETE'])]
203206
#[OA\Delete(
204-
path: '/lists/{list}',
207+
path: '/lists/{listId}',
205208
description: 'Deletes a single subscriber list.',
206209
summary: 'Deletes a list.',
207210
tags: ['lists'],
@@ -214,7 +217,7 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
214217
schema: new OA\Schema(type: 'string')
215218
),
216219
new OA\Parameter(
217-
name: 'list',
220+
name: 'listId',
218221
description: 'List ID',
219222
in: 'path',
220223
required: true,
@@ -258,7 +261,7 @@ public function getList(Request $request, #[MapEntity(mapping: ['id' => 'id'])]
258261
)]
259262
public function deleteList(
260263
Request $request,
261-
#[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
264+
#[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
262265
): JsonResponse {
263266
$this->requireAuthentication($request);
264267

@@ -267,9 +270,9 @@ public function deleteList(
267270
return new JsonResponse(null, Response::HTTP_NO_CONTENT, [], false);
268271
}
269272

270-
#[Route('/lists/{id}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
273+
#[Route('/lists/{listId}/subscribers', name: 'get_subscriber_from_list', methods: ['GET'])]
271274
#[OA\Get(
272-
path: '/lists/{id}/subscribers',
275+
path: '/lists/{listId}/subscribers',
273276
description: 'Returns a JSON list of all subscribers for a subscriber list.',
274277
summary: 'Gets a list of all subscribers of a subscriber list.',
275278
tags: ['lists'],
@@ -282,7 +285,7 @@ public function deleteList(
282285
schema: new OA\Schema(type: 'string')
283286
),
284287
new OA\Parameter(
285-
name: 'id',
288+
name: 'listId',
286289
description: 'List ID',
287290
in: 'path',
288291
required: true,
@@ -338,7 +341,7 @@ public function deleteList(
338341
)]
339342
public function getListMembers(
340343
Request $request,
341-
#[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
344+
#[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
342345
): JsonResponse {
343346
$this->requireAuthentication($request);
344347

@@ -351,9 +354,9 @@ public function getListMembers(
351354
return new JsonResponse($json, Response::HTTP_OK, [], true);
352355
}
353356

354-
#[Route('/lists/{id}/subscribers/count', name: 'get_subscribers_count_from_list', methods: ['GET'])]
357+
#[Route('/lists/{listId}/subscribers/count', name: 'get_subscribers_count_from_list', methods: ['GET'])]
355358
#[OA\Get(
356-
path: '/lists/{id}/count',
359+
path: '/lists/{listId}/count',
357360
description: 'Returns a count of all subscribers in a given list.',
358361
summary: 'Gets the total number of subscribers of a list',
359362
tags: ['lists'],
@@ -366,7 +369,7 @@ public function getListMembers(
366369
schema: new OA\Schema(type: 'string')
367370
),
368371
new OA\Parameter(
369-
name: 'id',
372+
name: 'listId',
370373
description: 'List ID',
371374
in: 'path',
372375
required: true,
@@ -396,7 +399,7 @@ public function getListMembers(
396399
)]
397400
public function getSubscribersCount(
398401
Request $request,
399-
#[MapEntity(mapping: ['id' => 'id'])] SubscriberList $list
402+
#[MapEntity(mapping: ['listId' => 'id'])] SubscriberList $list
400403
): JsonResponse {
401404
$this->requireAuthentication($request);
402405
$json = $this->serializer->serialize(count($list->getSubscribers()), 'json');

src/Controller/SessionController.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ public function createSession(Request $request): JsonResponse
129129
*
130130
* @throws AccessDeniedHttpException
131131
*/
132-
#[Route('/sessions/{id}', name: 'delete_session', methods: ['DELETE'])]
132+
#[Route('/sessions/{sessionId}', name: 'delete_session', methods: ['DELETE'])]
133133
#[OA\Delete(
134-
path: '/sessions/{session}',
134+
path: '/sessions/{sessionId}',
135135
description: 'Delete the session passed as a parameter.',
136136
summary: 'Delete a session.',
137137
tags: ['sessions'],
138138
parameters: [
139139
new OA\Parameter(
140-
name: 'session',
140+
name: 'sessionId',
141141
description: 'Session ID',
142142
in: 'path',
143143
required: true,
@@ -179,7 +179,7 @@ public function createSession(Request $request): JsonResponse
179179
)]
180180
public function deleteAction(
181181
Request $request,
182-
#[MapEntity(mapping: ['id' => 'id'])] AdministratorToken $token
182+
#[MapEntity(mapping: ['sessionId' => 'id'])] AdministratorToken $token
183183
): JsonResponse {
184184
$administrator = $this->requireAuthentication($request);
185185
if ($token->getAdministrator() !== $administrator) {

src/Controller/SubscriberController.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@ public function postAction(Request $request, SerializerInterface $serializer): J
158158
);
159159
}
160160

161-
#[Route('/subscribers/{subscriber}', name: 'get_subscriber_by_id', methods: ['GET'])]
161+
#[Route('/subscribers/{subscriberId}', name: 'get_subscriber_by_id', methods: ['GET'])]
162162
#[OA\Get(
163-
path: '/subscribers/{subscriber}',
163+
path: '/subscribers/{subscriberId}',
164164
description: 'Get subscriber date by id.',
165165
summary: 'Get a subscriber',
166166
tags: ['subscribers'],
@@ -173,7 +173,7 @@ public function postAction(Request $request, SerializerInterface $serializer): J
173173
schema: new OA\Schema(type: 'string')
174174
),
175175
new OA\Parameter(
176-
name: 'id',
176+
name: 'subscriberId',
177177
description: 'Subscriber ID',
178178
in: 'path',
179179
required: true,
@@ -228,7 +228,7 @@ public function postAction(Request $request, SerializerInterface $serializer): J
228228
)]
229229
public function getAction(
230230
Request $request,
231-
#[MapEntity(mapping: ['id' => 'id'])] Subscriber $subscriber,
231+
#[MapEntity(mapping: ['subscriberId' => 'id'])] Subscriber $subscriber,
232232
SerializerInterface $serializer
233233
): JsonResponse {
234234
$this->requireAuthentication($request);

0 commit comments

Comments
 (0)