Skip to content

Conversation

@oksana-slu
Copy link
Contributor

@oksana-slu oksana-slu commented Sep 20, 2023

Description

The pagination is necessary for UserCourseEnrollmentsList to optimize course loading in the mobile app.
The pagination for this endpoint was introduced along with a new version (v3) of the mobile API.

Supporting information

This contribution is done as a part of the project FC-0031

Testing instructions

api/mobile endpoints are now available with v3 api version.

GET /api/mobile/v3/users/<user_name>/course_enrollments/, and see the Default Pagination fields, as count, num_pages, current_page, results in the response.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 20, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 20, 2023

Thanks for the pull request, @oksana-slu! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@KyryloKireiev KyryloKireiev force-pushed the rg/feat/FC0031/add_pagination_in_user_course_enrollments branch from 0f8e29e to 6ed7a38 Compare September 22, 2023 10:13
@oksana-slu oksana-slu force-pushed the rg/feat/FC0031/add_pagination_in_user_course_enrollments branch 3 times, most recently from a62bad8 to 4db3131 Compare September 25, 2023 11:38
@oksana-slu oksana-slu marked this pull request as ready for review September 25, 2023 11:39
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 2, 2023
Copy link
Contributor

@feanil feanil left a comment

Choose a reason for hiding this comment

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

Couple of comments inline. Generally, I wonder if overloading all the API versions into one class still makes sense or if we should make a new API class that calls the same underlying business logic functions. This way the DRF machinery is better separated from the shared business logic. It will duplicate the comments a bit but given that there are changes between API versions and we're not updating the view docstring, maybe it would make that sort of thing easier to catch.

@feanil
Copy link
Contributor

feanil commented Nov 16, 2023

@GlugovGrGlib I think this is good to go but we should update the docs/comment as suggested above first.

@feanil
Copy link
Contributor

feanil commented Nov 20, 2023

Let me know when that's done and I can coordinate merging it.

@GlugovGrGlib
Copy link
Member

Let me know when that's done and I can coordinate merging it.

This will be updated today, thanks!

@GlugovGrGlib GlugovGrGlib force-pushed the rg/feat/FC0031/add_pagination_in_user_course_enrollments branch from 403b9e3 to 95fcb12 Compare November 20, 2023 20:40
@miankhalid miankhalid requested a review from moeez96 November 21, 2023 06:12
@feanil feanil merged commit a958097 into openedx:master Nov 27, 2023
@openedx-webhooks
Copy link

@oksana-slu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project
Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants