openedx / openedx/openedx-platform
[API] Container 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: Container Management
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Container Handler | v1 | /contentstore/v1/container_handler/{usage_key_string} |
GET | Retrieves detailed vertical container data for a given usage_key_string. Returns a JSON object including display name, type, category, position, collapsible state, URLs for previous/next units, draft and published preview links, course sequence IDs, ancestor xblocks with children, component templates, xblock info, user clipboard content, and flags like is_unit_page and is_fullwidth_content. Supports AI tools in rendering course content dynamically, navigating course structure, and automating content analysis. Path parameter usage_key_string is required. |
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 locating the Container Handler entry point for /contentstore/v1/container_handler/{usage_key_string} and review how its response is assembled. Confirm the endpoint's behavior against the listed container data, navigation links, course structure, templates, clipboard content, and flags; done means the required GET response is available as described.
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