Skip to content

Commit 2a14d3b

Browse files
authored
Merge pull request #15291 from nextcloud/jtr/docs-dev-webdav-direct-dl
docs(webdav): clarify `oc:downloadURL` and `nc:download-url-expiration`
2 parents e161ab6 + d97d335 commit 2a14d3b

1 file changed

Lines changed: 20 additions & 14 deletions

File tree

developer_manual/client_apis/WebDAV/basic.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -160,15 +160,15 @@ It is usual to declare prefixes for those namespace in the ``d:propfind`` elemen
160160
161161
Here is the list of available namespace:
162162
163-
========================================= ======
164-
URI Prefix
165-
========================================= ======
166-
DAV: d
167-
http://owncloud.org/ns oc
168-
http://nextcloud.org/ns nc
169-
http://open-collaboration-services.org/ns ocs
170-
http://open-cloud-mesh.org/ns ocm
171-
========================================= ======
163+
============================================= ======
164+
URI Prefix
165+
============================================= ======
166+
``DAV:`` ``d``
167+
``http://owncloud.org/ns`` ``oc``
168+
``http://nextcloud.org/ns`` ``nc``
169+
``http://open-collaboration-services.org/ns`` ``ocs``
170+
``http://open-cloud-mesh.org/ns`` ``ocm``
171+
============================================= ======
172172
173173
And here is how it should look in your DAV request:
174174
@@ -240,8 +240,17 @@ Supported properties
240240
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
241241
| <oc:fileid /> | The unique id for the file within the instance. | ``7`` |
242242
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
243-
| <oc:downloadURL /> | | A URL to directly download the file from a | |
244-
| | | storage. No storage implements that yet. | |
243+
| <oc:downloadURL /> | | A temporary URL to download the file directly | ``https://s3.example.com/bucket/key?X-Amz-Algorithm=...`` |
244+
| | | from the underlying storage backend (e.g. S3 | |
245+
| | | object storage with pre-signed URLs). May be | |
246+
| | | unavailable depending on permissions, server | |
247+
| | | configuration, feature interactions (e.g. | |
248+
| | | server-side encryption, sharing), or backend | |
249+
| | | support. | |
250+
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
251+
| <nc:download-url-expiration />| | Expiration time of ``oc:downloadURL``, if one | ``1733749200`` |
252+
| | | has been generated. The value is a Unix | |
253+
| | | timestamp. | |
245254
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
246255
| <oc:permissions /> | | The permissions that the user has over the | | ``S``: Shared |
247256
| | | file or folder. The value is a string | | ``R``: Shareable |
@@ -403,9 +412,6 @@ Supported properties
403412
| <nc:metadata_etag /> | | An etag covering the file's metadata. Changes | |
404413
| | | when metadata (not content), is updated. | |
405414
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
406-
| <nc:download-url-expiration />| | Expiration date/time of a direct download | |
407-
| | | URL (if one has been generated). | |
408-
+-------------------------------+-------------------------------------------------+--------------------------------------------------------------------------------------+
409415
410416
.. note::
411417
Properties prefixed with ``nc:metadata-`` (e.g. ``nc:metadata-blurhash``) are dynamic, app-registered

0 commit comments

Comments
 (0)