User data takeout/export

Open
#1,139 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
api, backend

Research direction

Start by tracing the user API entry points for POST /users/@me/harvest and POST /users/{user_id}/harvest, then review the Takeouts thread for the expected export contents and Discord-compatible format. Done means a user can request an export, an authorized MANAGE_USERS instance staff member can request one for another user, and the package becomes available within the stated timeframe.

Written by the indexing model from the issue text.

Description

Is your feature request related to a problem? Please describe.
Users, at least in the EU, have the right to request a copy of their data. This should happen mostly, if not fully, automated to reduce work load on instance staff.

Describe the solution you'd like
POST /users/@me/harvest being implemented. The exported package should be available within a few minutes to hours. The format should be the same as Discord and should work on analyzers, e.g. https://www.discord-recap.com, https://discord-package.vercel.app and https://ddpe.androz2091.fr .

To improve instance staff abilities, the endpoint should support a user ID with the MANAGE_USERS right too: POST /users/{user_id}/harvest

Additional context
@erkinalp collected quite some information about current data exports in the "Takeouts" thread: https://discord.com/channels/806142446094385153/1138777318052073522 .

Dominant language
TypeScript
Stars
2.2k
Forks
323
Avg merge
14h 48m
Merged PRs (30d)
4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from spacebarchat/server

All issues in spacebarchat/server

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.