From a95bebde348f1146ca1ae3103123a04aa5347b62 Mon Sep 17 00:00:00 2001
From: jld3103 <jld3103yt@gmail.com>
Date: Mon, 21 Aug 2023 05:45:43 +0200
Subject: files_reminders: Add OpenAPI spec

Signed-off-by: jld3103 <jld3103yt@gmail.com>
---
 .../lib/Controller/ApiController.php               | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'apps/files_reminders/lib/Controller/ApiController.php')

diff --git a/apps/files_reminders/lib/Controller/ApiController.php b/apps/files_reminders/lib/Controller/ApiController.php
index ed23ee032ba..91b7e51eb6f 100644
--- a/apps/files_reminders/lib/Controller/ApiController.php
+++ b/apps/files_reminders/lib/Controller/ApiController.php
@@ -54,6 +54,12 @@ class ApiController extends OCSController {
 
 	/**
 	 * Get a reminder
+	 *
+	 * @param int $fileId ID of the file
+	 * @return DataResponse<Http::STATUS_OK, array{dueDate: ?string}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, array<empty>, array{}>
+	 *
+	 * 200: Reminder returned
+	 * 401: User not found
 	 */
 	#[NoAdminRequired]
 	public function get(int $fileId): DataResponse {
@@ -79,7 +85,16 @@ class ApiController extends OCSController {
 	/**
 	 * Set a reminder
 	 *
+	 * @param int $fileId ID of the file
 	 * @param string $dueDate ISO 8601 formatted date time string
+	 *
+	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_CREATED|Http::STATUS_BAD_REQUEST|Http::STATUS_UNAUTHORIZED|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+	 *
+	 * 200: Reminder updated
+	 * 201: Reminder created successfully
+	 * 400: Creating reminder is not possible
+	 * 401: User not found
+	 * 404: File not found
 	 */
 	#[NoAdminRequired]
 	public function set(int $fileId, string $dueDate): DataResponse {
@@ -108,6 +123,14 @@ class ApiController extends OCSController {
 
 	/**
 	 * Remove a reminder
+	 *
+	 * @param int $fileId ID of the file
+	 *
+	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_UNAUTHORIZED|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+	 *
+	 * 200: Reminder deleted successfully
+	 * 401: User not found
+	 * 404: Reminder not found
 	 */
 	#[NoAdminRequired]
 	public function remove(int $fileId): DataResponse {
-- 
cgit v1.2.3