files_sharing: Add OpenAPI spec

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

1 files changed, 243 insertions, 0 deletions

diff --git a/apps/files_sharing/lib/ResponseDefinitions.php b/apps/files_sharing/lib/ResponseDefinitions.php
new file mode 100644
index 00000000000..e2e5d6d7ba3
--- /dev/null
+++ b/apps/files_sharing/lib/ResponseDefinitions.php
@@ -0,0 +1,243 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
+ *
+ * @author Kate Döen <kate.doeen@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Files_Sharing;
+
+/**
+ * @psalm-type FilesSharingShare = array{
+ *     attributes: ?string,
+ *     can_delete: bool,
+ *     can_edit: bool,
+ *     displayname_file_owner: string,
+ *     displayname_owner: string,
+ *     expiration: ?string,
+ *     file_parent: int,
+ *     file_source: int,
+ *     file_target: string,
+ *     has_preview: bool,
+ *     hide_download: 0|1,
+ *     id: string,
+ *     item_mtime: int,
+ *     item_permissions?: int,
+ *     item_size: float|int,
+ *     item_source: int,
+ *     item_type: 'file'|'folder',
+ *     label: string,
+ *     mail_send: 0|1,
+ *     mimetype: string,
+ *     note: string,
+ *     parent: null,
+ *     password?: string,
+ *     password_expiration_time?: ?string,
+ *     path: ?string,
+ *     permissions: int,
+ *     send_password_by_talk?: bool,
+ *     share_type: int,
+ *     share_with?: string,
+ *     share_with_avatar?: string,
+ *     share_with_displayname?: string,
+ *     share_with_displayname_unique?: ?string,
+ *     share_with_link?: string,
+ *     status?: array{clearAt?: int|null, icon?: ?string, message?: ?string, status?: string},
+ *     stime: int,
+ *     storage: int,
+ *     storage_id: string,
+ *     token: ?string,
+ *     uid_file_owner: string,
+ *     uid_owner: string,
+ *     url?: string,
+ * }
+ *
+ * @psalm-type FilesSharingDeletedShare = array{
+ *     id: string,
+ *     share_type: int,
+ *     uid_owner: string,
+ *     displayname_owner: string,
+ *     permissions: int,
+ *     stime: int,
+ *     uid_file_owner: string,
+ *     displayname_file_owner: string,
+ *     path: string,
+ *     item_type: string,
+ *     mimetype: string,
+ *     storage: int,
+ *     item_source: int,
+ *     file_source: int,
+ *     file_parent: int,
+ *     file_target: int,
+ *     expiration: string|null,
+ *     share_with: string|null,
+ *     share_with_displayname: string|null,
+ *     share_with_link: string|null,
+ * }
+ *
+ * @psalm-type FilesSharingRemoteShare = array{
+ *     accepted: bool,
+ *     file_id: int|null,
+ *     id: int,
+ *     mimetype: string|null,
+ *     mountpoint: string,
+ *     mtime: int|null,
+ *     name: string,
+ *     owner: string,
+ *     parent: int|null,
+ *     permissions: int|null,
+ *     remote: string,
+ *     remote_id: string,
+ *     share_token: string,
+ *     share_type: int,
+ *     type: string|null,
+ *     user: string,
+ * }
+ *
+ * @psalm-type FilesSharingSharee = array{
+ *     count: int|null,
+ *     label: string,
+ * }
+ *
+ * @psalm-type FilesSharingShareeValue = array{
+ *     shareType: int,
+ *     shareWith: string,
+ * }
+ *
+ * @psalm-type FilesSharingShareeUser = FilesSharingSharee&array{
+ *     subline: string,
+ *     icon: string,
+ *     shareWithDisplayNameUnique: string,
+ *     status: array{
+ *         status: string,
+ *         message: string,
+ *         icon: string,
+ *         clearAt: int|null,
+ *     },
+ *     value: FilesSharingShareeValue,
+ * }
+ *
+ * @psalm-type FilesSharingShareeRemoteGroup = FilesSharingSharee&array{
+ *     guid: string,
+ *     name: string,
+ *     value: FilesSharingShareeValue&array{
+ *         server: string,
+ *     }
+ * }
+ *
+ * @psalm-type FilesSharingLookup = array{
+ *     value: string,
+ *     verified: int,
+ * }
+ *
+ * @psalm-type FilesSharingShareeLookup = FilesSharingSharee&array{
+ *     extra: array{
+ *         federationId: string,
+ *         name: FilesSharingLookup|null,
+ *         email: FilesSharingLookup|null,
+ *         address: FilesSharingLookup|null,
+ *         website: FilesSharingLookup|null,
+ *         twitter: FilesSharingLookup|null,
+ *         phone: FilesSharingLookup|null,
+ *         twitter_signature: FilesSharingLookup|null,
+ *         website_signature: FilesSharingLookup|null,
+ *         userid: FilesSharingLookup|null,
+ *     },
+ *     value: FilesSharingShareeValue&array{
+ *         globalScale: bool,
+ *     }
+ * }
+ *
+ * @psalm-type FilesSharingShareeEmail = FilesSharingSharee&array{
+ *     uuid: string,
+ *     name: string,
+ *     type: string,
+ *     shareWithDisplayNameUnique: string,
+ *     value: FilesSharingShareeValue,
+ * }
+ *
+ * @psalm-type FilesSharingShareeRemote = FilesSharingSharee&array{
+ *     uuid: string,
+ *     name: string,
+ *     type: string,
+ *     value: FilesSharingShareeValue&array{
+ *         server: string,
+ *     }
+ * }
+ *
+ * @psalm-type FilesSharingShareeCircle = FilesSharingSharee&array{
+ *     shareWithDescription: string,
+ *     value: FilesSharingShareeValue&array{
+ *         circle: string,
+ *     }
+ * }
+ *
+ * @psalm-type FilesSharingShareesSearchResult = array{
+ *     exact: array{
+ *         circles: FilesSharingShareeCircle[],
+ *         emails: FilesSharingShareeEmail[],
+ *         groups: FilesSharingSharee[],
+ *         remote_groups: FilesSharingShareeRemoteGroup[],
+ *         remotes: FilesSharingShareeRemote[],
+ *         rooms: FilesSharingSharee[],
+ *         users: FilesSharingShareeUser[],
+ *     },
+ *     circles: FilesSharingShareeCircle[],
+ *     emails: FilesSharingShareeEmail[],
+ *     groups: FilesSharingSharee[],
+ *     lookup: FilesSharingShareeLookup[],
+ *     remote_groups: FilesSharingShareeRemoteGroup[],
+ *     remotes: FilesSharingShareeRemote[],
+ *     rooms: FilesSharingSharee[],
+ *     users: FilesSharingShareeUser[],
+ *     lookupEnabled: bool,
+ * }
+ *
+ * @psalm-type FilesSharingShareesRecommendedResult = array{
+ *     exact: array{
+ *         emails: FilesSharingShareeEmail[],
+ *         groups: FilesSharingSharee[],
+ *         remote_groups: FilesSharingShareeRemoteGroup[],
+ *         remotes: FilesSharingShareeRemote[],
+ *         users: FilesSharingShareeUser[],
+ *     },
+ *     emails: FilesSharingShareeEmail[],
+ *     groups: FilesSharingSharee[],
+ *     remote_groups: FilesSharingShareeRemoteGroup[],
+ *     remotes: FilesSharingShareeRemote[],
+ *     users: FilesSharingShareeUser[],
+ * }
+ *
+ * @psalm-type FilesSharingShareInfo = array{
+ *     id: int,
+ *     parentId: int,
+ *     mtime: int,
+ *     name: string,
+ *     permissions: int,
+ *     mimetype: string,
+ *     size: int|float,
+ *     type: string,
+ *     etag: string,
+ *     children?: array<string, mixed>[],
+ * }
+ */
+class ResponseDefinitions {
+}