Updated Canvas API Documentation

[RohitJain]

Recently when sending Canvas api requests for quiz question creation I got to know that the Canvas Documentation have incorrect/missing definitions for some of the fields.
For ex -
QuizQuestions API doc shows the usage of 'blank_id' field in Answer object which is an Integer but I confirmed that it can be better used as a String (verified this by sending a curl request).
QuizQuestions API doc also doesn't shows many fields like correct_comments_html, incorrect_comments_html, neutral_comments_html which can also be used when creating questions. I got to know about these additional fields when I sent a Get QuizQuestion request.
I do see that these docs were updated recently (Jun 14th 2023, can be seen at the bottom of the documentation page) and there are no open issues on the linked Github page for the issues I am seeing. Are there any other updated documentation page Canvas has?

[KristenLuke]

Hello @RohitJain , 

Thank you for contacting the Instructure Community regarding your questions about the Quiz Questions section of our REST API documentation. For your first question, the 'blank_id' field in the Quiz Questions, Answer object in our REST API is not specified as being either an integer nor a string : Quiz Questions - Canvas LMS REST API Documentation . There are some similar fields in the Quiz Questions section that are specified as integers. For example, "quiz_group_id" or "id", are specified as integers. The field, "blank_id" is not specified as being either an integer or a string. Let me know if you are seeing something different on your end. 

Regarding your concern that the REST API documentation does not discuss the following fields: "correct_comments_html", "incorrect_comments_html", "neutral_comments_html"; I have sent this information to engineering. I have also sent the question concerning the "blank_id" field to our engineering team as well. 

I hope this helps ! Again, thank you for reaching out to the Instructure Community. 

[KristenLuke]

I hope this helps ! Again, thank you for reaching out to the Instructure Community. 

[RohitJain]

Thanks for the prompt reply. A couple of follow up questions on 'blank_id' -

• Canvas Live API does mention the data type as Integer - https://ata.instructure.com/doc/api/live#!/quiz_questions.json/create_single_quiz_question_post_2. Is that incorrect? Or should that not be used as a source of truth? If so, could it be possible to fix that asap as it is causing confusion.
• Why is there no field defined for it in the official documentation? Are there any special reasons for that?

Again, thanks for taking this up to Engineering. Will be eager to hear more from them.