Unit extensions API v2 for instructors dashboard #37783

holaontiveros · 2025-12-17T20:40:18Z

Description

Adds a new endpoint to get the unit_extensions for a course that will be used on the new instructor dashboard
Modifies an utility function that needed to ignore values to unpack
Updates edx-when from 3.0.0 to 3.1.0 that has the data required for the new endpoint to import

Supporting information

Testing instructions

Make sure you have a valid course blocks that can be considered for an extension
Use the example curl request to test

example curl to test, make sure you have the right cookies and update the right IDs and details

curl --location --request GET 'http://local.openedx.io:8000/api/instructor/v2/courses/course-v1:OEXCOM+101+2025_T1/unit_extensions' \
--header 'Accept: application/json, text/javascript, */*; q=0.01' \
--header 'Referer: http://local.openedx.io:8000/courses/course-v1:OEXCOM+101+2025_T1/instructor' \
--header 'Content-Type: application/json' \
--data-raw '{
    "block_id": "block-v1:OEXCOM+101+2025_T1+type@sequential+block@c3ccd3d1f91b42dfb2bff8185dba4d3b",
    "email_or_username": "javier",
    "due_datetime": "12/12/2025 12:12",
    "reason": "Just because"
}'

a possible valid example of response of the query looks like:

{
    "next": null,
    "previous": null,
    "count": 2,
    "num_pages": 1,
    "current_page": 1,
    "start": 0,
    "results": [
        {
            "username": "armando",
            "full_name": "",
            "email": "armando.ontiveros@wgu.edu",
            "unit_title": "Subsection",
            "unit_location": "block-v1:OEXCOM+101+2025_T1+type@sequential+block@c3ccd3d1f91b42dfb2bff8185dba4d3b",
            "extended_due_date": "2026-12-28T00:00:00Z"
        },
        {
            "username": "javier",
            "full_name": "",
            "email": "javier.ontiveros@wgu.edu",
            "unit_title": "Subsection",
            "unit_location": "block-v1:OEXCOM+101+2025_T1+type@sequential+block@c3ccd3d1f91b42dfb2bff8185dba4d3b",
            "extended_due_date": "2025-12-12T12:12:00Z"
        }
    ]
}

Deadline

None

Other information

Include anything else that will help reviewers and consumers understand the change.

Requires feat: add course overrides listings for unit extensions v2 edx-when#345 to be released

openedx-webhooks · 2025-12-17T20:40:22Z

Thanks for the pull request, @holaontiveros!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

…rom breaking

lms/djangoapps/instructor/views/tools.py

lms/djangoapps/instructor/tests/test_api_v2.py

lms/djangoapps/instructor/views/api_v2.py

wgu-taylor-payne · 2026-01-13T23:35:42Z

lms/djangoapps/instructor/views/api_v2.py

+
+        return extension_data
+
+    def list(self, request, *args, **kwargs):


Perhaps rather than override list, we could just override filter_queryset to return the queryset passed into it.

Removing list and not overriding filter_queryset works without error because there are no default filters in place. I think it would be good to explicitly set filter_backends = [] on the class.

Sorry, I didn't see this comment for some reason. I added filter_backends = []. Thanks

lms/djangoapps/instructor/views/api_v2.py

- Adjust tests for more consistent behavior - Add UnitDueDateExtension as a data interface - Reduce code duplication

dwong2708 · 2026-01-17T01:17:11Z

@wgu-taylor-payne I believe I’ve addressed all the comments. Could you please take another look?

…nsions_v2

lms/djangoapps/instructor/tests/test_api_v2.py

wgu-taylor-payne · 2026-01-21T00:11:49Z

lms/djangoapps/instructor/tests/test_api_v2.py

+        self.assertEqual(len(results), 2)
+
+        # If there are results, verify the structure
+        extension = results[1]


I'm getting instructor data for results[0]. Is that expected?

results[1] is the expected

I'm trying to figure out exactly what we expect in this test result. We set up the test class:

course (course) chapter (section) sequential (subsection) - Due Dec 31, 2024 # I don't think this original due date is used vertical (unit) problem

Before each test we setup:

# set users add instructor, staff to course enroll student1 and student2 # set due dates for course elements sequential - Mar 22, 2019 vertical - Mar 23, 2019 problem - Mar 24, 2019 # set extensions instructor - subsection - April 1, 2019 # are extensions typically set for instructors or is this just contrived? student1 - vertical - April 2, 2019 student1 - subsection - April 2, 2019 student2 - problem - April 3, 2019

So, we set up four extensions on the course, and then we only get two back in the response:

{ "next": null, "previous": null, "count": 2, "num_pages": 1, "current_page": 1, "start": 0, "results": [ { "username": "robot0", "full_name": "Robot0 Instructor", "email": "robot+test+0@edx.org", "unit_title": "Homework 1", "unit_location": "block-v1:edX+TestX+Test_Course+type@sequential+block@Homework_1", "extended_due_date": "2019-04-01T00:00:00Z" }, { "username": "student1", "full_name": "Robot2 Test", "email": "student1@example.com", "unit_title": "Homework 1", "unit_location": "block-v1:edX+TestX+Test_Course+type@sequential+block@Homework_1", "extended_due_date": "2019-04-02T00:00:00Z" } ] }

Is that what we want? Coming into this test without much context around dates and extensions, it's a bit confusing to me.

I adjusted this important test to improve clarity. I also added comments to better explain the code. As far as I understand, the test should work as described below.

Setup

Course structure

course

chapter (section)

vertical (unit)

problem

Users

Add instructor and staff to the course

Enroll student1 and student2

