openedx / openedx/openedx-platform
[API] Course Index
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: Course Index
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Course Outline | v1 | /contentstore/v1/course_index/{course_id} |
GET | Retrieves the course outline/index for a given course ID. Returns JSON including course release date, course structure, deprecated blocks info, proctoring URLs, discussions links, initial state of expanded locators, initial user clipboard, LMS link, reindex link, notification IDs, and custom relative dates status. Optional query parameter show can set initial expanded state of the outline. Supports AI tools in visualizing course hierarchy, analyzing course structure, or dynamically rendering content navigation. |
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 implementation of the Course Index endpoint at /contentstore/v1/course_index/{course_id} and checking how its API documentation is maintained. Confirm the documented response fields, optional show parameter, and supported behavior against the endpoint. Done means the Course Index API documentation is complete and accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100