88
99namespace OCA \Polls \Controller ;
1010
11- use OCA \Polls \ResponseDefinitions as ResponseDefinitions ;
1211use OCA \Polls \Service \CommentService ;
1312use OCA \Polls \Service \OptionService ;
1413use OCA \Polls \Service \PollService ;
2423
2524/**
2625 * @psalm-api
27- * @psalm-import-type PollsPoll from ResponseDefinitions
26+ * @psalm-import-type PollsPoll from \OCA\Polls\ ResponseDefinitions
2827 * */
2928class PollApiController extends BaseApiV2Controller {
3029 public function __construct (
@@ -46,7 +45,7 @@ public function __construct(
4645 #[CORS ]
4746 #[NoAdminRequired]
4847 #[NoCSRFRequired]
49- #[ApiRoute(verb: 'GET ' , url: '/api/{apiVersion} /polls ' , requirements: ['apiVersion ' => '(v2) ' ])]
48+ #[ApiRoute(verb: 'GET ' , url: '/api/v1.0 /polls ' , requirements: ['apiVersion ' => '(v2) ' ])]
5049 public function list (): DataResponse {
5150 return $ this ->response (fn () => ['polls ' => $ this ->pollService ->list ()]);
5251 }
@@ -58,7 +57,7 @@ public function list(): DataResponse {
5857 #[CORS ]
5958 #[NoAdminRequired]
6059 #[NoCSRFRequired]
61- #[ApiRoute(verb: 'GET ' , url: '/api/{apiVersion} /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
60+ #[ApiRoute(verb: 'GET ' , url: '/api/v1.0 /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
6261 public function get (int $ pollId ): DataResponse {
6362 return $ this ->response (fn () => [
6463 'poll ' => $ this ->pollService ->get ($ pollId ),
@@ -78,7 +77,7 @@ public function get(int $pollId): DataResponse {
7877 #[CORS ]
7978 #[NoAdminRequired]
8079 #[NoCSRFRequired]
81- #[ApiRoute(verb: 'POST ' , url: '/api/{apiVersion} /poll ' , requirements: ['apiVersion ' => '(v2) ' ])]
80+ #[ApiRoute(verb: 'POST ' , url: '/api/v1.0 /poll ' , requirements: ['apiVersion ' => '(v2) ' ])]
8281 public function add (string $ type , string $ title ): DataResponse {
8382 return $ this ->responseCreate (fn () => ['poll ' => $ this ->pollService ->add ($ type , $ title )]);
8483 }
@@ -91,7 +90,7 @@ public function add(string $type, string $title): DataResponse {
9190 #[CORS ]
9291 #[NoAdminRequired]
9392 #[NoCSRFRequired]
94- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
93+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
9594 public function update (int $ pollId , array $ pollConfiguration ): DataResponse {
9695 return $ this ->response (fn () => ['poll ' => $ this ->pollService ->update ($ pollId , $ pollConfiguration )]);
9796 }
@@ -103,7 +102,7 @@ public function update(int $pollId, array $pollConfiguration): DataResponse {
103102 #[CORS ]
104103 #[NoAdminRequired]
105104 #[NoCSRFRequired]
106- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/{pollId}/archive/toggle ' , requirements: ['apiVersion ' => '(v2) ' ])]
105+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/{pollId}/archive/toggle ' , requirements: ['apiVersion ' => '(v2) ' ])]
107106 public function toggleArchive (int $ pollId ): DataResponse {
108107 return $ this ->response (fn () => ['poll ' => $ this ->pollService ->toggleArchive ($ pollId )]);
109108 }
@@ -115,7 +114,7 @@ public function toggleArchive(int $pollId): DataResponse {
115114 #[CORS ]
116115 #[NoAdminRequired]
117116 #[NoCSRFRequired]
118- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/{pollId}/close ' , requirements: ['apiVersion ' => '(v2) ' ])]
117+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/{pollId}/close ' , requirements: ['apiVersion ' => '(v2) ' ])]
119118 public function close (int $ pollId ): DataResponse {
120119 return $ this ->response (fn () => ['poll ' => $ this ->pollService ->close ($ pollId )]);
121120 }
@@ -127,7 +126,7 @@ public function close(int $pollId): DataResponse {
127126 #[CORS ]
128127 #[NoAdminRequired]
129128 #[NoCSRFRequired]
130- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/{pollId}/reopen ' , requirements: ['apiVersion ' => '(v2) ' ])]
129+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/{pollId}/reopen ' , requirements: ['apiVersion ' => '(v2) ' ])]
131130 public function reopen (int $ pollId ): DataResponse {
132131 return $ this ->response (fn () => ['poll ' => $ this ->pollService ->reopen ($ pollId )]);
133132 }
@@ -139,7 +138,7 @@ public function reopen(int $pollId): DataResponse {
139138 #[CORS ]
140139 #[NoAdminRequired]
141140 #[NoCSRFRequired]
142- #[ApiRoute(verb: 'DELETE ' , url: '/api/{apiVersion} /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
141+ #[ApiRoute(verb: 'DELETE ' , url: '/api/v1.0 /poll/{pollId} ' , requirements: ['apiVersion ' => '(v2) ' ])]
143142 public function delete (int $ pollId ): DataResponse {
144143 return $ this ->response (fn () => ['poll ' => $ this ->pollService ->delete ($ pollId )]);
145144 }
@@ -151,7 +150,7 @@ public function delete(int $pollId): DataResponse {
151150 #[CORS ]
152151 #[NoAdminRequired]
153152 #[NoCSRFRequired]
154- #[ApiRoute(verb: 'POST ' , url: '/api/{apiVersion} /poll/{pollId}/clone ' , requirements: ['apiVersion ' => '(v2) ' ])]
153+ #[ApiRoute(verb: 'POST ' , url: '/api/v1.0 /poll/{pollId}/clone ' , requirements: ['apiVersion ' => '(v2) ' ])]
155154 public function clone (int $ pollId ): DataResponse {
156155 return $ this ->responseCreate (fn () => ['poll ' => $ this ->pollService ->clone ($ pollId )]);
157156 }
@@ -163,19 +162,19 @@ public function clone(int $pollId): DataResponse {
163162 */
164163 #[CORS ]
165164 #[NoCSRFRequired]
166- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/transfer/{sourceUser}/{targetUser} ' , requirements: ['apiVersion ' => '(v2) ' ])]
165+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/transfer/{sourceUser}/{targetUser} ' , requirements: ['apiVersion ' => '(v2) ' ])]
167166 public function transferPolls (string $ sourceUser , string $ targetUser ): DataResponse {
168167 return $ this ->response (fn () => ['transferred ' => $ this ->pollService ->transferPolls ($ sourceUser , $ targetUser )]);
169168 }
170169
171170 /**
172- * Transfer singe poll to another user (change owner of poll)
171+ * Transfer single poll to another user (change owner of poll)
173172 * @param int $pollId Poll to transfer
174173 * @param string $targetUser User to transfer the poll to
175174 */
176175 #[CORS ]
177176 #[NoCSRFRequired]
178- #[ApiRoute(verb: 'PUT ' , url: '/api/{apiVersion} /poll/{pollId}/transfer/{targetUser} ' , requirements: ['apiVersion ' => '(v2) ' ])]
177+ #[ApiRoute(verb: 'PUT ' , url: '/api/v1.0 /poll/{pollId}/transfer/{targetUser} ' , requirements: ['apiVersion ' => '(v2) ' ])]
179178 public function transferPoll (int $ pollId , string $ targetUser ): DataResponse {
180179 return $ this ->response (fn () => ['transferred ' => $ this ->pollService ->transferPoll ($ pollId , $ targetUser )]);
181180 }
@@ -187,7 +186,7 @@ public function transferPoll(int $pollId, string $targetUser): DataResponse {
187186 #[CORS ]
188187 #[NoAdminRequired]
189188 #[NoCSRFRequired]
190- #[ApiRoute(verb: 'GET ' , url: '/api/{apiVersion} /poll/{pollId}/addresses ' , requirements: ['apiVersion ' => '(v2) ' ])]
189+ #[ApiRoute(verb: 'GET ' , url: '/api/v1.0 /poll/{pollId}/addresses ' , requirements: ['apiVersion ' => '(v2) ' ])]
191190 public function getParticipantsEmailAddresses (int $ pollId ): DataResponse {
192191 return $ this ->response (fn () => ['addresses ' => $ this ->pollService ->getParticipantsEmailAddresses ($ pollId )]);
193192 }
@@ -198,7 +197,7 @@ public function getParticipantsEmailAddresses(int $pollId): DataResponse {
198197 #[CORS ]
199198 #[NoAdminRequired]
200199 #[NoCSRFRequired]
201- #[ApiRoute(verb: 'GET ' , url: '/api/{apiVersion}/poll /enum ' , requirements: ['apiVersion ' => '(v2) ' ])]
200+ #[ApiRoute(verb: 'GET ' , url: '/api/v1.0 /enum ' , requirements: ['apiVersion ' => '(v2) ' ])]
202201 public function enum (): DataResponse {
203202 return $ this ->response (fn () => ['enum ' => $ this ->pollService ->getValidEnum ()]);
204203 }
0 commit comments