Skip to main content

Course Outline API Plugin

A django app plugin to add a new API to Open edX that returns a course outline summary (one entry per chapter) for a given course.

Version Compatibility

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installation

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

  • LMS

How To Use

The API supports a GET call to:

  • <LMS_BASE>/api/ol-course-outline/v0/<course_id>/

The endpoint is protected by the platform API auth and requires an admin user (DRF IsAdminUser).

The successful response for http://local.openedx.io:8000/api/ol-course-outline/v0/course-v1:edX+DemoX+Demo_Course/ would look like:

{
    "course_id": "course-v1:edX+DemoX+Demo_Course",
    "generated_at": "2026-03-17T12:34:56Z",
    "modules": [
        {
            "id": "block-v1:edX+DemoX+Demo_Course+type@chapter+block@1414ffd5143b4b5",
            "title": "Example Week 1: Getting Started",
            "effort_time": 121,
            "effort_activities": 1,
            "counts": {
                "videos": 5,
                "readings": 3,
                "problems": 2,
                "assignments": 1,
                "app_items": 0
            }
        }
    ]
}

Notes

  • generated_at is the timestamp when the outline was built (cached responses return the same value).

  • effort_time and effort_activities come from the platform Effort Estimation transformer via the Blocks API.

  • counts are computed by walking the Blocks API tree under each chapter (staff-only blocks are excluded): - videos: blocks with type video - readings: blocks with type html - problems: blocks with type problem - assignments: sequential blocks that are graded or have a non-empty format (except notgraded) - app_items: leaf blocks that are not video, html, or problem (and not container types)

Caching

This endpoint caches the full JSON response using Django’s configured cache backend.

  • TTL: configurable via OL_COURSE_OUTLINE_API_CACHE_TIMEOUT_SECONDS (default: 1 week).

  • Cache key: <prefix>s<schema_version>:<course_key>:<content_version>. - prefix is configurable via OL_COURSE_OUTLINE_API_CACHE_KEY_PREFIX (default: ol_course_outline_api:outline:v0:). - schema_version is a plugin constant (bump it when you change the response shape or computation logic). - content_version is course.course_version when present; otherwise the key uses na.

  • Invalidation: - Publishing a course that updates course.course_version produces a new cache key, effectively invalidating old entries.

Troubleshooting

  • Page not found (404): ensure the plugin is installed in the LMS and the URLs are registered.

  • Course ID in the URL: course keys contain +. Use URL-encoded form (%2B) when needed, e.g. /api/ol-course-outline/v0/course-v1:OpenedX%2BDemoX%2BDemoCourse/.

Metadata

Release files for ol-openedx-course-outline-api 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ol-openedx-course-outline-api 0.2.1
File Size Uploaded Provenance Actions
ol_openedx_course_outline_api-0.2.1.tar.gz 7.0 kB Without provenance Details for ol_openedx_course_outline_api-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ol-openedx-course-outline-api 0.2.1
File Interpreter ABI Platform Actions
ol_openedx_course_outline_api-0.2.1-py3-none-any.whl Python 3 none any Details for ol_openedx_course_outline_api-0.2.1-py3-none-any.whl

Total release size: 17.2 kB

Release files / ol_openedx_course_outline_api-0.2.1.tar.gz

Download URL ol_openedx_course_outline_api-0.2.1.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
7359b4a181084e110ad24001ec799e4eb60690bbd020112e5fbac0332ea2fd01
BLAKE2b-256 checksum
How to use checksums
c16e42d7e46f3e2e3d1aec586cb7c5902480e21faabf18cfb33b425e80ec3929
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / ol_openedx_course_outline_api-0.2.1-py3-none-any.whl

Download URL ol_openedx_course_outline_api-0.2.1-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d56340877cbe9b86520d7ba73ee9e618979520afec2d7921d6318e9b66e28723
BLAKE2b-256 checksum
How to use checksums
2249879b4319ba9ac9da86d0864cced34d18b88d5ed694b86e93296082c0d6e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for ol-openedx-course-outline-api 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page