OpenAPI specification for the Canvas API

323 views
Skip to first unread message

Laura

unread,
Jun 17, 2023, 7:45:21 AM6/17/23
to Canvas LMS Users
Hi there, 

tl;dr: I need help/advice on how to best deal with the Canvas API pagination and correct errors in the OpenAPI specification I wrote. 

I created an OpenAPI specification for the Canvas API (available on GitLab). I needed it to generate a client library in Haskell for the Canvas API using a code generator. There are generators available in lots of languages (here). With the OpenAPI specification, it should be easy for anyone to (very) quickly create a client library in any desired language. 

My specification follows the OpenAPI format 3.0. I was able to create it from the Canvas OpenAPI version 2.0, created by Matthew Buckett (here). I converted it to 3.0. Unexpectedly, there were quite a lot of errors, and I have corrected those for a small subset of endpoints. 

Now I would like to automate the creation of this OpenAPI specification (since it becomes outdated anytime there is an update to the Canvas API). Also, this should fix the errors contained in the untested endpoints. However, I would like to ask about how to best deal with the pagination and if there are any further resources other than the Canvas API documentation to help me with this. 

Thanks in advance, 
Laura Schauer


Reply all
Reply to author
Forward
0 new messages