Update docs to include LTIResourceLink. Update authors and changelog

ucfopen · Dec 9, 2024 · e001286 · e001286
1 parent dd38ca9
commit e001286
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -53,6 +53,7 @@
 - Ian Altgilbers [@altgilbers](https://github.com/altgilbers)
 - Ian Turgeon [@iturgeon](https://github.com/iturgeon)
 - [@jackrsteiner](https://github.com/jackrsteiner)
+- Jasmine Hou [@jsmnhou](https://github.com/jsmnhou)
 - John Raible [@rebelaide](https://github.com/rebelaide)
 - Joon Ro [@joonro](https://github.com/joonro)
 - Jonah Majumder [@jonahmajumder](https://github.com/jonahmajumder)

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+### New Endpoint Coverage
+
+- LTI Resource Links (Thanks, [@jsmnhou](https://github.com/jsmnhou))
+
 ### Backstage
 
 - Updated deploy Action to use more modern processes.

diff --git a/canvasapi/course.py b/canvasapi/course.py
@@ -446,8 +446,6 @@ def create_lti_resource_link(self, url, title=None, custom=None, **kwargs):
         :calls: `POST /api/v1/courses/:course_id/lti_resource_links \
         <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.create>`_
 
-        :param course_id: The ID of the course.
-        :type course_id: `int`
         :param url: The launch URL for the resource link.
         :type url: `str`
         :param title: The title of the resource link.
@@ -1712,7 +1710,8 @@ def get_lti_resource_links(self, **kwargs):
         :calls: `GET /api/v1/courses/:course_id/lti_resource_links \
         <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.index>`_
 
-        :rtype: :class:`canvasapi.paginated_list.PaginatedList`
+        :rtype: :class:`canvasapi.paginated_list.PaginatedList` of
+            :class:`canvasapi.lti_resource_link.LTIResourceLink`
         """
 
         return PaginatedList(

diff --git a/docs/class-reference.rst b/docs/class-reference.rst
@@ -41,6 +41,7 @@ Class Reference
     jwt-ref
     login-ref
     license-ref
+    lti-resource-link-ref
     module-ref
     outcome-ref
     outcome-import-ref

diff --git a/docs/lti-resource-link-ref.rst b/docs/lti-resource-link-ref.rst
@@ -0,0 +1,6 @@
+===============
+LTIResourceLink
+===============
+
+.. autoclass:: canvasapi.lti_resource_link.LTIResourceLink
+    :members: