diff options
Diffstat (limited to 'apps')
34 files changed, 182 insertions, 106 deletions
diff --git a/apps/dashboard/lib/Controller/DashboardApiController.php b/apps/dashboard/lib/Controller/DashboardApiController.php index e50ab974dfc..e62c21bcc4a 100644 --- a/apps/dashboard/lib/Controller/DashboardApiController.php +++ b/apps/dashboard/lib/Controller/DashboardApiController.php @@ -104,6 +104,8 @@ class DashboardApiController extends OCSController { * @param int $limit Limit number of result items per widget * @param string[] $widgets Limit results to specific widgets * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItem[]>, array{}> + * + * 200: Widget items returned */ public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse { $items = []; @@ -129,6 +131,8 @@ class DashboardApiController extends OCSController { * @param int $limit Limit number of result items per widget * @param string[] $widgets Limit results to specific widgets * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}> + * + * 200: Widget items returned */ public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse { $items = []; @@ -151,6 +155,8 @@ class DashboardApiController extends OCSController { * @NoCSRFRequired * * @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}> + * + * 200: Widgets returned */ public function getWidgets(): DataResponse { $widgets = $this->dashboardManager->getWidgets(); diff --git a/apps/dashboard/openapi.json b/apps/dashboard/openapi.json index b771b952b33..ba643d965e5 100644 --- a/apps/dashboard/openapi.json +++ b/apps/dashboard/openapi.json @@ -200,7 +200,7 @@ ], "responses": { "200": { - "description": "", + "description": "Widgets returned", "content": { "application/json": { "schema": { @@ -293,7 +293,7 @@ ], "responses": { "200": { - "description": "", + "description": "Widget items returned", "content": { "application/json": { "schema": { @@ -389,7 +389,7 @@ ], "responses": { "200": { - "description": "", + "description": "Widget items returned", "content": { "application/json": { "schema": { diff --git a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php index 59e46af37cd..1f1334e7aee 100644 --- a/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php +++ b/apps/federatedfilesharing/lib/Controller/RequestHandlerController.php @@ -134,6 +134,8 @@ class RequestHandlerController extends OCSController { * @param string|null $ownerFederatedId Federated ID of the receiver * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Share created successfully */ public function createShare( ?string $remote = null, @@ -284,6 +286,8 @@ class RequestHandlerController extends OCSController { * @param string|null $token Shared secret between servers * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Share declined successfully */ public function declineShare(int $id, ?string $token = null) { $notification = [ @@ -316,6 +320,8 @@ class RequestHandlerController extends OCSController { * @param string|null $token Shared secret between servers * @return Http\DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Share unshared successfully */ public function unshare(int $id, ?string $token = null) { if (!$this->isS2SEnabled()) { diff --git a/apps/federatedfilesharing/openapi.json b/apps/federatedfilesharing/openapi.json index 0bbe535cc2a..2a8d5cbfed6 100644 --- a/apps/federatedfilesharing/openapi.json +++ b/apps/federatedfilesharing/openapi.json @@ -243,7 +243,7 @@ ], "responses": { "200": { - "description": "", + "description": "Share created successfully", "content": { "application/json": { "schema": { @@ -629,7 +629,7 @@ ], "responses": { "200": { - "description": "", + "description": "Share declined successfully", "content": { "application/json": { "schema": { @@ -707,7 +707,7 @@ ], "responses": { "200": { - "description": "", + "description": "Share unshared successfully", "content": { "application/json": { "schema": { diff --git a/apps/files/lib/Controller/ApiController.php b/apps/files/lib/Controller/ApiController.php index bee6fb26d9e..6e64d68588f 100644 --- a/apps/files/lib/Controller/ApiController.php +++ b/apps/files/lib/Controller/ApiController.php @@ -43,6 +43,7 @@ use OCA\Files\Service\UserConfig; use OCA\Files\Service\ViewConfig; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; +use OCP\AppFramework\Http\Attribute\IgnoreOpenAPI; use OCP\AppFramework\Http\ContentSecurityPolicy; use OCP\AppFramework\Http\DataResponse; use OCP\AppFramework\Http\FileDisplayResponse; @@ -389,13 +390,8 @@ class ApiController extends Controller { * @NoAdminRequired * @NoCSRFRequired * @PublicPage - * - * Get the service-worker Javascript for previews - * - * @psalm-suppress MoreSpecificReturnType The value of Service-Worker-Allowed is not relevant - * @psalm-suppress LessSpecificReturnStatement The value of Service-Worker-Allowed is not relevant - * @return StreamResponse<Http::STATUS_OK, array{Content-Type: 'application/javascript', Service-Worker-Allowed: string}> */ + #[IgnoreOpenAPI] public function serviceWorker(): StreamResponse { $response = new StreamResponse(__DIR__ . '/../../../../dist/preview-service-worker.js'); $response->setHeaders([ diff --git a/apps/files/lib/Controller/DirectEditingController.php b/apps/files/lib/Controller/DirectEditingController.php index 5cc98e7ff1d..a4b83af3c29 100644 --- a/apps/files/lib/Controller/DirectEditingController.php +++ b/apps/files/lib/Controller/DirectEditingController.php @@ -55,6 +55,8 @@ class DirectEditingController extends OCSController { * * Get the direct editing capabilities * @return DataResponse<Http::STATUS_OK, array{editors: array<string, array{id: string, name: string, mimetypes: string[], optionalMimetypes: string[], secure: bool}>, creators: array<string, array{id: string, editor: string, name: string, extension: string, templates: bool, mimetypes: string[]}>}, array{}> + * + * 200: Direct editing capabilities returned */ public function info(): DataResponse { $response = new DataResponse($this->directEditingService->getDirectEditingCapabilitites()); diff --git a/apps/files/lib/Controller/TemplateController.php b/apps/files/lib/Controller/TemplateController.php index 645350010ec..1b5873e8fe6 100644 --- a/apps/files/lib/Controller/TemplateController.php +++ b/apps/files/lib/Controller/TemplateController.php @@ -55,6 +55,8 @@ class TemplateController extends OCSController { * List the available templates * * @return DataResponse<Http::STATUS_OK, array<FilesTemplateFileCreator>, array{}> + * + * 200: Available templates returned */ public function list(): DataResponse { return new DataResponse($this->templateManager->listTemplates()); diff --git a/apps/files/openapi.json b/apps/files/openapi.json index c3bd9d58bf9..ea177af8b4f 100644 --- a/apps/files/openapi.json +++ b/apps/files/openapi.json @@ -332,44 +332,6 @@ } } }, - "/index.php/apps/files/preview-service-worker.js": { - "get": { - "operationId": "api-service-worker", - "summary": "Get the service-worker Javascript for previews", - "tags": [ - "api" - ], - "security": [ - {}, - { - "bearer_auth": [] - }, - { - "basic_auth": [] - } - ], - "responses": { - "200": { - "description": "", - "headers": { - "Service-Worker-Allowed": { - "schema": { - "type": "string" - } - } - }, - "content": { - "application/javascript": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, "/ocs/v2.php/apps/files/api/v1/directEditing": { "get": { "operationId": "direct_editing-info", @@ -398,7 +360,7 @@ ], "responses": { "200": { - "description": "", + "description": "Direct editing capabilities returned", "content": { "application/json": { "schema": { @@ -1041,7 +1003,7 @@ ], "responses": { "200": { - "description": "", + "description": "Available templates returned", "content": { "application/json": { "schema": { diff --git a/apps/files_external/lib/Controller/ApiController.php b/apps/files_external/lib/Controller/ApiController.php index fbab967e786..5a62a19e3cb 100644 --- a/apps/files_external/lib/Controller/ApiController.php +++ b/apps/files_external/lib/Controller/ApiController.php @@ -101,6 +101,8 @@ class ApiController extends OCSController { * Get the mount points visible for this user * * @return DataResponse<Http::STATUS_OK, FilesExternalMount[], array{}> + * + * 200: User mounts returned */ public function getUserMounts(): DataResponse { $entries = []; diff --git a/apps/files_external/openapi.json b/apps/files_external/openapi.json index f6ab4bc2a80..4b5a2897e58 100644 --- a/apps/files_external/openapi.json +++ b/apps/files_external/openapi.json @@ -198,7 +198,7 @@ ], "responses": { "200": { - "description": "", + "description": "User mounts returned", "content": { "application/json": { "schema": { diff --git a/apps/files_sharing/lib/Controller/DeletedShareAPIController.php b/apps/files_sharing/lib/Controller/DeletedShareAPIController.php index ddd3816022e..47ff271c926 100644 --- a/apps/files_sharing/lib/Controller/DeletedShareAPIController.php +++ b/apps/files_sharing/lib/Controller/DeletedShareAPIController.php @@ -188,6 +188,8 @@ class DeletedShareAPIController extends OCSController { * Get a list of all deleted shares * * @return DataResponse<Http::STATUS_OK, FilesSharingDeletedShare[], array{}> + * + * 200: Deleted shares returned */ public function index(): DataResponse { $groupShares = $this->shareManager->getDeletedSharedWith($this->userId, IShare::TYPE_GROUP, null, -1, 0); diff --git a/apps/files_sharing/lib/Controller/RemoteController.php b/apps/files_sharing/lib/Controller/RemoteController.php index 70cb55cae15..bb8933e8426 100644 --- a/apps/files_sharing/lib/Controller/RemoteController.php +++ b/apps/files_sharing/lib/Controller/RemoteController.php @@ -62,6 +62,8 @@ class RemoteController extends OCSController { * Get list of pending remote shares * * @return DataResponse<Http::STATUS_OK, FilesSharingRemoteShare[], array{}> + * + * 200: Pending remote shares returned */ public function getOpenShares() { return new DataResponse($this->externalManager->getOpenShares()); @@ -138,6 +140,8 @@ class RemoteController extends OCSController { * Get a list of accepted remote shares * * @return DataResponse<Http::STATUS_OK, FilesSharingRemoteShare[], array{}> + * + * 200: Accepted remote shares returned */ public function getShares() { $shares = $this->externalManager->getAcceptedShares(); diff --git a/apps/files_sharing/lib/Controller/ShareAPIController.php b/apps/files_sharing/lib/Controller/ShareAPIController.php index b2a2e774766..ebf0038dda2 100644 --- a/apps/files_sharing/lib/Controller/ShareAPIController.php +++ b/apps/files_sharing/lib/Controller/ShareAPIController.php @@ -1410,6 +1410,8 @@ class ShareAPIController extends OCSController { * Get all shares that are still pending * * @return DataResponse<Http::STATUS_OK, FilesSharingShare[], array{}> + * + * 200: Pending shares returned */ public function pendingShares(): DataResponse { $pendingShares = []; diff --git a/apps/files_sharing/lib/Controller/ShareesAPIController.php b/apps/files_sharing/lib/Controller/ShareesAPIController.php index a9288be9386..76787a26f10 100644 --- a/apps/files_sharing/lib/Controller/ShareesAPIController.php +++ b/apps/files_sharing/lib/Controller/ShareesAPIController.php @@ -348,6 +348,8 @@ class ShareesAPIController extends OCSController { * @param string $itemType Limit to specific item types * @param int|int[]|null $shareType Limit to specific share types * @return DataResponse<Http::STATUS_OK, FilesSharingShareesRecommendedResult, array{}> + * + * 200: Recommended sharees returned */ public function findRecommended(string $itemType, $shareType = null): DataResponse { $shareTypes = [ diff --git a/apps/files_sharing/openapi.json b/apps/files_sharing/openapi.json index 9400f704857..765fcc28c99 100644 --- a/apps/files_sharing/openapi.json +++ b/apps/files_sharing/openapi.json @@ -2107,7 +2107,7 @@ ], "responses": { "200": { - "description": "", + "description": "Pending shares returned", "content": { "application/json": { "schema": { @@ -2609,7 +2609,7 @@ ], "responses": { "200": { - "description": "", + "description": "Deleted shares returned", "content": { "application/json": { "schema": { @@ -2900,7 +2900,7 @@ ], "responses": { "200": { - "description": "", + "description": "Recommended sharees returned", "content": { "application/json": { "schema": { @@ -2960,7 +2960,7 @@ ], "responses": { "200": { - "description": "", + "description": "Accepted remote shares returned", "content": { "application/json": { "schema": { @@ -3023,7 +3023,7 @@ ], "responses": { "200": { - "description": "", + "description": "Pending remote shares returned", "content": { "application/json": { "schema": { diff --git a/apps/provisioning_api/lib/Controller/AppConfigController.php b/apps/provisioning_api/lib/Controller/AppConfigController.php index b6e2bec0ccd..4cdd350042e 100644 --- a/apps/provisioning_api/lib/Controller/AppConfigController.php +++ b/apps/provisioning_api/lib/Controller/AppConfigController.php @@ -88,6 +88,8 @@ class AppConfigController extends OCSController { * Get a list of apps * * @return DataResponse<Http::STATUS_OK, array{data: string[]}, array{}> + * + * 200: Apps returned */ public function getApps(): DataResponse { return new DataResponse([ diff --git a/apps/provisioning_api/lib/Controller/AppsController.php b/apps/provisioning_api/lib/Controller/AppsController.php index 7f84bdeb9db..893a17d684e 100644 --- a/apps/provisioning_api/lib/Controller/AppsController.php +++ b/apps/provisioning_api/lib/Controller/AppsController.php @@ -62,6 +62,8 @@ class AppsController extends OCSController { * @param ?string $filter Filter for enabled or disabled apps * @return DataResponse<Http::STATUS_OK, array{apps: string[]}, array{}> * @throws OCSException + * + * 200: Installed apps returned */ public function getApps(?string $filter = null): DataResponse { $apps = (new OC_App())->listAllApps(); @@ -94,6 +96,8 @@ class AppsController extends OCSController { * @param string $app ID of the app * @return DataResponse<Http::STATUS_OK, ProvisioningApiAppInfo, array{}> * @throws OCSException + * + * 200: App info returned */ public function getAppInfo(string $app): DataResponse { $info = $this->appManager->getAppInfo($app); @@ -112,6 +116,8 @@ class AppsController extends OCSController { * @param string $app ID of the app * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: App enabled successfully */ public function enable(string $app): DataResponse { try { @@ -129,6 +135,8 @@ class AppsController extends OCSController { * * @param string $app ID of the app * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> + * + * 200: App disabled successfully */ public function disable(string $app): DataResponse { $this->appManager->disableApp($app); diff --git a/apps/provisioning_api/lib/Controller/GroupsController.php b/apps/provisioning_api/lib/Controller/GroupsController.php index 5404f47efc2..7b0e36ecec5 100644 --- a/apps/provisioning_api/lib/Controller/GroupsController.php +++ b/apps/provisioning_api/lib/Controller/GroupsController.php @@ -91,6 +91,8 @@ class GroupsController extends AUserData { * @param ?int $limit Limit the amount of groups returned * @param int $offset Offset for searching for groups * @return DataResponse<Http::STATUS_OK, array{groups: string[]}, array{}> + * + * 200: Groups returned */ public function getGroups(string $search = '', ?int $limit = null, int $offset = 0): DataResponse { $groups = $this->groupManager->search($search, $limit, $offset); @@ -112,6 +114,8 @@ class GroupsController extends AUserData { * @param ?int $limit Limit the amount of groups returned * @param int $offset Offset for searching for groups * @return DataResponse<Http::STATUS_OK, array{groups: ProvisioningApiGroupDetails[]}, array{}> + * + * 200: Groups details returned */ public function getGroupsDetails(string $search = '', int $limit = null, int $offset = 0): DataResponse { $groups = $this->groupManager->search($search, $limit, $offset); @@ -140,6 +144,8 @@ class GroupsController extends AUserData { * @throws OCSException * * @deprecated 14 Use getGroupUsers + * + * 200: Group users returned */ public function getGroup(string $groupId): DataResponse { return $this->getGroupUsers($groupId); @@ -200,6 +206,8 @@ class GroupsController extends AUserData { * * @return DataResponse<Http::STATUS_OK, array{users: array<string, ProvisioningApiUserDetails|array{id: string}>}, array{}> * @throws OCSException + * + * 200: Group users details returned */ public function getGroupUsersDetails(string $groupId, string $search = '', int $limit = null, int $offset = 0): DataResponse { $groupId = urldecode($groupId); @@ -251,6 +259,8 @@ class GroupsController extends AUserData { * @param string $displayname Display name of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Group created successfully */ public function addGroup(string $groupid, string $displayname = ''): DataResponse { // Validate name @@ -282,6 +292,8 @@ class GroupsController extends AUserData { * @param string $value New value for the key * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Group updated successfully */ public function updateGroup(string $groupId, string $key, string $value): DataResponse { $groupId = urldecode($groupId); @@ -309,6 +321,8 @@ class GroupsController extends AUserData { * @param string $groupId ID of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Group deleted successfully */ public function deleteGroup(string $groupId): DataResponse { $groupId = urldecode($groupId); @@ -330,6 +344,8 @@ class GroupsController extends AUserData { * @param string $groupId ID of the group * @return DataResponse<Http::STATUS_OK, string[], array{}> * @throws OCSException + * + * 200: Sub admins returned */ public function getSubAdminsOfGroup(string $groupId): DataResponse { // Check group exists diff --git a/apps/provisioning_api/lib/Controller/UsersController.php b/apps/provisioning_api/lib/Controller/UsersController.php index c3e9d502675..b7e9b5d0de0 100644 --- a/apps/provisioning_api/lib/Controller/UsersController.php +++ b/apps/provisioning_api/lib/Controller/UsersController.php @@ -144,6 +144,8 @@ class UsersController extends AUserData { * @param int|null $limit Limit the amount of groups returned * @param int $offset Offset for searching for groups * @return DataResponse<Http::STATUS_OK, array{users: string[]}, array{}> + * + * 200: Users returned */ public function getUsers(string $search = '', int $limit = null, int $offset = 0): DataResponse { $user = $this->userSession->getUser(); @@ -183,6 +185,8 @@ class UsersController extends AUserData { * @param int|null $limit Limit the amount of groups returned * @param int $offset Offset for searching for groups * @return DataResponse<Http::STATUS_OK, array{users: array<string, ProvisioningApiUserDetails|array{id: string}>}, array{}> + * + * 200: Users details returned */ public function getUsersDetails(string $search = '', int $limit = null, int $offset = 0): DataResponse { $currentUser = $this->userSession->getUser(); @@ -537,6 +541,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, ProvisioningApiUserDetails, array{}> * @throws OCSException + * + * 200: User returned */ public function getUser(string $userId): DataResponse { $includeScopes = false; @@ -561,6 +567,8 @@ class UsersController extends AUserData { * * @return DataResponse<Http::STATUS_OK, ProvisioningApiUserDetails, array{}> * @throws OCSException + * + * 200: Current user returned */ public function getCurrentUser(): DataResponse { $user = $this->userSession->getUser(); @@ -581,6 +589,8 @@ class UsersController extends AUserData { * * @return DataResponse<Http::STATUS_OK, string[], array{}> * @throws OCSException + * + * 200: Editable fields returned */ public function getEditableFields(): DataResponse { $currentLoggedInUser = $this->userSession->getUser(); @@ -600,6 +610,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, string[], array{}> * @throws OCSException + * + * 200: Editable fields for user returned */ public function getEditableFieldsForUser(string $userId): DataResponse { $currentLoggedInUser = $this->userSession->getUser(); @@ -666,6 +678,8 @@ class UsersController extends AUserData { * @param string $value New value for the key * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User values edited successfully */ public function editUserMultiValue( string $userId, @@ -765,6 +779,8 @@ class UsersController extends AUserData { * @param string $value New value for the key * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User value edited successfully */ public function editUser(string $userId, string $key, string $value): DataResponse { $currentLoggedInUser = $this->userSession->getUser(); @@ -1076,6 +1092,8 @@ class UsersController extends AUserData { * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * * @throws OCSException + * + * 200: Wiped all user devices successfully */ public function wipeUserDevices(string $userId): DataResponse { /** @var IUser $currentLoggedInUser */ @@ -1111,6 +1129,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User deleted successfully */ public function deleteUser(string $userId): DataResponse { $currentLoggedInUser = $this->userSession->getUser(); @@ -1148,6 +1168,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User disabled successfully */ public function disableUser(string $userId): DataResponse { return $this->setEnabled($userId, false); @@ -1162,6 +1184,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User enabled successfully */ public function enableUser(string $userId): DataResponse { return $this->setEnabled($userId, true); @@ -1201,6 +1225,8 @@ class UsersController extends AUserData { * @param string $userId ID of the user * @return DataResponse<Http::STATUS_OK, array{groups: string[]}, array{}> * @throws OCSException + * + * 200: Users groups returned */ public function getUsersGroups(string $userId): DataResponse { $loggedInUser = $this->userSession->getUser(); @@ -1249,6 +1275,8 @@ class UsersController extends AUserData { * @param string $groupid ID of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User added to group successfully */ public function addToGroup(string $userId, string $groupid = ''): DataResponse { if ($groupid === '') { @@ -1286,6 +1314,8 @@ class UsersController extends AUserData { * @param string $groupid ID of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User removed from group successfully */ public function removeFromGroup(string $userId, string $groupid): DataResponse { $loggedInUser = $this->userSession->getUser(); @@ -1349,6 +1379,8 @@ class UsersController extends AUserData { * @param string $groupid ID of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User added as group subadmin successfully */ public function addSubAdmin(string $userId, string $groupid): DataResponse { $group = $this->groupManager->get($groupid); @@ -1387,6 +1419,8 @@ class UsersController extends AUserData { * @param string $groupid ID of the group * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: User removed as group subadmin successfully */ public function removeSubAdmin(string $userId, string $groupid): DataResponse { $group = $this->groupManager->get($groupid); @@ -1417,6 +1451,8 @@ class UsersController extends AUserData { * @param string $userId ID if the user * @return DataResponse<Http::STATUS_OK, string[], array{}> * @throws OCSException + * + * 200: User subadmin groups returned */ public function getUserSubAdminGroups(string $userId): DataResponse { $groups = $this->getUserSubAdminGroupsData($userId); @@ -1432,6 +1468,8 @@ class UsersController extends AUserData { * @param string $userId ID if the user * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> * @throws OCSException + * + * 200: Resent welcome message successfully */ public function resendWelcomeMessage(string $userId): DataResponse { $currentLoggedInUser = $this->userSession->getUser(); diff --git a/apps/provisioning_api/openapi.json b/apps/provisioning_api/openapi.json index 58badb57461..0599768d67f 100644 --- a/apps/provisioning_api/openapi.json +++ b/apps/provisioning_api/openapi.json @@ -580,7 +580,7 @@ ], "responses": { "200": { - "description": "", + "description": "Installed apps returned", "content": { "application/json": { "schema": { @@ -661,7 +661,7 @@ ], "responses": { "200": { - "description": "", + "description": "App info returned", "content": { "application/json": { "schema": { @@ -729,7 +729,7 @@ ], "responses": { "200": { - "description": "", + "description": "App enabled successfully", "content": { "application/json": { "schema": { @@ -795,7 +795,7 @@ ], "responses": { "200": { - "description": "", + "description": "App disabled successfully", "content": { "application/json": { "schema": { @@ -882,7 +882,7 @@ ], "responses": { "200": { - "description": "", + "description": "Groups returned", "content": { "application/json": { "schema": { @@ -970,7 +970,7 @@ ], "responses": { "200": { - "description": "", + "description": "Group created successfully", "content": { "application/json": { "schema": { @@ -1057,7 +1057,7 @@ ], "responses": { "200": { - "description": "", + "description": "Groups details returned", "content": { "application/json": { "schema": { @@ -1268,7 +1268,7 @@ ], "responses": { "200": { - "description": "", + "description": "Group users details returned", "content": { "application/json": { "schema": { @@ -1365,7 +1365,7 @@ ], "responses": { "200": { - "description": "", + "description": "Sub admins returned", "content": { "application/json": { "schema": { @@ -1439,7 +1439,7 @@ ], "responses": { "200": { - "description": "", + "description": "Group users returned", "content": { "application/json": { "schema": { @@ -1537,7 +1537,7 @@ ], "responses": { "200": { - "description": "", + "description": "Group updated successfully", "content": { "application/json": { "schema": { @@ -1604,7 +1604,7 @@ ], "responses": { "200": { - "description": "", + "description": "Group deleted successfully", "content": { "application/json": { "schema": { @@ -1691,7 +1691,7 @@ ], "responses": { "200": { - "description": "", + "description": "Users returned", "content": { "application/json": { "schema": { @@ -1954,7 +1954,7 @@ ], "responses": { "200": { - "description": "", + "description": "Users details returned", "content": { "application/json": { "schema": { @@ -2158,7 +2158,7 @@ ], "responses": { "200": { - "description": "", + "description": "User returned", "content": { "application/json": { "schema": { @@ -2243,7 +2243,7 @@ ], "responses": { "200": { - "description": "", + "description": "User value edited successfully", "content": { "application/json": { "schema": { @@ -2308,7 +2308,7 @@ ], "responses": { "200": { - "description": "", + "description": "User deleted successfully", "content": { "application/json": { "schema": { @@ -2366,7 +2366,7 @@ ], "responses": { "200": { - "description": "", + "description": "Current user returned", "content": { "application/json": { "schema": { @@ -2426,7 +2426,7 @@ ], "responses": { "200": { - "description": "", + "description": "Editable fields returned", "content": { "application/json": { "schema": { @@ -2498,7 +2498,7 @@ ], "responses": { "200": { - "description": "", + "description": "Editable fields for user returned", "content": { "application/json": { "schema": { @@ -2598,7 +2598,7 @@ ], "responses": { "200": { - "description": "", + "description": "User values edited successfully", "content": { "application/json": { "schema": { @@ -2665,7 +2665,7 @@ ], "responses": { "200": { - "description": "", + "description": "Wiped all user devices successfully", "content": { "application/json": { "schema": { @@ -2732,7 +2732,7 @@ ], "responses": { "200": { - "description": "", + "description": "User enabled successfully", "content": { "application/json": { "schema": { @@ -2799,7 +2799,7 @@ ], "responses": { "200": { - "description": "", + "description": "User disabled successfully", "content": { "application/json": { "schema": { @@ -2866,7 +2866,7 @@ ], "responses": { "200": { - "description": "", + "description": "Users groups returned", "content": { "application/json": { "schema": { @@ -2953,7 +2953,7 @@ ], "responses": { "200": { - "description": "", + "description": "User added to group successfully", "content": { "application/json": { "schema": { @@ -3027,7 +3027,7 @@ ], "responses": { "200": { - "description": "", + "description": "User removed from group successfully", "content": { "application/json": { "schema": { @@ -3095,7 +3095,7 @@ ], "responses": { "200": { - "description": "", + "description": "User subadmin groups returned", "content": { "application/json": { "schema": { @@ -3175,7 +3175,7 @@ ], "responses": { "200": { - "description": "", + "description": "User added as group subadmin successfully", "content": { "application/json": { "schema": { @@ -3250,7 +3250,7 @@ ], "responses": { "200": { - "description": "", + "description": "User removed as group subadmin successfully", "content": { "application/json": { "schema": { @@ -3317,7 +3317,7 @@ ], "responses": { "200": { - "description": "", + "description": "Resent welcome message successfully", "content": { "application/json": { "schema": { @@ -3376,7 +3376,7 @@ ], "responses": { "200": { - "description": "", + "description": "Apps returned", "content": { "application/json": { "schema": { diff --git a/apps/settings/lib/Controller/LogSettingsController.php b/apps/settings/lib/Controller/LogSettingsController.php index 4a28c3d17e4..62b51946af7 100644 --- a/apps/settings/lib/Controller/LogSettingsController.php +++ b/apps/settings/lib/Controller/LogSettingsController.php @@ -51,6 +51,8 @@ class LogSettingsController extends Controller { * @psalm-suppress MoreSpecificReturnType The value of Content-Disposition is not relevant * @psalm-suppress LessSpecificReturnStatement The value of Content-Disposition is not relevant * @return StreamResponse<Http::STATUS_OK, array{Content-Type: 'application/octet-stream', 'Content-Disposition': string}> + * + * 200: Logfile returned */ public function download() { if (!$this->log instanceof Log) { diff --git a/apps/settings/openapi.json b/apps/settings/openapi.json index 6445d967dc2..217a0fae9f7 100644 --- a/apps/settings/openapi.json +++ b/apps/settings/openapi.json @@ -40,7 +40,7 @@ ], "responses": { "200": { - "description": "", + "description": "Logfile returned", "headers": { "Content-Disposition": { "schema": { diff --git a/apps/theming/lib/Controller/ThemingController.php b/apps/theming/lib/Controller/ThemingController.php index 33af2b72183..e685424982f 100644 --- a/apps/theming/lib/Controller/ThemingController.php +++ b/apps/theming/lib/Controller/ThemingController.php @@ -407,6 +407,8 @@ class ThemingController extends Controller { * @param string $app ID of the app * @psalm-suppress LessSpecificReturnStatement The content of the Manifest doesn't need to be described in the return type * @return JSONResponse<Http::STATUS_OK, array{name: string, short_name: string, start_url: string, theme_color: string, background_color: string, description: string, icons: array{src: non-empty-string, type: string, sizes: string}[], display: string}, array{}> + * + * 200: Manifest returned */ public function getManifest(string $app) { $cacheBusterValue = $this->config->getAppValue('theming', 'cachebuster', '0'); diff --git a/apps/theming/lib/Controller/UserThemeController.php b/apps/theming/lib/Controller/UserThemeController.php index e0279bec149..acd930fea83 100644 --- a/apps/theming/lib/Controller/UserThemeController.php +++ b/apps/theming/lib/Controller/UserThemeController.php @@ -178,6 +178,8 @@ class UserThemeController extends OCSController { * Delete the background * * @return JSONResponse<Http::STATUS_OK, ThemingBackground, array{}> + * + * 200: Background deleted successfully */ public function deleteBackground(): JSONResponse { $currentVersion = (int)$this->config->getUserValue($this->userId, Application::APP_ID, 'userCacheBuster', '0'); diff --git a/apps/theming/openapi.json b/apps/theming/openapi.json index 9ab71122d4e..eb5eb8024b4 100644 --- a/apps/theming/openapi.json +++ b/apps/theming/openapi.json @@ -309,7 +309,7 @@ ], "responses": { "200": { - "description": "", + "description": "Manifest returned", "content": { "application/json": { "schema": { @@ -763,7 +763,7 @@ ], "responses": { "200": { - "description": "", + "description": "Background deleted successfully", "content": { "application/json": { "schema": { diff --git a/apps/updatenotification/appinfo/routes.php b/apps/updatenotification/appinfo/routes.php index 6bc0562b4eb..c6b823fd5ff 100644 --- a/apps/updatenotification/appinfo/routes.php +++ b/apps/updatenotification/appinfo/routes.php @@ -29,6 +29,6 @@ return [ ['name' => 'Admin#setChannel', 'url' => '/channel', 'verb' => 'POST'], ], 'ocs' => [ - ['name' => 'API#getAppList', 'url' => '/api/{apiVersion}/applist/{newVersion}', 'verb' => 'GET', 'requirements' => ['apiVersion' => 'v1']], + ['name' => 'API#getAppList', 'url' => '/api/{apiVersion}/applist/{newVersion}', 'verb' => 'GET', 'requirements' => ['apiVersion' => '(v1)']], ], ]; diff --git a/apps/user_ldap/lib/Controller/ConfigAPIController.php b/apps/user_ldap/lib/Controller/ConfigAPIController.php index f4161d0e9ff..5d54ba56401 100644 --- a/apps/user_ldap/lib/Controller/ConfigAPIController.php +++ b/apps/user_ldap/lib/Controller/ConfigAPIController.php @@ -67,6 +67,8 @@ class ConfigAPIController extends OCSController { * @AuthorizedAdminSetting(settings=OCA\User_LDAP\Settings\Admin) * @return DataResponse<Http::STATUS_OK, array{configID: string}, array{}> * @throws OCSException + * + * 200: Config created successfully */ public function create() { try { diff --git a/apps/user_ldap/openapi.json b/apps/user_ldap/openapi.json index 43d2d8016b5..34ef70ce78b 100644 --- a/apps/user_ldap/openapi.json +++ b/apps/user_ldap/openapi.json @@ -76,7 +76,7 @@ ], "responses": { "200": { - "description": "", + "description": "Config created successfully", "content": { "application/json": { "schema": { diff --git a/apps/user_status/lib/Controller/PredefinedStatusController.php b/apps/user_status/lib/Controller/PredefinedStatusController.php index 0a108a56bf6..ec78fedbc0b 100644 --- a/apps/user_status/lib/Controller/PredefinedStatusController.php +++ b/apps/user_status/lib/Controller/PredefinedStatusController.php @@ -63,6 +63,8 @@ class PredefinedStatusController extends OCSController { * @NoAdminRequired * * @return DataResponse<Http::STATUS_OK, UserStatusPredefined[], array{}> + * + * 200: Predefined statuses returned */ public function findAll():DataResponse { // Filtering out the invisible one, that should only be set by API diff --git a/apps/user_status/lib/Controller/StatusesController.php b/apps/user_status/lib/Controller/StatusesController.php index 0e4deca13b7..9e2bea8ff2f 100644 --- a/apps/user_status/lib/Controller/StatusesController.php +++ b/apps/user_status/lib/Controller/StatusesController.php @@ -68,6 +68,8 @@ class StatusesController extends OCSController { * @param int|null $limit Maximum number of statuses to find * @param int|null $offset Offset for finding statuses * @return DataResponse<Http::STATUS_OK, UserStatusPublic[], array{}> + * + * 200: Statuses returned */ public function findAll(?int $limit = null, ?int $offset = null): DataResponse { $allStatuses = $this->service->findAll($limit, $offset); @@ -86,7 +88,7 @@ class StatusesController extends OCSController { * @return DataResponse<Http::STATUS_OK, UserStatusPublic, array{}> * @throws OCSNotFoundException The user was not found * - * 200: The status was found successfully + * 200: Status returned */ public function find(string $userId): DataResponse { try { diff --git a/apps/user_status/lib/Controller/UserStatusController.php b/apps/user_status/lib/Controller/UserStatusController.php index 321555a45f2..5f0647563ca 100644 --- a/apps/user_status/lib/Controller/UserStatusController.php +++ b/apps/user_status/lib/Controller/UserStatusController.php @@ -172,6 +172,8 @@ class UserStatusController extends OCSController { * @NoAdminRequired * * @return DataResponse<Http::STATUS_OK, array<empty>, array{}> + * + * 200: Message cleared successfully */ public function clearMessage(): DataResponse { $this->service->clearMessage($this->userId); diff --git a/apps/user_status/openapi.json b/apps/user_status/openapi.json index 8629256942d..4dc39c2b17e 100644 --- a/apps/user_status/openapi.json +++ b/apps/user_status/openapi.json @@ -243,7 +243,7 @@ ], "responses": { "200": { - "description": "", + "description": "Statuses returned", "content": { "application/json": { "schema": { @@ -315,7 +315,7 @@ ], "responses": { "200": { - "description": "The status was found successfully", + "description": "Status returned", "content": { "application/json": { "schema": { @@ -721,7 +721,7 @@ ], "responses": { "200": { - "description": "", + "description": "Message cleared successfully", "content": { "application/json": { "schema": { @@ -853,7 +853,7 @@ ], "responses": { "200": { - "description": "", + "description": "Predefined statuses returned", "content": { "application/json": { "schema": { diff --git a/apps/weather_status/lib/Controller/WeatherStatusController.php b/apps/weather_status/lib/Controller/WeatherStatusController.php index 330f1b44e64..d9db1aea5bf 100644 --- a/apps/weather_status/lib/Controller/WeatherStatusController.php +++ b/apps/weather_status/lib/Controller/WeatherStatusController.php @@ -51,6 +51,8 @@ class WeatherStatusController extends OCSController { * Try to use the address set in user personal settings as weather location * * @return DataResponse<Http::STATUS_OK, array{success: bool, lat: ?float, lon: ?float, address: ?string}, array{}> + * + * 200: Address updated */ public function usePersonalAddress(): DataResponse { return new DataResponse($this->service->usePersonalAddress()); @@ -65,6 +67,8 @@ class WeatherStatusController extends OCSController { * * @param int $mode New mode * @return DataResponse<Http::STATUS_OK, array{success: bool}, array{}> + * + * 200: Weather status mode updated */ public function setMode(int $mode): DataResponse { return new DataResponse($this->service->setMode($mode)); @@ -80,6 +84,8 @@ class WeatherStatusController extends OCSController { * @param float|null $lat Latitude in decimal degree format * @param float|null $lon Longitude in decimal degree format * @return DataResponse<Http::STATUS_OK, array{success: bool, lat: ?float, lon: ?float, address: ?string}, array{}> + * + * 200: Location updated */ public function setLocation(?string $address, ?float $lat, ?float $lon): DataResponse { $currentWeather = $this->service->setLocation($address, $lat, $lon); @@ -92,6 +98,8 @@ class WeatherStatusController extends OCSController { * Get stored user location * * @return DataResponse<Http::STATUS_OK, array{lat: float, lon: float, address: string, mode: int}, array{}> + * + * 200: Location returned */ public function getLocation(): DataResponse { $location = $this->service->getLocation(); @@ -123,6 +131,8 @@ class WeatherStatusController extends OCSController { * Get favorites list * * @return DataResponse<Http::STATUS_OK, string[], array{}> + * + * 200: Favorites returned */ public function getFavorites(): DataResponse { return new DataResponse($this->service->getFavorites()); @@ -135,6 +145,8 @@ class WeatherStatusController extends OCSController { * * @param string[] $favorites Favorite addresses * @return DataResponse<Http::STATUS_OK, array{success: bool}, array{}> + * + * 200: Favorites updated */ public function setFavorites(array $favorites): DataResponse { return new DataResponse($this->service->setFavorites($favorites)); diff --git a/apps/weather_status/openapi.json b/apps/weather_status/openapi.json index cdfcbc3a269..cc86ab80db9 100644 --- a/apps/weather_status/openapi.json +++ b/apps/weather_status/openapi.json @@ -348,7 +348,7 @@ ], "responses": { "200": { - "description": "", + "description": "Weather status mode updated", "content": { "application/json": { "schema": { @@ -416,7 +416,7 @@ ], "responses": { "200": { - "description": "", + "description": "Address updated", "content": { "application/json": { "schema": { @@ -501,7 +501,7 @@ ], "responses": { "200": { - "description": "", + "description": "Location returned", "content": { "application/json": { "schema": { @@ -611,7 +611,7 @@ ], "responses": { "200": { - "description": "", + "description": "Location updated", "content": { "application/json": { "schema": { @@ -797,7 +797,7 @@ ], "responses": { "200": { - "description": "", + "description": "Favorites returned", "content": { "application/json": { "schema": { @@ -870,7 +870,7 @@ ], "responses": { "200": { - "description": "", + "description": "Favorites updated", "content": { "application/json": { "schema": { |