Skip to content

Added beta support for Canvas SmartSearch API (Issue #659) #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

alportoricensis
Copy link

Proposed Changes

  • Added beta support for Canvas' SmartSearch API (https://canvas.instructure.com/doc/api/smart_search.html#SearchResult), as requested in Add API coverage for SmartSearch #659.
  • Included a smartsearch method within course.py to handle requests to the SmartSearch API
  • Created SearchResult subclass within searchresult.py to adapt different responses from the SmartSearch API (which can return a page, an assignment, etc.) to existing CanvasAPI classes (Page, Assignment, etc.). Took into account extensibility and raising ValueErrors as the API is experimental and breaking changes could occur.
  • Added tests for both additions, maintaining 100% statement coverage

Fixes #659.

This was completed as part of Homework #6 of EECS 481, Software Engineering, at The University of Michigan, which requires students to create a pull request for an open-source project. For more information, see https://eecs481.org/hw6.html.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add API coverage for SmartSearch
1 participant