fixed display of nested arrays on API documentation

arrays found within arguments in documentation are converting to hyperlinks

fixes CNVS-8092

test plan:
- visit the following links
- doc/api/submissions.html#method.submissions_api.update
- should show rubric_assessment[criterion_id][comments]
- doc/api/users.html#method.users.update
- should show user [avatar] [url]
- doc/api/submissions.html#method.submissions.create
- should show submission [submission_type] and submission [url]
- doc/api/assignments.html#method.assignments_api.update
- should show assignment [assignment_overrides]
Change-Id: Ie5eea14821a5fb172e2a8d4ee62a1cc19ab72b60
Reviewed-on: https://gerrit.instructure.com/38392
Reviewed-by: Mike Nomitch <mnomitch@instructure.com>
QA-Review: Amber Taniuchi <amber@instructure.com>
Tested-by: Jenkins <jenkins@instructure.com>
Product-Review: Matt Berns <mberns@instructure.com>
This commit is contained in:
Matthew Berns 2014-07-29 15:11:14 -06:00 committed by Matt Berns
parent 3d1bade940
commit a110badc58
4 changed files with 12 additions and 7 deletions

View File

@ -840,8 +840,8 @@ class AssignmentsApiController < ApplicationController
# The grading standard id to set for the course. If no value is provided for this argument the current grading_standard will be un-set from this course.
# This will update the grading_type for the course to 'letter_grade' unless it is already 'gpa_scale'.
#
# If the assignment[assignment_overrides] key is absent, any existing
# overrides are kept as is. If the assignment[assignment_overrides] key is
# If the assignment [assignment_overrides] key is absent, any existing
# overrides are kept as is. If the assignment [assignment_overrides] key is
# present, existing overrides are updated or deleted (and new ones created,
# as necessary) to match the provided list.
#

View File

@ -335,13 +335,18 @@ class SubmissionsApiController < ApplicationController
# a posted_grade in the "points" or "percentage" format is sent, the grade
# will only be accepted if the grade equals one of those two values.
#
#
# @argument rubric_assessment [Optional, RubricAssessment]
# Assign a rubric assessment to this assignment submission. The
# sub-parameters here depend on the rubric for the assignment. The general
# format is, for each row in the rubric:
#
# rubric_assessment[criterion_id][points]:: The points awarded for this row.
# rubric_assessment[criterion_id][comments]:: Comments to add for this row.
# The points awarded for this row.
# rubric_assessment[criterion_id][points]
#
# Comments to add for this row.
# rubric_assessment[criterion_id][comments]
#
#
# For example, if the assignment rubric is (in JSON format):
# !!!javascript

View File

@ -338,8 +338,8 @@ class SubmissionsController < ApplicationController
# include this submission type as an allowed option, or the submission will be rejected with a 400 error.
#
# The submission_type given determines which of the following parameters is
# used. For instance, to submit a URL, submission[submission_type] must be
# set to "online_url", otherwise the submission[url] parameter will be
# used. For instance, to submit a URL, submission [submission_type] must be
# set to "online_url", otherwise the submission [url] parameter will be
# ignored.
#
# @argument submission[body] [Optional, String]

View File

@ -1192,7 +1192,7 @@ class UsersController < ApplicationController
# @argument user[avatar][token] [Optional, String]
# A unique representation of the avatar record to assign as the user's
# current avatar. This token can be obtained from the user avatars endpoint.
# This supersedes the user[avatar][url] argument, and if both are included
# This supersedes the user [avatar] [url] argument, and if both are included
# the url will be ignored. Note: this is an internal representation and is
# subject to change without notice. It should be consumed with this api
# endpoint and used in the user update endpoint, and should not be