Due dates

sequential: Dec 31, 2024

vertical: Dec 31, 2024

problem: Dec 31, 2024

Extensions

student1 – subsection – Oct 31, 2025

student2 – subsection – Nov 30, 2025

student2 – subsection – Dec 31, 2025

Expected behavior

The first and third extensions should be included in the resulting list, because only the top-level unit with a due date (the subsection) is considered when determining which extensions apply.

…nsions_v2

wgu-taylor-payne

Here is one more suggestion I have.

lms/djangoapps/instructor/views/api_v2.py

…nsions_v2

wgu-taylor-payne

Thanks for the update, I think that brings more clarity to the code. Could you please address these remaining items of feedback #37783 and #37783.

…enedx#37939) Referenced GH team names have been updated accordingly as well. Closes: openedx#37904

chore: base work for unit extensions v2 api

6c87142

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 17, 2025

openedx-webhooks added this to Contributions Dec 17, 2025

github-project-automation bot moved this to Needs Triage in Contributions Dec 17, 2025

chore: fix pylint things

a2e3566

mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Dec 19, 2025

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Dec 19, 2025

holaontiveros added 5 commits January 8, 2026 14:25

chore: update to match edx-when comments

dd4b7eb

chore: update edx_when version

43deb2a

chore: restore old version before upgrade with make

7a98a89

chore: update with make upgrade-package package=edx-when

4913b98

chore: exclude extras from get_overrides_for_block to prevent tuple f…

55eef0e

…rom breaking

holaontiveros force-pushed the feature/unit_extensions_v2 branch from b4b3387 to 55eef0e Compare January 12, 2026 15:24

Merge branch 'master' into feature/unit_extensions_v2

1b9a193

holaontiveros marked this pull request as ready for review January 12, 2026 16:31

holaontiveros requested review from dwong2708, rodmgwgu and wgu-taylor-payne January 12, 2026 16:36

holaontiveros changed the title ~~[WIP] Unit extensions API v2 for instructors dashboard~~ Unit extensions API v2 for instructors dashboard Jan 12, 2026

wgu-taylor-payne reviewed Jan 13, 2026

View reviewed changes

dwong2708 suggested changes Jan 14, 2026

View reviewed changes

lms/djangoapps/instructor/views/api_v2.py Outdated Show resolved Hide resolved

lms/djangoapps/instructor/views/api_v2.py Show resolved Hide resolved

dwong2708 added 2 commits January 15, 2026 12:18

Merge branch 'master' into feature/unit_extensions_v2

0e9ea9e

feat: address review comments

9c95a16

- Adjust tests for more consistent behavior - Add UnitDueDateExtension as a data interface - Reduce code duplication

dwong2708 requested a review from wgu-taylor-payne January 17, 2026 01:15

dwong2708 and others added 3 commits January 20, 2026 13:55

Merge remote-tracking branch 'upstream/master' into feature/unit_exte…

000a598

…nsions_v2

chore: fixed lint issue

d31fd52

Merge remote-tracking branch 'upstream/master' into feature/unit_exte…

9395de4

…nsions_v2

wgu-taylor-payne reviewed Jan 21, 2026

View reviewed changes

dwong2708 added 2 commits January 21, 2026 18:24

fix: apply review feedback to unit extensions tests

c94aa75

Merge remote-tracking branch 'upstream/master' into feature/unit_exte…

bb3d608

…nsions_v2

dwong2708 requested a review from wgu-taylor-payne January 22, 2026 00:27

mphilbrick211 moved this from Waiting on Author to In Eng Review in Contributions Jan 22, 2026

wgu-taylor-payne reviewed Jan 23, 2026

View reviewed changes

lms/djangoapps/instructor/views/api_v2.py Outdated Show resolved Hide resolved

dwong2708 added 2 commits January 26, 2026 11:47

refactor: simplify result filtering

41cb3fa

Merge remote-tracking branch 'upstream/master' into feature/unit_exte…

05fe9be

…nsions_v2

dwong2708 requested a review from wgu-taylor-payne January 26, 2026 17:49

wgu-taylor-payne reviewed Jan 26, 2026

View reviewed changes

dwong2708 requested a review from wgu-taylor-payne January 26, 2026 23:28

dwong2708 and others added 2 commits January 26, 2026 17:41

tests: update test_get_unit_extensions

691c2b8

build: Update README, CODEOWNERS, catalog-info with new repo name (op…

511e8eb

…enedx#37939) Referenced GH team names have been updated accordingly as well. Closes: openedx#37904

dwong2708 force-pushed the feature/unit_extensions_v2 branch from 47a2097 to 511e8eb Compare January 26, 2026 23:44

Merge branch 'master' into feature/unit_extensions_v2

e55a4b7


		return extension_data

		def list(self, request, args, *kwargs):

Unit extensions API v2 for instructors dashboard #37783

Are you sure you want to change the base?

Unit extensions API v2 for instructors dashboard #37783

Conversation

holaontiveros commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other information

Uh oh!

openedx-webhooks commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wgu-taylor-payne Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

wgu-taylor-payne Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wgu-taylor-payne Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dwong2708 commented Jan 17, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wgu-taylor-payne Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

wgu-taylor-payne Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Jan 26, 2026

Choose a reason for hiding this comment

Setup

Course structure

Users

Due dates

Extensions

Expected behavior

Uh oh!

wgu-taylor-payne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wgu-taylor-payne left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

holaontiveros commented Dec 17, 2025 •

edited

Loading

openedx-webhooks commented Dec 17, 2025 •

edited

Loading

wgu-taylor-payne Jan 20, 2026 •

edited

Loading