document assignment override features as beta

Changes the documentation to signify the Assignment Overrides feature as
a beta feature.

test plan:
  - run rake doc:api
  - view the documentation for assignments. The Assignment Overrides
    feature should be marked as in beta.

Change-Id: I2d523e73f1dd3c610823c7f5e16dba2602980a0e
Reviewed-on: https://gerrit.instructure.com/16637
Tested-by: Jenkins <jenkins@instructure.com>
QA-Review: Amber Taniuchi <amber@instructure.com>
Reviewed-by: Simon Williams <simon@instructure.com>
This commit is contained in:
Stanley Stuart 2013-01-08 14:59:40 -07:00 committed by Stanley Stuart
parent cde076eafd
commit 93f4efdc0f
2 changed files with 15 additions and 0 deletions

View File

@ -21,7 +21,12 @@
# API for accessing assignment information.
#
# @object AssignmentOverride
#
# {
# // NOTE: The Assignment Override feature is in beta! This API is not
# // finalized and there could be breaking changes before its final
# // release.
#
# // the ID of the assignment override
# id: 4,
#
@ -70,6 +75,7 @@ class AssignmentOverridesController < ApplicationController
include Api::V1::AssignmentOverride
# @API List assignment overrides
# @beta
#
# Returns the list of overrides for this assignment that target
# sections/groups/students visible to the current user.
@ -81,6 +87,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Get a single assignment override
# @beta
#
# Returns details of the the override with the given id.
#
@ -90,6 +97,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Redirect to the assignment override for a group
# @beta
#
# Responds with a redirect to the override for the given group, if any
# (404 otherwise).
@ -103,6 +111,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Redirect to the assignment override for a section
# @beta
#
# Responds with a redirect to the override for the given section, if any
# (404 otherwise).
@ -116,6 +125,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Create an assignment override
# @beta
#
# @argument assignment_override[student_ids][] [Optional, Integer] The IDs of
# the override's target students. If present, the IDs must each identify a
@ -185,6 +195,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Update an assignment override
# @beta
#
# @argument assignment_override[student_ids] [[Integer], Optional] The IDs of the
# override's target students. If present, the IDs must each identify a
@ -241,6 +252,7 @@ class AssignmentOverridesController < ApplicationController
end
# @API Delete an assignment override
# @beta
#
# Deletes an override and returns its former details.
#

View File

@ -357,6 +357,7 @@ class AssignmentsApiController < ApplicationController
#
# @argument assignment[assignment_overrides] [Optional, [AssignmentOverride]]
# List of overrides for the assignment.
# NOTE: The assignment overrides feature is in beta.
#
# @returns Assignment
def create
@ -376,6 +377,8 @@ class AssignmentsApiController < ApplicationController
# present, existing overrides are updated or deleted (and new ones created,
# as necessary) to match the provided list.
#
# NOTE: The assignment overrides feature is in beta.
#
# @returns Assignment
def update
@assignment = @context.assignments.find(params[:id])