openedx / openedx/openedx-platform
[API] Video Management
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Functional Area: Video Management
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Video Download | v1 | /contentstore/v1/videos/{course_id}/download |
PUT | Downloads multiple videos for a course as a single zip file. Accepts a body parameter files with an array of objects containing url and name for each video. Returns a zip attachment named {course_id}videos{random_id}.zip on success. |
| Video Usage | v1 | /contentstore/v1/videos/{course_id}/{edx_video_id}/usage |
GET | Retrieves usage locations of a specific video within the course. Returns an array of strings indicating XBlocks or subsections where the video is embedded. |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue identifies the Video Download and Video Usage API entry points under /contentstore/v1/videos. Start by locating existing contentstore video endpoints and their tests, then determine the implementation scope for both endpoints. Done means the documented request and response behavior is implemented and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100