openedx / openedx/openedx-platform
[API] Libraries
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: Libraries
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Home | v1 | /contentstore/v1/home/libraries |
GET | Retrieves all libraries on the home page. Supports optional query parameters: org (filter by organization) and is_migrated (boolean, true or false to filter legacy libraries by migration status). Returns display name, library key, URL, edit permissions, and migration info. Useful for AI systems or external tools managing library content or migration tracking. |
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
Start by inspecting existing contentstore API implementations and routing patterns for the Home functional area. Determine where /contentstore/v1/home/libraries belongs and how query parameters and response fields are tested. Done means the endpoint supports the documented org and is_migrated filters and returns the listed library and migration information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100