Skip to content

docs(webdav): fix and overhaul bulk upload protocol docs - #15406

Open
joshtrichards wants to merge 3 commits into
masterfrom
jtr/docs-webdav-bulkUpload-updates
Open

docs(webdav): fix and overhaul bulk upload protocol docs#15406
joshtrichards wants to merge 3 commits into
masterfrom
jtr/docs-webdav-bulkUpload-updates

Conversation

@joshtrichards

@joshtrichards joshtrichards commented Aug 3, 2026

Copy link
Copy Markdown
Member

☑️ Resolves

Rewrite and expand the WebDAV bulk-upload documentation to match the current server-side and client implementations.

Changes:

  • Document endpoint discovery through the dav.bulkupload capability.
  • Define the multipart/related request format, CRLF framing, boundaries, and per-part Content-Length semantics.
  • Clarify required and optional per-part headers, including checksum and mtime compatibility behavior.
  • Document OC-Checksum as the preferred checksum header and the additional X-File-MD5 requirement for Nextcloud Server versions before 32.
  • Describe successful and per-file error response entries, including the fact that an HTTP 200 OK response can still contain individual failures.
  • Add retry guidance and clarify that the protocol does not define a fixed “small file” threshold or a minimum file count.
  • Replace the outdated upload example with a GNU/Linux Bash and curl example that constructs a correctly framed multipart request.
  • Miscellaneous wording/organizational improvements.

Historical context: nextcloud/server#28991

🖼️ Screenshots

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

Document capability negotiation, multipart framing, checksum and mtime header compatibility, per-file response fields, and error handling.

Signed-off-by: Josh <josh.t.richards@gmail.com>
Clarify capability discovery, multipart request framing, checksum and mtime compatibility, response handling, retry considerations, and update GNU/Linux curl example.

Adjust headings and update introduction for additional clarity.

Signed-off-by: Josh <josh.t.richards@gmail.com>
@joshtrichards joshtrichards changed the title docs(webdav): clarify bulk upload protocol docs(webdav): update bulk upload protocol docs Aug 3, 2026
@joshtrichards
joshtrichards marked this pull request as ready for review August 3, 2026 14:33
@joshtrichards joshtrichards changed the title docs(webdav): update bulk upload protocol docs docs(webdav): fix and overhaul bulk upload protocol docs Aug 3, 2026
Signed-off-by: Josh <josh.t.richards@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant