diff options
| author | jld3103 <jld3103yt@gmail.com> | 2023-06-14 16:42:04 +0200 |
|---|---|---|
| committer | Julien Veyssier <julien-nc@posteo.net> | 2023-07-13 10:20:09 +0200 |
| commit | 3dff41786d9a00a6dce81fee4345b0ebd374d06c (patch) | |
| tree | 07a8e6905f0f9b1f8c65d49b431b9c456563101d /apps/files_versions/lib | |
| parent | c35c42f802242479727b6dc8cb391e730f5dabf2 (diff) | |
| download | nextcloud-server-3dff41786d9a00a6dce81fee4345b0ebd374d06c.tar.gz nextcloud-server-3dff41786d9a00a6dce81fee4345b0ebd374d06c.zip | |
files_versions: Add OpenAPI spec
Signed-off-by: jld3103 <jld3103yt@gmail.com>
Diffstat (limited to 'apps/files_versions/lib')
| -rw-r--r-- | apps/files_versions/lib/Capabilities.php | 2 | ||||
| -rw-r--r-- | apps/files_versions/lib/Controller/PreviewController.php | 16 |
2 files changed, 13 insertions, 5 deletions
diff --git a/apps/files_versions/lib/Capabilities.php b/apps/files_versions/lib/Capabilities.php index b5861db8937..7091f9c4676 100644 --- a/apps/files_versions/lib/Capabilities.php +++ b/apps/files_versions/lib/Capabilities.php @@ -42,6 +42,8 @@ class Capabilities implements ICapability { /** * Return this classes capabilities + * + * @return array{files: array{versioning: bool, version_labeling: bool, version_deletion: bool}} */ public function getCapabilities() { return [ diff --git a/apps/files_versions/lib/Controller/PreviewController.php b/apps/files_versions/lib/Controller/PreviewController.php index 0e625dc2139..1365e7e50fa 100644 --- a/apps/files_versions/lib/Controller/PreviewController.php +++ b/apps/files_versions/lib/Controller/PreviewController.php @@ -69,11 +69,17 @@ class PreviewController extends Controller { * @NoAdminRequired * @NoCSRFRequired * - * @param string $file - * @param int $x - * @param int $y - * @param string $version - * @return DataResponse|FileDisplayResponse + * Get the preview for a file version + * + * @param string $file Path of the file + * @param int $x Width of the preview + * @param int $y Height of the preview + * @param string $version Version of the file to get the preview for + * @return FileDisplayResponse<Http::STATUS_OK, array{Content-Type: string}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, array<empty>, array{}> + * + * 200: Preview returned + * 400: Getting preview is not possible + * 404: Preview not found */ public function getPreview( string $file = '', |