Skip to content

feat: add a POST endpoint for listing courses #35586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
farhaanbukhsh merged 7 commits into from
Aug 21, 2025
Merged

feat: add a POST endpoint for listing courses #35586

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d4d6e01
feat: add a POST endpoint for listing courses
viadanna Oct 1, 2024
267fa98
fix: quality
viadanna Oct 3, 2024
10d390c
Merge branch 'master' into viadanna/course-list-post
viadanna Oct 29, 2024
e81a019
Merge branch 'master' into viadanna/course-list-post
viadanna Mar 20, 2025
283eb54
fix: add api documentation
viadanna Aug 13, 2025
88b4ce6
refactor: break inline if-else
viadanna Aug 21, 2025
6388eb0
Merge branch 'master' into viadanna/course-list-post
viadanna Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lms/djangoapps/course_api/tests/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,18 @@ def test_get_when_no_permission_then_filters_correctly(self):
ids = {c['course_id'] for c in response.json()['results']}
self.assertEqual(ids, {str(self.course.id)})

def test_filter_post(self):
"""Verify that CourseOverviews are filtered by the provided org key in a POST request."""
self.setup_user(self.staff_user)

# Create a second course to be filtered out of queries.
alternate_course = self.create_course(
org=md5(self.course.org.encode('utf-8')).hexdigest()
)

response = self.client.post(self.url, data={'course_keys': str(self.course.id)})
assert all((course['org'] == self.course.org) for course in response.json()['results'])


class CourseDetailViewTestCase(CourseApiTestViewMixin, SharedModuleStoreTestCase):
"""
Expand Down
11 changes: 10 additions & 1 deletion lms/djangoapps/course_api/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,10 @@ def get_queryset(self):
"""
Yield courses visible to the user.
"""
form = CourseListGetForm(self.request.query_params, initial={'requesting_user': self.request.user})
form = CourseListGetForm(
self.request.data if self.request.method == 'POST' else self.request.query_params,
initial={'requesting_user': self.request.user}
)
Comment on lines +344 to +355

@farhaanbukhsh farhaanbukhsh Mar 25, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

       form_data = self.request.data if self.request.method == 'POST' else self.request.query_params
       form = CourseListGetForm(
            form_data,
            initial={'requesting_user': self.request.user}
        )

@xitij2000 xitij2000 Aug 14, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also suggest using standard if-else rather than inline.

@farhaanbukhsh farhaanbukhsh Aug 19, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@viadanna, I think @xitij2000 as a point here, maybe a better solution could be.

form_data = self.request.query_params
if self.request.method == 'POST':
   form_data = self.request.data

@farhaanbukhsh farhaanbukhsh Aug 19, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think?

@viadanna viadanna Aug 21, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@farhaanbukhsh done

if not form.is_valid():
raise ValidationError(form.errors)
return list_courses(
Expand All @@ -356,6 +359,12 @@ def get_queryset(self):
mobile_search=form.cleaned_data.get('mobile_search', False),
)

def post(self, request, *args, **kwargs):
Comment thread
viadanna marked this conversation as resolved.
"""
POST courses filter.
"""
return self.list(request, *args, **kwargs)


class CourseIdListUserThrottle(UserRateThrottle):
"""Limit the number of requests users can make to the course list id API."""
Expand Down