instructure / canvas-lms

The open LMS by Instructure, Inc.
https://github.com/instructure/canvas-lms/wiki
GNU Affero General Public License v3.0
5.41k stars 2.42k forks source link

API documentation - RubricCriterion reference is inconsistent #2298

Open onomou opened 6 months ago

onomou commented 6 months ago

At Rubrics - Create and Rubrics - Update, the rubric[criteria] description says An indexed Hash of RubricCriteria objects where the keys are integer ids and the values are the RubricCriteria objects, but the actual object is RubricCriterion.

Expected behavior:

An indexed Hash of RubricCriterion objects where the keys are integer ids and the values are the RubricCriterion objects

API Documentation

https://github.com/instructure/canvas-lms/blob/6ad516e4253273b6482b3fbc3aeb16550ae2a598/app/controllers/rubrics_controller.rb#L117

https://github.com/instructure/canvas-lms/blob/6ad516e4253273b6482b3fbc3aeb16550ae2a598/app/controllers/rubrics_controller.rb#L163

Rubric Controller Definition

https://github.com/instructure/canvas-lms/blob/6ad516e4253273b6482b3fbc3aeb16550ae2a598/app/controllers/rubrics_api_controller.rb#L88-L118