diff options
| author | jld3103 <jld3103yt@gmail.com> | 2023-09-19 14:12:17 +0200 |
|---|---|---|
| committer | jld3103 <jld3103yt@gmail.com> | 2023-09-27 08:05:21 +0200 |
| commit | c2d45cb1728e2191e51424734e74cb2a56b323b0 (patch) | |
| tree | 0c46d10f4e5ef18bf0771069dd2a896da788b4ba /apps/user_status | |
| parent | 912b18b1fc9fd90bfc78f942cd2043a5a0145e69 (diff) | |
| download | nextcloud-server-c2d45cb1728e2191e51424734e74cb2a56b323b0.tar.gz nextcloud-server-c2d45cb1728e2191e51424734e74cb2a56b323b0.zip | |
Add single status code descriptions for OpenAPI
Signed-off-by: jld3103 <jld3103yt@gmail.com>
Diffstat (limited to 'apps/user_status')
4 files changed, 11 insertions, 5 deletions
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": { |