[WIP] T&C Data Retention - Technical Specification

Summary

Adds the ability to configure custom (granular) deletion policies for posts for specific teams and/or channels so that when the daily retention job runs it can selectively delete those resources based on what’s configured.

The retention job (or at least the queries) will have to be modified such that the global setting does not delete posts for any team or channel that is configured via granular policies. The granular policies completely override the global setting. Put another way a granular setting can cause a post to live longer or shorter than the global setting.

API

Global Policy (existing API)

GET /api/v4/data_retention/policy to retrieve the global retention settings

{
    "message_deletion_enabled": false,
    "file_deletion_enabled": false,
    "message_retention_cutoff": 0,
    "file_retention_cutoff": 0
}

Updating the global policy continues to be managed via the config API.

Retention Policies

POST /api/v4/retention_policies to create a new retention policy

Request:

{
    "display_name": "foo",
    "post_duration": 4
}

Response:

{
    "id": "m8zoumpj9pn9zexospoxi5dzoc",
    "display_name": "foo",
    "post_duration": 4
}

PUT /api/v4/retention_policies/:policy_id/patch to patch a retention policy

Request:

{
    "display_name": "foo2",
    "post_duration": 365
}

Response:

{
    "id": "m8zoumpj9pn9zexospoxi5dzoc",
    "display_name": "foo2",
    "post_duration": 365
}

GET /api/v4/retention_policies/:policy_id to get a retention policy by id

{
    "id": "m8zoumpj9pn9zexospoxi5dzoc",
    "display_name": "foo2",
    "post_duration": 365,
    "teams": ["z7rxbxbfb7yxdydxzi8pestath"],
    "channels": ["z7rxbxbfb7yxdydxzi8pestath"]
}

DELETE /api/v4/retention_policies/:policy_id to delete a retention policy

As a prerequisite one must delete all of the RetentionPoliciesChannels and RetentionPoliciesTeams first, otherwise the request is rejected.

GET /api/v4/retention_policies to list all retention policies, including associated teams and channels

{
    "policies": [
        {
            "display_name": "foo",
            "post_duration": 2,
            "teams": ["z7rxbxbfb7yxdydxzi8pestath"],
            "channels": ["z7rxbxbfb7yxdydxzi8pestath"]
        }
    ],
    "total_count": 1
}

TBD: How much easier is it to just include the team and channel display names rather than just ids? For example:

{
    "policies": [
        {
            "display_name": "foo",
            "post_duration": 2,
            "teams": [{"id": "z7rxbxbfb7yxdydxzi8pestath", "display_name": "My Team 1"}],
            "channels": [{"id": "z7rxbxbfb7yxdydxzi8pestath", "display_name": "Off Topic", "team_display_name": "My Team 1"}]
        }
    ],
    "total_count": 1
}

Retention Policies Teams

POST /api/v4/retention_policies/:policy_id/teams to associate a team to a retention policy

{
    "team_id": "z7rxbxbfb7yxdydxzi8pestath"
}

DELETE /api/v4/retention_policies/:policy_id/teams/:team_id to remove a team from a retention policy

Retention Policies Channels

POST /api/v4/retention_policies/:policy_id/channels to associate a channel to a retention policy

{
    "channel_id": "z7rxbxbfb7yxdydxzi8pestath"
}

DELETE /api/v4/retention_policies/:policy_id/channels/:channel_id to delete a channel from a retention policy

Database

RetentionPolicies table

RetentionPoliciesChannels table

RetentionPoliciesTeams table

Mobile