feat: course details and course statuses APIs #6

shadinaif · 2024-04-18T14:47:32Z

Fixes:

fix: Catalog hidden courses are excluded by default
fix: use year_of_birth instead of date_of_birth

New:

feat: course details and course statuses APIs

Course Details

GET /api/fx/courses/v1/courses?page=<pageNumber>&page_size=<pageSize>&tenant_ids=<tenantIds>&search_text=<searchText>&sort=<sortFields>

<pageNumber> (optional): page number used by pagination. If not passed, the first page will be returned
<pageSize> (optional): page size used by pagination. If not passed, it’ll be assumed as 20 records
<tenantIds> (optional): a comma-separated list of the tenant IDs to get the information for. If not provided, the API will assume the list of all accessible tenants by the user
<searchText> (optional): filter to be used against the course display name and code
<sortFields> (optional): sort the result by the given fields. The default is display_name. The value can be one or more fields, with the use of ( - ) to indicate descending sorting (id, self_paced, enrolled_count, active_count, certificates_count, display_name, org)

Examples:

The first page of the list of courses for all accessible tenants

GET /api/fx/courses/v1/courses

The first page of the list of courses for all accessible tenants, sorted by enrolled_count descending then display_name ascending

GET /api/fx/courses/v1/courses&sort=-enrolled_count,display_name

The second page of the list of courses for all accessible tenants, for those having Sh in the display name or code

GET /api/fx/courses/v1/courses?page=2&search_text=Sh

Course Statuses

GET /api/fx/statistics/v1/course_statuses/?tenant_ids=<tenantIds>

Total number of courses per status of course. There are six possible statuses, which are a composition of enrollment type (instructor-paced and self-paced) with status (ongoing, archived, and upcoming):

ongoing: instructor-paced courses that have started but not ended yet
archived: instructor-paced courses that have ended
upcoming: instructor-paced courses that have not started yet
self_ongoing: self-paced courses that have started but not ended yet
self_archived: self-paced courses that have ended
self_upcoming: self-paced courses that have not started yet

<tenantIds> (optional): a comma-separated list of the tenant IDs to get the information for. If not provided, the API will assume the list of all accessible tenants by the user

Examples:

Courses count in all accessible tenants

GET /api/fx/statistics/v1/course_statuses/

Courses count in tenants 1, 4, and 99

GET /api/fx/statistics/v1/course_statuses/?tenant_ids=1,4,99

OmarIthawi

@shadinaif please remove or change the active_count to something else. It's the same as enrolled_count.

OmarIthawi · 2024-04-20T12:29:42Z

futurex_openedx_extensions/dashboard/details/courses.py

