Skip to content

Commit e001286

Browse files
committed
Update docs to include LTIResourceLink. Update authors and changelog
1 parent dd38ca9 commit e001286

File tree

5 files changed

+14
-3
lines changed

5 files changed

+14
-3
lines changed

AUTHORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
- Ian Altgilbers [@altgilbers](https://github.com/altgilbers)
5454
- Ian Turgeon [@iturgeon](https://github.com/iturgeon)
5555
- [@jackrsteiner](https://github.com/jackrsteiner)
56+
- Jasmine Hou [@jsmnhou](https://github.com/jsmnhou)
5657
- John Raible [@rebelaide](https://github.com/rebelaide)
5758
- Joon Ro [@joonro](https://github.com/joonro)
5859
- Jonah Majumder [@jonahmajumder](https://github.com/jonahmajumder)

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## [Unreleased]
44

5+
### New Endpoint Coverage
6+
7+
- LTI Resource Links (Thanks, [@jsmnhou](https://github.com/jsmnhou))
8+
59
### Backstage
610

711
- Updated deploy Action to use more modern processes.

canvasapi/course.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -446,8 +446,6 @@ def create_lti_resource_link(self, url, title=None, custom=None, **kwargs):
446446
:calls: `POST /api/v1/courses/:course_id/lti_resource_links \
447447
<https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.create>`_
448448
449-
:param course_id: The ID of the course.
450-
:type course_id: `int`
451449
:param url: The launch URL for the resource link.
452450
:type url: `str`
453451
:param title: The title of the resource link.
@@ -1712,7 +1710,8 @@ def get_lti_resource_links(self, **kwargs):
17121710
:calls: `GET /api/v1/courses/:course_id/lti_resource_links \
17131711
<https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.index>`_
17141712
1715-
:rtype: :class:`canvasapi.paginated_list.PaginatedList`
1713+
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
1714+
:class:`canvasapi.lti_resource_link.LTIResourceLink`
17161715
"""
17171716

17181717
return PaginatedList(

docs/class-reference.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Class Reference
4141
jwt-ref
4242
login-ref
4343
license-ref
44+
lti-resource-link-ref
4445
module-ref
4546
outcome-ref
4647
outcome-import-ref

docs/lti-resource-link-ref.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
===============
2+
LTIResourceLink
3+
===============
4+
5+
.. autoclass:: canvasapi.lti_resource_link.LTIResourceLink
6+
:members:

0 commit comments

Comments
 (0)