help: Update exports documentation.

Document in-app exports with user consent.
This commit is contained in:
Alya Abbott
2024-10-14 11:31:51 -07:00
committed by Tim Abbott
parent efc6c70d3b
commit b8dd409d71
6 changed files with 54 additions and 77 deletions

View File

@@ -79,11 +79,12 @@ format used by the Zulip server that they are interacting with.
* [`GET /export/realm`](/api/get-realm-exports),
[`GET /events`](/api/get-events): Added `export_type` field
to the dictionaries in `exports` array. It indicates whether
the export is of public data or full data with user consent.
the export is of public data or full data with user consent
(standard export).
* [`POST /export/realm`](/api/get-realm-exports): Added `export_type`
parameter to add support for admins to decide whether to create a
public data export or a full data export with member consent.
public or a standard data export.
**Feature level 303**
@@ -185,8 +186,8 @@ format used by the Zulip server that they are interacting with.
**Feature level 295**
* [`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).
a new endpoint to fetch the [consents of users](/help/export-your-organization#configure-whether-administrators-can-export-your-private-data)
for their private data exports.
* `/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