+        enrolled_count=Count(Subquery(
+            CourseEnrollment.objects.filter(
+                course_id=OuterRef('id'),
+                is_active=True,
+            ).values('id')
+        ))
+    ).annotate(
+        active_count=Count(Subquery(
+            CourseEnrollment.objects.filter(
+                course_id=OuterRef('id'),
+                is_active=True,
+            ).values('id')
+        ))


@shadinaif this is the same result, but with a different name.

it's the same because the data is not available right now. We'll get it from Clickhouse in another PR. Related issue created

OmarIthawi

Thanks a ton @shadinaif!!

I think this pull request has a bug.

OmarIthawi · 2024-04-22T12:09:05Z

futurex_openedx_extensions/dashboard/views.py

+
+
+class CourseRatingsView(APIView):
+    """View to get the course ratings"""


This says "course ratings" here

naming mistake

OmarIthawi · 2024-04-22T12:09:10Z

futurex_openedx_extensions/dashboard/views.py

+
+    def get(self, request, *args, **kwargs):
+        """
+        GET /api/fx/statistics/v1/course_ratings/?tenant_ids=<tenantIds>


same mistake

futurex_openedx_extensions/dashboard/views.py

OmarIthawi · 2024-04-25T14:09:23Z

still haven't finished reviewing it, will try to do that do by tomorrow morning

OmarIthawi

Works! Thanks a ton @shadinaif! Let's merge this and ship it to production!

OmarIthawi · 2024-05-16T06:41:20Z

@shadinaif this has been deployed to production. Should we merge it?

shadinaif force-pushed the shadinaif/courses-apis branch 5 times, most recently from 9d60241 to 649888c Compare April 19, 2024 15:31

shadinaif marked this pull request as ready for review April 19, 2024 15:32

shadinaif requested a review from OmarIthawi April 19, 2024 15:32

shadinaif force-pushed the shadinaif/courses-apis branch from 649888c to 9810839 Compare April 19, 2024 15:46

shadinaif added 2 commits April 19, 2024 18:51

fix: requirements on Python 3.8 instead of 3.10

fccfea5

fix: code quality issues

8adc75b

shadinaif force-pushed the shadinaif/courses-apis branch 2 times, most recently from e437a66 to 6e63620 Compare April 19, 2024 16:00

OmarIthawi approved these changes Apr 20, 2024

View reviewed changes

shadinaif force-pushed the shadinaif/courses-apis branch 2 times, most recently from 63fe821 to 365cbb0 Compare April 21, 2024 06:26

shadinaif changed the title ~~feat: course details API~~ feat: course details and course statuses APIs Apr 21, 2024

shadinaif linked an issue Apr 21, 2024 that may be closed by this pull request

bug: SREI production instance shows all courses count even if they're for testing purposes #7

Closed

shadinaif force-pushed the shadinaif/courses-apis branch from 141ca1d to 2a161ca Compare April 21, 2024 11:57

OmarIthawi requested changes Apr 22, 2024

View reviewed changes

shadinaif added 4 commits April 22, 2024 16:02

feat: course details and course statuses APIs

5c1c0c8

fix: Catalog hidden courses are excluded by default

6667f40

fix: use year_of_birth instead of date_of_birth

8d36a64

feat: bump version to 0.2.0

a5b1fdd

shadinaif force-pushed the shadinaif/courses-apis branch from 1e8c7f4 to a5b1fdd Compare April 22, 2024 13:02

shadinaif requested a review from OmarIthawi April 25, 2024 07:28

OmarIthawi approved these changes May 1, 2024

View reviewed changes

shadinaif merged commit 35846cc into main May 20, 2024
2 checks passed

shadinaif deleted the shadinaif/courses-apis branch May 20, 2024 10:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: course details and course statuses APIs #6

feat: course details and course statuses APIs #6

shadinaif commented Apr 18, 2024 •

edited

Loading

OmarIthawi left a comment

OmarIthawi Apr 20, 2024

shadinaif Apr 21, 2024

OmarIthawi left a comment

OmarIthawi Apr 22, 2024

shadinaif Apr 22, 2024

OmarIthawi Apr 22, 2024

shadinaif Apr 22, 2024

OmarIthawi commented Apr 25, 2024

OmarIthawi left a comment

OmarIthawi commented May 16, 2024



		class CourseRatingsView(APIView):
		"""View to get the course ratings"""

feat: course details and course statuses APIs #6

feat: course details and course statuses APIs #6

Conversation

shadinaif commented Apr 18, 2024 • edited Loading

Course Details

Course Statuses

OmarIthawi left a comment

Choose a reason for hiding this comment

OmarIthawi Apr 20, 2024

Choose a reason for hiding this comment

shadinaif Apr 21, 2024

Choose a reason for hiding this comment

OmarIthawi left a comment

Choose a reason for hiding this comment

OmarIthawi Apr 22, 2024

Choose a reason for hiding this comment

shadinaif Apr 22, 2024

Choose a reason for hiding this comment

OmarIthawi Apr 22, 2024

Choose a reason for hiding this comment

shadinaif Apr 22, 2024

Choose a reason for hiding this comment

OmarIthawi commented Apr 25, 2024

OmarIthawi left a comment

Choose a reason for hiding this comment

OmarIthawi commented May 16, 2024

shadinaif commented Apr 18, 2024 •

edited

Loading