Skip to content

[DEPR]: assetstore API, trash can API #39260

Open

Description

@bradenmacdonald

RFC Start Date

2026-10-19

Target Plan Accepted Date

2026-11-02

Target Transition Unblocked Date

2026-12-01

Earliest Breaking Changes Unblocked Date

after Willow is cut

Earliest Open edX Named Release with Breaking Changes

Xylon - 2027-04

Rationale

The platform has two python APIs for accessing static assets (the "Files" that belong to each course): contentstore and assetstore. The assetstore API was intended to support additional features, but in practice it's just a thin wrapper around contentstore along with some code related to reading and writing assets.xml, which hasn't been used in any meaningful way in about ten years.

See "the assetstore dead end" from this documentation PR for more background.

In addition, there is a trashcan API that is used to store copies of deleted asset files; this is not exposed in the UI. We intend to remove the trashcan API as we replace it with a new assets implementation based on openedx_content that stores a full version history.

Removal

The following APIs:

  • The entire xmodule.assetstore module, including the AssetManager and AssetMetadata APIs
  • The contentstore('trashcan'), restore_asset_from_trashcan, and empty_asset_trashcan APIs

will be marked as deprecated upon acceptance of this DEPR and removed after the Willow release.

Any assets.xml in a course export file will be ignored on import, and course exports will just write the fixed value <assets /> to this file.

Replacement

The contentstore API already provides all required APIs for accessing and updating course files, and should continue to be used for now. Any third party code which uses the assetstore/AssetManager APIs should be migrated to the contentstore API, which is both backwards and forwards compatible.

There is no direct replacement for the trashcan APIs, but they are believed to be unused, and Xylon will have APIs that allow retrieving past versions of any asset files, including deleted ones.

Deprecation

The deprecated code will be marked using the @deprecated decorator and/or import-time warnings.

Additional Info

None of this should be user-visible nor impact any features/functionality that is currently supported. This only affects third party code that is using the assetmanager APIs.

Transition Unblocked Tasks

Feature Removal Tasks

No response

Activity

  1. added
    deprProposal for deprecation & removal per OEP-21
    on Oct 19, 2026
  2. moved this from Draft to Plan Accepted in DEPR: Deprecation & Removalon Nov 3, 2026
  3. moved this from Plan Accepted to Transition Unblocked in DEPR: Deprecation & Removalon Nov 14, 2026
  4. self-assigned this
    on Nov 14, 2026
  5. kdmccormick commented on Nov 14, 2026

    @kdmccormick
    Member

    The deprecation merged: #39261

    The removal will merge after the Willow cutoff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

deprProposal for deprecation & removal per OEP-21

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions