openedx / openedx/openedx-platform
[API] Containers
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: Containers
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Content Management | v1 | /contentstore/v1/container/{usage_key_string}/children |
GET | Retrieves the children of a container/vertical block in a course. Returns a JSON object with children array (including name, block_id, block_type, user_partition_info, upstream_link, actions, validation_messages, render_error), is_published, can_paste_component, display_name, and upstream_ready_to_sync_children_info. Useful for AI or external tools analyzing course structure, component readiness, or automating content synchronization. |
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 Content Management v1 implementation for /contentstore/v1/container/{usage_key_string}/children and review related container endpoints. The issue does not name files, tests, or a specific requested change; clarify whether the goal is to add, expose, or document this endpoint, then verify the response contains the listed children and container fields.
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
- 38/100