Skip to content

Commit af1eeb0

Browse files
tatevikg1tatevikg1
committed
ISSUE-345: mark routes
1 parent d7b9464 commit af1eeb0

14 files changed

+48
-48
lines changed

‎src/Identity/Controller/AdminAttributeDefinitionController.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function __construct(
4343
#[Route('', name: 'create', methods: ['POST'])]
4444
#[OA\Post(
4545
path: '/administrators/attributes',
46-
description: 'Returns created admin attribute definition.',
46+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created admin attribute definition.',
4747
summary: 'Create an admin attribute definition.',
4848
requestBody: new OA\RequestBody(
4949
description: 'Pass parameters to create admin attribute.',
@@ -96,7 +96,7 @@ public function create(Request $request): JsonResponse
9696
#[Route('/{definitionId}', name: 'update', requirements: ['definitionId' => '\d+'], methods: ['PUT'])]
9797
#[OA\Put(
9898
path: '/administrators/attributes/{definitionId}',
99-
description: 'Returns updated admin attribute definition.',
99+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated admin attribute definition.',
100100
summary: 'Update an admin attribute definition.',
101101
requestBody: new OA\RequestBody(
102102
description: 'Pass parameters to update admin attribute.',
@@ -162,7 +162,7 @@ public function update(
162162
#[Route('/{definitionId}', name: 'delete', requirements: ['definitionId' => '\d+'], methods: ['DELETE'])]
163163
#[OA\Delete(
164164
path: '/administrators/attributes/{definitionId}',
165-
description: 'Deletes a single admin attribute definition.',
165+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute definition.',
166166
summary: 'Deletes an attribute definition.',
167167
tags: ['admin-attributes'],
168168
parameters: [
@@ -215,7 +215,7 @@ public function delete(
215215
#[Route('', name: 'get_lists', methods: ['GET'])]
216216
#[OA\Get(
217217
path: '/administrators/attributes',
218-
description: 'Returns a JSON list of all admin attribute definitions.',
218+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attribute definitions.',
219219
summary: 'Gets a list of all admin attribute definitions.',
220220
tags: ['admin-attributes'],
221221
parameters: [
@@ -283,7 +283,7 @@ public function getPaginated(Request $request): JsonResponse
283283
#[Route('/{definitionId}', name: 'get_one', requirements: ['definitionId' => '\d+'], methods: ['GET'])]
284284
#[OA\Get(
285285
path: '/administrators/attributes/{definitionId}',
286-
description: 'Returns a single attribute with specified ID.',
286+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.',
287287
summary: 'Gets attribute with specified ID.',
288288
tags: ['admin-attributes'],
289289
parameters: [

‎src/Identity/Controller/AdminAttributeValueController.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(
4949
)]
5050
#[OA\Post(
5151
path: '/administrators/attribute-values/{adminId}/{definitionId}',
52-
description: 'Returns created/updated admin attribute.',
52+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated admin attribute.',
5353
summary: 'Create/update an admin attribute.',
5454
requestBody: new OA\RequestBody(
5555
description: 'Pass parameters to create admin attribute.',
@@ -134,7 +134,7 @@ public function createOrUpdate(
134134
)]
135135
#[OA\Delete(
136136
path: '/administrators/attribute-values/{adminId}/{definitionId}',
137-
description: 'Deletes a single admin attribute.',
137+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute.',
138138
summary: 'Deletes an attribute.',
139139
tags: ['admin-attributes'],
140140
parameters: [
@@ -198,7 +198,7 @@ public function delete(
198198
#[Route('/{adminId}', name: 'get__list', requirements: ['adminId' => '\d+'], methods: ['GET'])]
199199
#[OA\Get(
200200
path: '/administrators/attribute-values/{adminId}',
201-
description: 'Returns a JSON list of all admin attributes.',
201+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attributes.',
202202
summary: 'Gets a list of all admin attributes.',
203203
tags: ['admin-attributes'],
204204
parameters: [
@@ -279,7 +279,7 @@ public function getPaginated(
279279
#[Route('/{adminId}/{definitionId}', name: 'get_one', methods: ['GET'])]
280280
#[OA\Get(
281281
path: '/administrators/attribute-values/{adminId}/{definitionId}',
282-
description: 'Returns a single attribute.',
282+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.',
283283
summary: 'Gets admin attribute.',
284284
tags: ['admin-attributes'],
285285
parameters: [

‎src/Identity/Controller/AdministratorController.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public function __construct(
4646
#[Route('', name: 'get_list', methods: ['GET'])]
4747
#[OA\Get(
4848
path: '/administrators',
49-
description: 'Get list of administrators.',
49+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Get list of administrators.',
5050
summary: 'Get Administrators',
5151
tags: ['administrators'],
5252
parameters: [
@@ -109,7 +109,7 @@ public function getAdministrators(Request $request): JsonResponse
109109
#[Route('', name: 'create', methods: ['POST'])]
110110
#[OA\Post(
111111
path: '/administrators',
112-
description: 'Create a new administrator.',
112+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Create a new administrator.',
113113
summary: 'Create Administrator',
114114
requestBody: new OA\RequestBody(
115115
description: 'Administrator data',
@@ -148,7 +148,7 @@ public function createAdministrator(
148148
#[Route('/{administratorId}', name: 'get_one', requirements: ['administratorId' => '\d+'], methods: ['GET'])]
149149
#[OA\Get(
150150
path: '/administrators/{administratorId}',
151-
description: 'Get administrator by ID.',
151+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Get administrator by ID.',
152152
summary: 'Get Administrator',
153153
tags: ['administrators'],
154154
parameters: [
@@ -189,7 +189,7 @@ public function getAdministrator(
189189
#[Route('/{administratorId}', name: 'update', requirements: ['administratorId' => '\d+'], methods: ['PUT'])]
190190
#[OA\Put(
191191
path: '/administrators/{administratorId}',
192-
description: 'Update an administrator.',
192+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Update an administrator.',
193193
summary: 'Update Administrator',
194194
requestBody: new OA\RequestBody(
195195
description: 'Administrator update data',
@@ -236,7 +236,7 @@ public function updateAdministrator(
236236
#[Route('/{administratorId}', name: 'delete', requirements: ['administratorId' => '\d+'], methods: ['DELETE'])]
237237
#[OA\Delete(
238238
path: '/administrators/{administratorId}',
239-
description: 'Delete an administrator.',
239+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete an administrator.',
240240
summary: 'Delete Administrator',
241241
tags: ['administrators'],
242242
parameters: [

‎src/Identity/Controller/SessionController.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function __construct(
4343
#[Route('', name: 'create', methods: ['POST'])]
4444
#[OA\Post(
4545
path: '/sessions',
46-
description: 'Given valid login data, this will generate a login token that will be valid for 1 hour.',
46+
description: '✅ **Status: Stable** – This method is stable and safe for production use. Given valid login data, this will generate a login token that will be valid for 1 hour.',
4747
summary: 'Log in or create new session.',
4848
requestBody: new OA\RequestBody(
4949
description: 'Pass session credentials',
@@ -111,7 +111,7 @@ public function createSession(
111111
#[Route('/{sessionId}', name: 'delete', requirements: ['sessionId' => '\d+'], methods: ['DELETE'])]
112112
#[OA\Delete(
113113
path: '/sessions/{sessionId}',
114-
description: 'Delete the session passed as a parameter.',
114+
description: '✅ **Status: Stable** – This method is stable and safe for production use. Delete the session passed as a parameter.',
115115
summary: 'Delete a session.',
116116
tags: ['sessions'],
117117
parameters: [

‎src/Messaging/Controller/CampaignController.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(
4949
#[Route('', name: 'get_list', methods: ['GET'])]
5050
#[OA\Get(
5151
path: '/campaigns',
52-
description: 'Returns a JSON list of all campaigns/messages.',
52+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all campaigns/messages.',
5353
summary: 'Gets a list of all campaigns.',
5454
tags: ['campaigns'],
5555
parameters: [
@@ -115,7 +115,7 @@ public function getMessages(Request $request): JsonResponse
115115
#[Route('/{messageId}', name: 'get_one', requirements: ['messageId' => '\d+'], methods: ['GET'])]
116116
#[OA\Get(
117117
path: '/campaigns/{messageId}',
118-
description: 'Returns campaign/message by id.',
118+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns campaign/message by id.',
119119
summary: 'Gets a campaign by id.',
120120
tags: ['campaigns'],
121121
parameters: [
@@ -165,7 +165,7 @@ public function getMessage(
165165
#[Route('', name: 'create', methods: ['POST'])]
166166
#[OA\Post(
167167
path: '/campaigns',
168-
description: 'Returns created message.',
168+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created message.',
169169
summary: 'Create a message for campaign.',
170170
requestBody: new OA\RequestBody(
171171
description: 'Create a new message.',
@@ -227,7 +227,7 @@ public function createMessage(Request $request, MessageNormalizer $normalizer):
227227
#[Route('/{messageId}', name: 'update', requirements: ['messageId' => '\d+'], methods: ['PUT'])]
228228
#[OA\Put(
229229
path: '/campaigns/{messageId}',
230-
description: 'Updates campaign/message by id.',
230+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message by id.',
231231
summary: 'Update campaign by id.',
232232
requestBody: new OA\RequestBody(
233233
description: 'Update message.',
@@ -300,7 +300,7 @@ public function updateMessage(
300300
#[Route('/{messageId}', name: 'delete', requirements: ['messageId' => '\d+'], methods: ['DELETE'])]
301301
#[OA\Delete(
302302
path: '/campaigns/{messageId}',
303-
description: 'Delete campaign/message by id.',
303+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete campaign/message by id.',
304304
summary: 'Delete campaign by id.',
305305
tags: ['campaigns'],
306306
parameters: [

‎src/Messaging/Controller/TemplateController.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public function __construct(
4747
#[Route('', name: 'get_list', methods: ['GET'])]
4848
#[OA\Get(
4949
path: '/templates',
50-
description: 'Returns a JSON list of all templates.',
50+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all templates.',
5151
summary: 'Gets a list of all templates.',
5252
tags: ['templates'],
5353
parameters: [
@@ -115,7 +115,7 @@ public function getTemplates(Request $request): JsonResponse
115115
#[Route('/{templateId}', name: 'get_one', requirements: ['templateId' => '\d+'], methods: ['GET'])]
116116
#[OA\Get(
117117
path: '/templates/{templateId}',
118-
description: 'Returns template by id.',
118+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns template by id.',
119119
summary: 'Gets a templateI by id.',
120120
tags: ['templates'],
121121
parameters: [
@@ -170,7 +170,7 @@ public function getTemplate(
170170
#[Route('', name: 'create', methods: ['POST'])]
171171
#[OA\Post(
172172
path: '/templates',
173-
description: 'Returns a JSON response of created template.',
173+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON response of created template.',
174174
summary: 'Create a new template.',
175175
requestBody: new OA\RequestBody(
176176
description: 'Pass session credentials',
@@ -273,7 +273,7 @@ public function createTemplates(Request $request): JsonResponse
273273
#[Route('/{templateId}', name: 'delete', requirements: ['templateId' => '\d+'], methods: ['DELETE'])]
274274
#[OA\Delete(
275275
path: '/templates/{templateId}',
276-
description: 'Deletes template by id.',
276+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes template by id.',
277277
summary: 'Deletes a template.',
278278
tags: ['templates'],
279279
parameters: [

‎src/Subscription/Controller/ListMembersController.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function __construct(
3939
#[Route('/{listId}/subscribers', name: 'get_list', requirements: ['listId' => '\d+'], methods: ['GET'])]
4040
#[OA\Get(
4141
path: '/lists/{listId}/subscribers',
42-
description: 'Returns a JSON list of all subscribers for a subscriber list.',
42+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. 🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscribers for a subscriber list.',
4343
summary: 'Gets a list of all subscribers of a subscriber list.',
4444
tags: ['subscriptions'],
4545
parameters: [
@@ -124,7 +124,7 @@ public function getListMembers(
124124
#[Route('/{listId}/subscribers/count', name: 'get_count', requirements: ['listId' => '\d+'], methods: ['GET'])]
125125
#[OA\Get(
126126
path: '/lists/{listId}/count',
127-
description: 'Returns a count of all subscribers in a given list.',
127+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. 🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a count of all subscribers in a given list.',
128128
summary: 'Gets the total number of subscribers of a list',
129129
tags: ['subscriptions'],
130130
parameters: [

‎src/Subscription/Controller/SubscriberAttributeDefinitionController.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function __construct(
4343
#[Route('', name: 'create', methods: ['POST'])]
4444
#[OA\Post(
4545
path: '/subscriber/attributes',
46-
description: 'Returns created subscriber attribute definition.',
46+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created subscriber attribute definition.',
4747
summary: 'Create a subscriber attribute definition.',
4848
requestBody: new OA\RequestBody(
4949
description: 'Pass parameters to create subscriber attribute.',
@@ -96,7 +96,7 @@ public function create(Request $request): JsonResponse
9696
#[Route('/{definitionId}', name: 'update', requirements: ['definitionId' => '\d+'], methods: ['PUT'])]
9797
#[OA\Put(
9898
path: '/subscriber/attributes/{definitionId}',
99-
description: 'Returns updated subscriber attribute definition.',
99+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated subscriber attribute definition.',
100100
summary: 'Update a subscriber attribute definition.',
101101
requestBody: new OA\RequestBody(
102102
description: 'Pass parameters to update subscriber attribute.',
@@ -162,7 +162,7 @@ public function update(
162162
#[Route('/{definitionId}', name: 'delete', requirements: ['definitionId' => '\d+'], methods: ['DELETE'])]
163163
#[OA\Delete(
164164
path: '/subscriber/attributes/{definitionId}',
165-
description: 'Deletes a single subscriber attribute definition.',
165+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute definition.',
166166
summary: 'Deletes an attribute definition.',
167167
tags: ['subscriber-attributes'],
168168
parameters: [
@@ -215,7 +215,7 @@ public function delete(
215215
#[Route('', name: 'get_list', methods: ['GET'])]
216216
#[OA\Get(
217217
path: '/subscriber/attributes',
218-
description: 'Returns a JSON list of all subscriber attribute definitions.',
218+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attribute definitions.',
219219
summary: 'Gets a list of all subscriber attribute definitions.',
220220
tags: ['subscriber-attributes'],
221221
parameters: [
@@ -283,7 +283,7 @@ public function getPaginated(Request $request): JsonResponse
283283
#[Route('/{definitionId}', name: 'get_one', requirements: ['definitionId' => '\d+'], methods: ['GET'])]
284284
#[OA\Get(
285285
path: '/subscriber/attributes/{definitionId}',
286-
description: 'Returns a single attribute with specified ID.',
286+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.',
287287
summary: 'Gets attribute with specified ID.',
288288
tags: ['subscriber-attributes'],
289289
parameters: [

‎src/Subscription/Controller/SubscriberAttributeValueController.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(
4949
)]
5050
#[OA\Post(
5151
path: '/subscriber/attribute-values/{subscriberId}/{definitionId}',
52-
description: 'Returns created/updated subscriber attribute.',
52+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated subscriber attribute.',
5353
summary: 'Create/update a subscriber attribute.',
5454
requestBody: new OA\RequestBody(
5555
description: 'Pass parameters to create subscriber attribute.',
@@ -134,7 +134,7 @@ public function createOrUpdate(
134134
)]
135135
#[OA\Delete(
136136
path: '/subscriber/attribute-values/{subscriberId}/{definitionId}',
137-
description: 'Deletes a single subscriber attribute.',
137+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute.',
138138
summary: 'Deletes an attribute.',
139139
tags: ['subscriber-attributes'],
140140
parameters: [
@@ -198,7 +198,7 @@ public function delete(
198198
#[Route('/{subscriberId}', name: 'get_list', requirements: ['subscriberId' => '\d+'], methods: ['GET'])]
199199
#[OA\Get(
200200
path: '/subscribers/attribute-values/{subscriberId}',
201-
description: 'Returns a JSON list of all subscriber attributes.',
201+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attributes.',
202202
summary: 'Gets a list of all subscriber attributes.',
203203
tags: ['subscriber-attributes'],
204204
parameters: [
@@ -281,7 +281,7 @@ public function getPaginated(
281281
)]
282282
#[OA\Get(
283283
path: '/subscribers/attribute-values/{subscriberId}/{definitionId}',
284-
description: 'Returns a single attribute.',
284+
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.',
285285
summary: 'Gets subscriber attribute.',
286286
tags: ['subscriber-attributes'],
287287
parameters: [

0 commit comments

Comments
 (0)