Skip to content

Commit 78c2b0e

Browse files
authored
Merge pull request #76 from penzance/task/elliottyates/tlt-2900/get_single_course_courses_fix
TLT-2900: regenerated get_single_course_courses
2 parents d095a05 + 590b633 commit 78c2b0e

2 files changed

Lines changed: 15 additions & 6 deletions

File tree

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.10
1+
0.10.1

canvas_sdk/methods/courses.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ def update_course_settings(request_ctx, course_id, allow_student_discussion_topi
512512
return response
513513

514514

515-
def get_single_course_courses(request_ctx, id, include, **request_kwargs):
515+
def get_single_course_courses(request_ctx, id, include=None, **request_kwargs):
516516
"""
517517
Return information on a single course.
518518
@@ -522,18 +522,27 @@ def get_single_course_courses(request_ctx, id, include, **request_kwargs):
522522
:type request_ctx: :class:RequestContext
523523
:param id: (required) ID
524524
:type id: string
525-
:param include: (required) - "all_courses": Also search recently deleted courses. - "permissions": Include permissions the current user has for the course.
526-
:type include: string
525+
:param include: (optional)
526+
- "all_courses": Also search recently deleted courses.
527+
- "permissions": Include permissions the current user has
528+
for the course.
529+
- "observed_users": include observed users in the enrollments
530+
:type include: array or None
527531
:return: Get a single course
528532
:rtype: requests.Response (with Course data)
529533
530534
"""
531535

532-
include_types = ('all_courses', 'permissions')
536+
include_types = (
537+
'needs_grading_count', 'syllabus_body', 'public_description',
538+
'total_scores', 'current_grading_period_scores', 'term',
539+
'course_progress', 'sections', 'storage_quota_used_mb',
540+
'total_students', 'passback_status', 'favorites', 'teachers',
541+
'observed_users', 'all_courses', 'permissions', 'observed_users')
533542
utils.validate_attr_is_acceptable(include, include_types)
534543
path = '/v1/courses/{id}'
535544
payload = {
536-
'include[]' : include,
545+
'include': include,
537546
}
538547
url = request_ctx.base_api_url + path.format(id=id)
539548
response = client.get(request_ctx, url, payload=payload, **request_kwargs)

0 commit comments

Comments
 (0)