This project parses the Swagger specification for the Instructure Canvas learning management system API to generate a PowerShell client for Canvas. Use at your own risk, or contribute to the project and make it better!
Forked from the CanvasApis project by Spencer Varney (squid808). Kudos to Spencer!
No. You'll have to generate it yourself for now.
Clone this repository. Open the Convert-CanvasApiToPowershell.ps1 file, and call Convert-CanvasApiToPowershell. The cmdlet will return the generated document so you can do with it whatever you'd like, for instance:
PS C:> . .\Convert-CanvasApiToPowershell.ps1
PS C:> $Generated = Convert-CanvasApiToPowershell
PS C:> $Generated | Out-File ".\CanvasApi.ps1"
#or
PS C:> $Generated | Set-Clipboard
Then run one of the methods, and it should work. If not, this is open source. Let me know or fix it yourself :)
This script automates the creation of a Powershell client for the Instructure Canvas learning management system. It parses the Canvas Swagger API Specificaqtion and converts the data into PowerShell cmdlets.
At the time of writing, the result should be considered 'usable'. If not, this is open source. Let me know or fix it yourself :)
This script contains the primary authentication bits and API calls for the main Canvas API. This will be combined in to the generated document.
This script contains wrappers for the Canvas Data API and some companion functions that can be used to ease the burden of working with the Canvas Data APIs.
Good luck, and enjoy!
Apparently to upload files for things like the SIS import you may need to handle the uploading outside of the generic methods provided by PowerShell; this is to allow the uploading of both params and files for a multipart/form-data request. For an example on how to handle this, please see a manually corrected version of Post-CanvasSisImports in this Gist for Post-CanvasSisImports. Again, please note that this kind of method handling would be needed for any functions wherein you are uploading files, though I have not tested any others.
If you only need to upload a file with no params, you can simply use Invoke-Webrequest with the -InFile param.