feat: add a POST endpoint for listing courses #35586
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @viadanna! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
mphilbrick211
added
the
needs reviewer assigned
|
Hi @viadanna! Looks like a few additional tests popped up. Can you see if you can run them? |
mphilbrick211
removed
the
needs reviewer assigned
|
Sure thing, done @mphilbrick211 |
mphilbrick211
added
the
needs reviewer assigned
|
Apologies, @viadanna - but there's an additional test that needs to be run. Thank you for your patience. I've put this pull request out to our Core Contributors for review. |
| @@ -356,6 +359,12 @@ def get_queryset(self): | |||
| mobile_search=form.cleaned_data.get('mobile_search', False), | |||
| ) | |||
|
|
|||
| def post(self, request, *args, **kwargs): | |||
There was a problem hiding this comment.
could you add a docstring here so that the generated OpenAPI/Swagger will have an explanation?
There was a problem hiding this comment.
Hi, @deborahgu, it's the same as the GET endpoint. I've added the POST example to the class docstring, is that good enough?
There was a problem hiding this comment.
Hi, @deborahgu, it's the same as the GET endpoint. I've added the POST example to the class docstring, is that good enough?
There was a problem hiding this comment.
the class docstring would be fine but I don't see it there -- am I missing it? Just explaining what should be in the payload would be good.
There was a problem hiding this comment.
Sorry @deborahgu I missed pushing the changes. However, I found an issue with the implementation and will have to re-work it. I'll mark this as a draft for the time being.
viadanna
changed the title
farhaanbukhsh
changed the title
There was a problem hiding this comment.
@viadanna I have added one nit but it looks good overall, we should add api documentation so that is shows well in api-docs i.e https://github.com/openedx/edx-platform/blob/master/docs/lms-openapi.yaml
| form = CourseListGetForm( | ||
| self.request.data if self.request.method == 'POST' else self.request.query_params, | ||
| initial={'requesting_user': self.request.user} | ||
| ) |
There was a problem hiding this comment.
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}
)
Description
This pull request introduces functionality to filter courses using a POST request in the course API. The reason for this is to be able to able to use a filter larger than allowed in GET query params.
The key changes include adding a new test for POST request filtering, modifying the
get_querysetmethod to handle POST data, and adding a POST method to the view.Testing instructions
/api/courses/v1/courses/to query for courses.Deadline
"None" if there's no rush, or provide a specific date or event (and reason) if there is one.