Merge pull request #41818 from nextcloud/techdebt/noid/clarify-ooo-re…

…turn-data fix(OOO): Make the returned data more explicit
nextcloud · Nov 29, 2023 · 6e3781b · 6e3781b
2 parents 16de85d + aaaf040
commit 6e3781b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/apps/dav/lib/Controller/OutOfOfficeController.php b/apps/dav/lib/Controller/OutOfOfficeController.php
@@ -30,6 +30,7 @@
 use OCA\DAV\ResponseDefinitions;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
@@ -50,15 +51,13 @@ public function __construct(
 	/**
 	 * Get the currently configured out-of-office data of a user.
 	 *
-	 * @NoAdminRequired
-	 * @NoCSRFRequired
-	 *
 	 * @param string $userId The user id to get out-of-office data for.
-	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, ?DAVOutOfOfficeData, array{}>
+	 * @return DataResponse<Http::STATUS_OK, DAVOutOfOfficeData, array{}>|DataResponse<Http::STATUS_NOT_FOUND, null, array{}>
 	 *
 	 * 200: Out-of-office data
 	 * 404: No out-of-office data was found
 	 */
+	#[NoAdminRequired]
 	public function getCurrentOutOfOfficeData(string $userId): DataResponse {
 		try {
 			$data = $this->absenceMapper->findByUserId($userId);

diff --git a/apps/dav/openapi.json b/apps/dav/openapi.json
@@ -277,8 +277,7 @@
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
                                                 "data": {
-                                                    "$ref": "#/components/schemas/OutOfOfficeData",
-                                                    "nullable": true
+                                                    "$ref": "#/components/schemas/OutOfOfficeData"
                                                 }
                                             }
                                         }
@@ -308,7 +307,6 @@
                                                     "$ref": "#/components/schemas/OCSMeta"
                                                 },
                                                 "data": {
-                                                    "$ref": "#/components/schemas/OutOfOfficeData",
                                                     "nullable": true
                                                 }
                                             }