diff --git a/developer_manual/client_apis/WebDAV/basic.rst b/developer_manual/client_apis/WebDAV/basic.rst index 818f38ae6..f43a42d16 100644 --- a/developer_manual/client_apis/WebDAV/basic.rst +++ b/developer_manual/client_apis/WebDAV/basic.rst @@ -133,111 +133,120 @@ And here is how it should look in the body of your DAV request: Supported properties ^^^^^^^^^^^^^^^^^^^^ -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| Property | Description | Example | -+===============================+==================================================+=============================================+ -| | The latest modification time. | ``"Wed, 20 Jul 2022 05:12:23 GMT"`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The file's etag. | ``""6436d084d4805""`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The mime type of the file. | ``"image/jpeg"`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | Specifies the nature of the resource. | ```` for a folder | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The size if it is a file. | ``3030237`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | The fileid namespaced by the instance id. | | -| | | Globally unique. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The unique id for the file within the instance. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The URL to download the file. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The permissions that the user has over the file. | | S: Shared | -| | | | R: Shareable | -| | | | M: Mounted | -| | | | G: Readable | -| | | | D: Deletable | -| | | | NV: Updateable, Renameable, Moveable | -| | | | W: Updateable (file) | -| | | | CK: Creatable | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The type of mount. | | ``''`` = local | -| | | | ``'shared'`` = received share | -| | | | ``'group'`` = group folder | -| | | | ``'external'`` = external storage | -| | | | ``'external-session'`` = external storage | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | Whether the folder is end-to-end encrypted. | | ``0`` for ``false`` | -| | | | ``1`` for ``true`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | List of user specified tags. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The favorite state. | | ``0`` for not favourited | -| | | | ``1`` for favourited | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The DAV endpoint to fetch the comments. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The number of comments. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The number of unread comments. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The user id of the owner of a shared file. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The display name of the owner of a shared file. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The list of type share. | | ``0`` = User | -| | | | ``1`` = Group | -| | | | ``3`` = Public link | -| | | | ``4`` = Email | -| | | | ``6`` = Federated cloud share | -| | | | ``7`` = Circle | -| | | | ``8`` = Guest | -| | | | ``9`` = Remote group | -| | | | ``10`` = Talk conversation | -| | | | ``12`` = Deck | -| | | | ``15`` = Science mesh | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | The permissions that the | | ``1`` = Read | -| | | user has over the share. | | ``2`` = Update | -| | | | ``4`` = Create | -| | | | ``8`` = Delete | -| | | | ``16`` = Share | -| | | | ``31`` = All | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | The permissions that the | ``share``, ``read``, ``write`` | -| | | user has over the share. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The list of share recipient. | | - id | -| | | | - display-name | -| | | | - share type | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | A list of checksum. | ``md5:04c36b75222cd9fd47f2607333029106`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | Whether a preview of the file is available. | ``true`` or ``false`` | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | Unlike ```getcontentlength``, | | -| | | this property also works | | -| | | for folders, reporting the size | | -| | | of everything in the folder. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The workspace file. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | The content of the workspace file. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | Date this file was uploaded. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | Share note. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | The number of folders directly contained | | -| | | in the folder (not recursively). | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | The number of files directly contained | | -| | | in the folder (not recursively). | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ -| | | Used by the clients to find out | | -| | | if a backup has been restored. | | -+-------------------------------+--------------------------------------------------+---------------------------------------------+ ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| Property | Description | Example | ++===============================+==================================================+=======================================================================+ +| | The latest modification time. | ``"Wed, 20 Jul 2022 05:12:23 GMT"`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The file's etag. | ``""6436d084d4805""`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The mime type of the file. | ``"image/jpeg"`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Specifies the nature of the resource. | ```` for a folder | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The size if it is a file. | ``3030237`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | The fileid namespaced by the instance id. | | +| | | Globally unique. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The unique id for the file within the instance. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The URL to download the file. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The permissions that the user has over the file. | | S: Shared | +| | | | R: Shareable | +| | | | M: Mounted | +| | | | G: Readable | +| | | | D: Deletable | +| | | | NV: Updateable, Renameable, Moveable | +| | | | W: Updateable (file) | +| | | | CK: Creatable | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The type of mount. | | ``''`` = local | +| | | | ``'shared'`` = received share | +| | | | ``'group'`` = group folder | +| | | | ``'external'`` = external storage | +| | | | ``'external-session'`` = external storage | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Whether the folder is end-to-end encrypted. | | ``0`` for ``false`` | +| | | | ``1`` for ``true`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | List of user specified tags. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The favorite state. | | ``0`` for not favourited | +| | | | ``1`` for favourited | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The DAV endpoint to fetch the comments. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The number of comments. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The number of unread comments. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The user id of the owner of a shared file. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The display name of the owner of a shared file. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The list of type share. | | ``0`` = User | +| | | | ``1`` = Group | +| | | | ``3`` = Public link | +| | | | ``4`` = Email | +| | | | ``6`` = Federated cloud share | +| | | | ``7`` = Circle | +| | | | ``8`` = Guest | +| | | | ``9`` = Remote group | +| | | | ``10`` = Talk conversation | +| | | | ``12`` = Deck | +| | | | ``15`` = Science mesh | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | The permissions that the | | ``1`` = Read | +| | | user has over the share. | | ``2`` = Update | +| | | | ``4`` = Create | +| | | | ``8`` = Delete | +| | | | ``16`` = Share | +| | | | ``31`` = All | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | The permissions that the | ``share``, ``read``, ``write`` | +| | | user has over the share. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | User set attributes. | ``[{ "scope" => , "key" => , "enabled" => }]`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The list of share recipient. | | - id | +| | | | - display-name | +| | | | - share type | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | A list of checksum. | ``md5:04c36b75222cd9fd47f2607333029106`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Whether a preview of the file is available. | ``true`` or ``false`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | Unlike ```getcontentlength``, | | +| | | this property also works | | +| | | for folders, reporting the size | | +| | | of everything in the folder. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Amount of bytes used in the folder. | ``3950773`` | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Amount of available bytes in the folder. | | ``3950773`` | +| | | | ``-1`` Uncomputed free space. | +| | | | ``-2`` Unknown free space. | +| | | | ``-3`` Unlimited free space. | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The workspace file. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | The content of the workspace file. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Date this file was uploaded. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | Share note. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | The number of folders directly contained | | +| | | in the folder (not recursively). | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | The number of files directly contained | | +| | | in the folder (not recursively). | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ +| | | Used by the clients to find out | | +| | | if a backup has been restored. | | ++-------------------------------+--------------------------------------------------+-----------------------------------------------------------------------+ Listing folders (rfc4918_)