Skip to content

Commit 8936a2b

Browse files
SomSamantraySomSamantray
committed
fix(webdav): correct X-NC-WebDAV-Auto-Mkcol header name in docs
Rename the misspelled upload header to match the server implementation (apps/dav/lib/Upload/UploadAutoMkcolPlugin.php). Clients following the documentation previously sent the wrong header and received a 403 on uploads that should auto-create parent directories. Fixes #15365
1 parent 0ad8ebc commit 8936a2b

1 file changed

Lines changed: 39 additions & 39 deletions

File tree

‎developer_manual/client_apis/WebDAV/basic.rst‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The table below summarizes common WebDAV methods used by Nextcloud and the most
108108
+------------+-------------------------------------------+----------------------------------------------+-------------------------------------------------------------+
109109
| PUT | ``/remote.php/dav/files/{user}/file`` | Optional: ``X-OC-MTime``, ``X-OC-CTime``, | Uploads/overwrites file content. |
110110
| | | ``OC-Checksum``, ``OC-Total-Length``, | |
111-
| | | ``X-NC-WebDAV-AutoMkcol`` | |
111+
| | | ``X-NC-WebDAV-Auto-Mkcol`` | |
112112
+------------+-------------------------------------------+----------------------------------------------+-------------------------------------------------------------+
113113
| MKCOL | ``/remote.php/dav/files/{user}/folder`` | (none required) | Creates a folder. |
114114
+------------+-------------------------------------------+----------------------------------------------+-------------------------------------------------------------+
@@ -583,44 +583,44 @@ Request Headers
583583
584584
You can set some special headers that Nextcloud will interpret.
585585
586-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
587-
| Header | Description | Example |
588-
+=======================+=================================================================+============================================+
589-
| X-OC-MTime | | Allow to specify a modification time. | ``1675789581`` |
590-
| | | The response will contain the header ``X-OC-MTime: accepted`` | |
591-
| | | if the mtime was accepted. | |
592-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
593-
| X-OC-CTime | | Allow to specify a creation time. | ``1675789581`` |
594-
| | | The response will contain the header ``X-OC-CTime: accepted`` | |
595-
| | | if the mtime was accepted. | |
596-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
597-
| OC-Checksum | | A checksum that will be stored in the DB. | ``md5:04c36b75222cd9fd47f2607333029106`` |
598-
| | | For regular ``PUT`` uploads, the server stores the value | |
599-
| | | without validation. During bulk uploads, the checksum | |
600-
| | | **is** validated against the uploaded content. | |
601-
| | | Currently used algorithms are ``MD5``, ``SHA1``, ``SHA256``, | |
602-
| | | ``SHA3-256``, ``Adler32``. | |
603-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
604-
| X-Hash | | On ``PUT`` requests, instructs the server to compute a hash | ``md5``, ``sha1``, ``sha256``, |
605-
| | | of the uploaded file content during the write. The server | or ``all`` |
606-
| | | returns the hash(es) in response headers named | |
607-
| | | ``X-Hash-MD5``, ``X-Hash-SHA1``, and/or ``X-Hash-SHA256``. | |
608-
| | | Setting the value to ``all`` computes all three hashes. | |
609-
| | | Beware of performance implications! | |
610-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
611-
| OC-Total-Length | | Contains the total size of the file during a chunk upload. | ``4052412`` |
612-
| | | This allow the server to abort faster if the remaining | |
613-
| | | user's quota is not enough. | |
614-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
615-
| X-NC-WebDAV-AutoMkcol | | When set to ``1``, instructs the server to automatically | |
616-
| | | create any missing parent directories when uploading a file. | |
617-
| | | Available since Nextcloud 32. | |
618-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
619-
| OC-Chunked | | Used for legacy chunk upload to differentiate a regular | Deprecated |
620-
| | | upload from a chunked upload. It allowed checking for quota | |
621-
| (deprecated) | | and various other things. Nowadays, you need to provide the | You do not have to provide |
622-
| | | ``OC-Total-Length`` header on the ``PUT`` requests instead. | this anymore |
623-
+-----------------------+-----------------------------------------------------------------+--------------------------------------------+
586+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
587+
| Header | Description | Example |
588+
+========================+=================================================================+============================================+
589+
| X-OC-MTime | | Allow to specify a modification time. | ``1675789581`` |
590+
| | | The response will contain the header ``X-OC-MTime: accepted`` | |
591+
| | | if the mtime was accepted. | |
592+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
593+
| X-OC-CTime | | Allow to specify a creation time. | ``1675789581`` |
594+
| | | The response will contain the header ``X-OC-CTime: accepted`` | |
595+
| | | if the mtime was accepted. | |
596+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
597+
| OC-Checksum | | A checksum that will be stored in the DB. | ``md5:04c36b75222cd9fd47f2607333029106`` |
598+
| | | For regular ``PUT`` uploads, the server stores the value | |
599+
| | | without validation. During bulk uploads, the checksum | |
600+
| | | **is** validated against the uploaded content. | |
601+
| | | Currently used algorithms are ``MD5``, ``SHA1``, ``SHA256``, | |
602+
| | | ``SHA3-256``, ``Adler32``. | |
603+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
604+
| X-Hash | | On ``PUT`` requests, instructs the server to compute a hash | ``md5``, ``sha1``, ``sha256``, |
605+
| | | of the uploaded file content during the write. The server | or ``all`` |
606+
| | | returns the hash(es) in response headers named | |
607+
| | | ``X-Hash-MD5``, ``X-Hash-SHA1``, and/or ``X-Hash-SHA256``. | |
608+
| | | Setting the value to ``all`` computes all three hashes. | |
609+
| | | Beware of performance implications! | |
610+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
611+
| OC-Total-Length | | Contains the total size of the file during a chunk upload. | ``4052412`` |
612+
| | | This allow the server to abort faster if the remaining | |
613+
| | | user's quota is not enough. | |
614+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
615+
| X-NC-WebDAV-Auto-Mkcol | | When set to ``1``, instructs the server to automatically | |
616+
| | | create any missing parent directories when uploading a file. | |
617+
| | | Available since Nextcloud 32. | |
618+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
619+
| OC-Chunked | | Used for legacy chunk upload to differentiate a regular | Deprecated |
620+
| | | upload from a chunked upload. It allowed checking for quota | |
621+
| (deprecated) | | and various other things. Nowadays, you need to provide the | You do not have to provide |
622+
| | | ``OC-Total-Length`` header on the ``PUT`` requests instead. | this anymore |
623+
+------------------------+-----------------------------------------------------------------+--------------------------------------------+
624624
625625
Response Headers
626626
----------------

0 commit comments

Comments
 (0)