files: Add OpenAPI spec

Signed-off-by: jld3103 <jld3103yt@gmail.com>

1 files changed, 35 insertions, 0 deletions

diff --git a/apps/files/lib/Controller/DirectEditingController.php b/apps/files/lib/Controller/DirectEditingController.php
index 9b48d6958aa..d58be166e79 100644
--- a/apps/files/lib/Controller/DirectEditingController.php
+++ b/apps/files/lib/Controller/DirectEditingController.php
@@ -63,6 +63,9 @@ class DirectEditingController extends OCSController {
 
 	/**
 	 * @NoAdminRequired
+	 *
+	 * 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{}>
 	 */
 	public function info(): DataResponse {
 		$response = new DataResponse($this->directEditingService->getDirectEditingCapabilitites());
@@ -72,6 +75,18 @@ class DirectEditingController extends OCSController {
 
 	/**
 	 * @NoAdminRequired
+	 *
+	 * Create a file for direct editing
+	 *
+	 * @param string $path Path of the file
+	 * @param string $editorId ID of the editor
+	 * @param string $creatorId ID of the creator
+	 * @param ?string $templateId ID of the template
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{url: string}, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+	 *
+	 * 200: URL for direct editing returned
+	 * 403: Opening file is not allowed
 	 */
 	public function create(string $path, string $editorId, string $creatorId, string $templateId = null): DataResponse {
 		if (!$this->directEditingManager->isEnabled()) {
@@ -92,6 +107,17 @@ class DirectEditingController extends OCSController {
 
 	/**
 	 * @NoAdminRequired
+	 *
+	 * Open a file for direct editing
+	 *
+	 * @param string $path Path of the file
+	 * @param ?string $editorId ID of the editor
+	 * @param ?int $fileId ID of the file
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{url: string}, array{}>|DataResponse<Http::STATUS_FORBIDDEN|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+	 *
+	 * 200: URL for direct editing returned
+	 * 403: Opening file is not allowed
 	 */
 	public function open(string $path, string $editorId = null, ?int $fileId = null): DataResponse {
 		if (!$this->directEditingManager->isEnabled()) {
@@ -114,6 +140,15 @@ class DirectEditingController extends OCSController {
 
 	/**
 	 * @NoAdminRequired
+	 *
+	 * Get the templates for direct editing
+	 *
+	 * @param string $editorId ID of the editor
+	 * @param string $creatorId ID of the creator
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{templates: array<string, array{id: string, title: string, preview: ?string, extension: string, mimetype: string}>}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+	 *
+	 * 200: Templates returned
 	 */
 	public function templates(string $editorId, string $creatorId): DataResponse {
 		if (!$this->directEditingManager->isEnabled()) {