diff options
author | Joas Schilling <coding@schilljs.com> | 2022-02-15 17:26:36 +0100 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2022-02-15 17:26:36 +0100 |
commit | c31d49b99611a3093bb639798dc9ade2c744343f (patch) | |
tree | a014ec3b1ec95811193dcb6db9baacde0ffab5cb | |
parent | 213d9ea9621133167a63f87f4fb7b784c1321090 (diff) |
Add see-links to route files
Signed-off-by: Joas Schilling <coding@schilljs.com>
-rw-r--r-- | appinfo/routes/routesRoomController.php | 31 | ||||
-rw-r--r-- | appinfo/routes/routesSettingsController.php | 2 | ||||
-rw-r--r-- | appinfo/routes/routesSignalingController.php | 5 | ||||
-rw-r--r-- | appinfo/routes/routesTempAvatarController.php | 2 |
4 files changed, 40 insertions, 0 deletions
diff --git a/appinfo/routes/routesRoomController.php b/appinfo/routes/routesRoomController.php index 5f1d9aaf6..e065a39bc 100644 --- a/appinfo/routes/routesRoomController.php +++ b/appinfo/routes/routesRoomController.php @@ -34,40 +34,71 @@ $requirementsWithToken = [ return [ 'ocs' => [ + /** @see \OCA\Talk\Controller\RoomController::getRooms() */ ['name' => 'Room#getRooms', 'url' => '/api/{apiVersion}/room', 'verb' => 'GET', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\RoomController::getListedRooms() */ ['name' => 'Room#getListedRooms', 'url' => '/api/{apiVersion}/listed-room', 'verb' => 'GET', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\RoomController::createRoom() */ ['name' => 'Room#createRoom', 'url' => '/api/{apiVersion}/room', 'verb' => 'POST', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\RoomController::getSingleRoom() */ ['name' => 'Room#getSingleRoom', 'url' => '/api/{apiVersion}/room/{token}', 'verb' => 'GET', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::renameRoom() */ ['name' => 'Room#renameRoom', 'url' => '/api/{apiVersion}/room/{token}', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::deleteRoom() */ ['name' => 'Room#deleteRoom', 'url' => '/api/{apiVersion}/room/{token}', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::makePublic() */ ['name' => 'Room#makePublic', 'url' => '/api/{apiVersion}/room/{token}/public', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::makePrivate() */ ['name' => 'Room#makePrivate', 'url' => '/api/{apiVersion}/room/{token}/public', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setDescription() */ ['name' => 'Room#setDescription', 'url' => '/api/{apiVersion}/room/{token}/description', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setReadOnly() */ ['name' => 'Room#setReadOnly', 'url' => '/api/{apiVersion}/room/{token}/read-only', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setListable() */ ['name' => 'Room#setListable', 'url' => '/api/{apiVersion}/room/{token}/listable', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setPassword() */ ['name' => 'Room#setPassword', 'url' => '/api/{apiVersion}/room/{token}/password', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setPermissions() */ ['name' => 'Room#setPermissions', 'url' => '/api/{apiVersion}/room/{token}/permissions/{mode}', 'verb' => 'PUT', 'requirements' => array_merge($requirementsWithToken, [ 'mode' => '^(call|default)$', ])], + /** @see \OCA\Talk\Controller\RoomController::getParticipants() */ ['name' => 'Room#getParticipants', 'url' => '/api/{apiVersion}/room/{token}/participants', 'verb' => 'GET', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::addParticipantToRoom() */ ['name' => 'Room#addParticipantToRoom', 'url' => '/api/{apiVersion}/room/{token}/participants', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::removeSelfFromRoom() */ ['name' => 'Room#removeSelfFromRoom', 'url' => '/api/{apiVersion}/room/{token}/participants/self', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::removeAttendeeFromRoom() */ ['name' => 'Room#removeAttendeeFromRoom', 'url' => '/api/{apiVersion}/room/{token}/attendees', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setAttendeePermissions() */ ['name' => 'Room#setAttendeePermissions', 'url' => '/api/{apiVersion}/room/{token}/attendees/permissions', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setAllAttendeesPermissions() */ ['name' => 'Room#setAllAttendeesPermissions', 'url' => '/api/{apiVersion}/room/{token}/attendees/permissions/all', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::joinRoom() */ ['name' => 'Room#joinRoom', 'url' => '/api/{apiVersion}/room/{token}/participants/active', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::resendInvitations() */ ['name' => 'Room#resendInvitations', 'url' => '/api/{apiVersion}/room/{token}/participants/resend-invitations', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::leaveRoom() */ ['name' => 'Room#leaveRoom', 'url' => '/api/{apiVersion}/room/{token}/participants/active', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::promoteModerator() */ ['name' => 'Room#promoteModerator', 'url' => '/api/{apiVersion}/room/{token}/moderators', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::demoteModerator() */ ['name' => 'Room#demoteModerator', 'url' => '/api/{apiVersion}/room/{token}/moderators', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::addToFavorites() */ ['name' => 'Room#addToFavorites', 'url' => '/api/{apiVersion}/room/{token}/favorite', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::removeFromFavorites() */ ['name' => 'Room#removeFromFavorites', 'url' => '/api/{apiVersion}/room/{token}/favorite', 'verb' => 'DELETE', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::getParticipantByDialInPin() */ ['name' => 'Room#getParticipantByDialInPin', 'url' => '/api/{apiVersion}/room/{token}/pin/{pin}', 'verb' => 'GET', 'requirements' => array_merge($requirementsWithToken, [ 'pin' => '^\d{7,32}$', ])], + /** @see \OCA\Talk\Controller\RoomController::setNotificationLevel() */ ['name' => 'Room#setNotificationLevel', 'url' => '/api/{apiVersion}/room/{token}/notify', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setNotificationCalls() */ ['name' => 'Room#setNotificationCalls', 'url' => '/api/{apiVersion}/room/{token}/notify-calls', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setLobby() */ ['name' => 'Room#setLobby', 'url' => '/api/{apiVersion}/room/{token}/webinar/lobby', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\RoomController::setSIPEnabled() */ ['name' => 'Room#setSIPEnabled', 'url' => '/api/{apiVersion}/room/{token}/webinar/sip', 'verb' => 'PUT', 'requirements' => $requirementsWithToken], ], ]; diff --git a/appinfo/routes/routesSettingsController.php b/appinfo/routes/routesSettingsController.php index 6829ebea3..c7ced9329 100644 --- a/appinfo/routes/routesSettingsController.php +++ b/appinfo/routes/routesSettingsController.php @@ -29,7 +29,9 @@ $requirements = [ return [ 'ocs' => [ + /** @see \OCA\Talk\Controller\SettingsController::setSIPSettings() */ ['name' => 'Settings#setSIPSettings', 'url' => '/api/{apiVersion}/settings/sip', 'verb' => 'POST', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\SettingsController::setUserSetting() */ ['name' => 'Settings#setUserSetting', 'url' => '/api/{apiVersion}/settings/user', 'verb' => 'POST', 'requirements' => $requirements], ], ]; diff --git a/appinfo/routes/routesSignalingController.php b/appinfo/routes/routesSignalingController.php index 48f404867..0078c90c2 100644 --- a/appinfo/routes/routesSignalingController.php +++ b/appinfo/routes/routesSignalingController.php @@ -35,12 +35,17 @@ $requirementsWithToken = [ return [ 'ocs' => [ + /** @see \OCA\Talk\Controller\SignalingController::getSettings() */ ['name' => 'Signaling#getSettings', 'url' => '/api/{apiVersion}/signaling/settings', 'verb' => 'GET', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\SignalingController::getWelcomeMessage() */ ['name' => 'Signaling#getWelcomeMessage', 'url' => '/api/{apiVersion}/signaling/welcome/{serverId}', 'verb' => 'GET', 'requirements' => array_merge($requirements, [ 'serverId' => '^\d+$', ])], + /** @see \OCA\Talk\Controller\SignalingController::backend() */ ['name' => 'Signaling#backend', 'url' => '/api/{apiVersion}/signaling/backend', 'verb' => 'POST', 'requirements' => $requirements], + /** @see \OCA\Talk\Controller\SignalingController::signaling() */ ['name' => 'Signaling#signaling', 'url' => '/api/{apiVersion}/signaling/{token}', 'verb' => 'POST', 'requirements' => $requirementsWithToken], + /** @see \OCA\Talk\Controller\SignalingController::pullMessages() */ ['name' => 'Signaling#pullMessages', 'url' => '/api/{apiVersion}/signaling/{token}', 'verb' => 'GET', 'requirements' => $requirementsWithToken], ], ]; diff --git a/appinfo/routes/routesTempAvatarController.php b/appinfo/routes/routesTempAvatarController.php index 17e3e9694..d06d0e95b 100644 --- a/appinfo/routes/routesTempAvatarController.php +++ b/appinfo/routes/routesTempAvatarController.php @@ -25,7 +25,9 @@ declare(strict_types=1); return [ 'ocs' => [ + /** @see \OCA\Talk\Controller\TempAvatarController::postAvatar() */ ['name' => 'TempAvatar#postAvatar', 'url' => '/temp-user-avatar', 'verb' => 'POST'], + /** @see \OCA\Talk\Controller\TempAvatarController::deleteAvatar() */ ['name' => 'TempAvatar#deleteAvatar', 'url' => '/temp-user-avatar', 'verb' => 'DELETE'], ], ]; |