From 86d5ee5bdf492aaba8286482f1ba059fbef4b6f7 Mon Sep 17 00:00:00 2001 From: Alex Vandiver Date: Fri, 20 Sep 2024 14:01:11 +0000 Subject: [PATCH] tus: Document new API level for TUS endpoints. --- api_docs/changelog.md | 5 +++++ zerver/openapi/zulip.yaml | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/api_docs/changelog.md b/api_docs/changelog.md index 638d932485..97b36002c0 100644 --- a/api_docs/changelog.md +++ b/api_docs/changelog.md @@ -25,6 +25,11 @@ format used by the Zulip server that they are interacting with. * [`GET /export/realm/consents`](/api/get-realm-export-consents): Added a new endpoint to fetch the consents of users for their [private data exports](/help/export-your-organization#full-export-with-member-consent). +* `/api/v1/tus` is an endpoint implementing the [`tus` + protocol](https://tus.io/protocols/resumable-upload) for resumable uploads. + Clients which send authenticated credentials (either via browser-based + cookies, or API key via `Authorization` header) may use this endpoint to + create uploads, similar to [`POST /user_uploads`](/api/upload-file). **Feature level 294** diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 30507614c2..7ae782a936 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -8235,6 +8235,14 @@ paths: can reshare it with other users by sending additional Zulip messages containing the link. + For uploading larger files, `/api/v1/tus` is an endpoint + implementing the [`tus` + protocol](https://tus.io/protocols/resumable-upload) for + resumable uploads. Clients which send authenticated + credentials (either via browser-based cookies, or API key via + `Authorization` header) may use this endpoint to create + uploads. + [uploaded-files]: /help/manage-your-uploaded-files [send-message]: /api/send-message x-parameter-description: |