update API doc required params - 2
- Appointment groups - Assignment groups - Assignments - Authentications log - Calendar events Test plan: - rake doc:api - Verify the above doc pages for parameter accuracy Refs SIS-403 Change-Id: If4b6d194f1f262118700dbdb4b09c55b1b9e3f19 Reviewed-on: https://gerrit.instructure.com/38664 Reviewed-by: Duane Johnson <duane@instructure.com> Tested-by: Jenkins <jenkins@instructure.com> Reviewed-by: Tyler Pickett <tpickett+gerrit@instructure.com> Product-Review: Duane Johnson <duane@instructure.com> QA-Review: Jeremy Putnam <jeremyp@instructure.com>
This commit is contained in:
Ben Young
Duane Johnson
parent
0d62f0f3a4
commit
12183f4980
|
|
@ -219,16 +219,16 @@ class AppointmentGroupsController < ApplicationController
|
|||
# Retrieve the list of appointment groups that can be reserved or managed by
|
||||
# the current user.
|
||||
#
|
||||
# @argument scope [Optional, String, "reservable"|"manageable"]
|
||||
# @argument scope [String, "reservable"|"manageable"]
|
||||
# Defaults to "reservable"
|
||||
#
|
||||
# @argument context_codes[] [Optional, String]
|
||||
# @argument context_codes[] [String]
|
||||
# Array of context codes used to limit returned results.
|
||||
#
|
||||
# @argument include_past_appointments [Optional, Boolean]
|
||||
# @argument include_past_appointments [Boolean]
|
||||
# Defaults to false. If true, includes past appointment groups
|
||||
#
|
||||
# @argument include[] [Optional, "appointments"|"child_events"|"participant_count"|"reserved_times"]
|
||||
# @argument include[] ["appointments"|"child_events"|"participant_count"|"reserved_times"]
|
||||
# Array of additional information to include.
|
||||
#
|
||||
# "appointments":: calendar event time slots for this appointment group
|
||||
|
|
@ -281,50 +281,50 @@ class AppointmentGroupsController < ApplicationController
|
|||
# specified, the response will return a new_appointments array (same format
|
||||
# as appointments array, see "List appointment groups" action)
|
||||
#
|
||||
# @argument appointment_group[context_codes][] [String]
|
||||
# @argument appointment_group[context_codes][] [Required, String]
|
||||
# Array of context codes (courses, e.g. course_1) this group should be
|
||||
# linked to (1 or more). Users in the course(s) with appropriate permissions
|
||||
# will be able to sign up for this appointment group.
|
||||
#
|
||||
# @argument appointment_group[sub_context_codes][] [Optional, String]
|
||||
# @argument appointment_group[sub_context_codes][] [String]
|
||||
# Array of sub context codes (course sections or a single group category)
|
||||
# this group should be linked to. Used to limit the appointment group to
|
||||
# particular sections. If a group category is specified, students will sign
|
||||
# up in groups and the participant_type will be "Group" instead of "User".
|
||||
#
|
||||
# @argument appointment_group[title] [Optional, String]
|
||||
# @argument appointment_group[title] [Required, String]
|
||||
# Short title for the appointment group.
|
||||
#
|
||||
# @argument appointment_group[description] [Optional, String]
|
||||
# @argument appointment_group[description] [String]
|
||||
# Longer text description of the appointment group.
|
||||
#
|
||||
# @argument appointment_group[location_name] [Optional, String]
|
||||
# @argument appointment_group[location_name] [String]
|
||||
# Location name of the appointment group.
|
||||
#
|
||||
# @argument appointment_group[location_address] [Optional, String]
|
||||
# @argument appointment_group[location_address] [String]
|
||||
# Location address.
|
||||
#
|
||||
# @argument appointment_group[publish] [Optional, Boolean]
|
||||
# @argument appointment_group[publish] [Boolean]
|
||||
# Indicates whether this appointment group should be published (i.e. made
|
||||
# available for signup). Once published, an appointment group cannot be
|
||||
# unpublished. Defaults to false.
|
||||
#
|
||||
# @argument appointment_group[participants_per_appointment] [Optional, Integer]
|
||||
# @argument appointment_group[participants_per_appointment] [Integer]
|
||||
# Maximum number of participants that may register for each time slot.
|
||||
# Defaults to null (no limit).
|
||||
#
|
||||
# @argument appointment_group[min_appointments_per_participant] [Optional, Integer]
|
||||
# @argument appointment_group[min_appointments_per_participant] [Integer]
|
||||
# Minimum number of time slots a user must register for. If not set, users
|
||||
# do not need to sign up for any time slots.
|
||||
#
|
||||
# @argument appointment_group[max_appointments_per_participant] [Optional, Integer]
|
||||
# @argument appointment_group[max_appointments_per_participant] [Integer]
|
||||
# Maximum number of time slots a user may register for.
|
||||
#
|
||||
# @argument appointment_group[new_appointments][X][] [Optional]
|
||||
# @argument appointment_group[new_appointments][X][]
|
||||
# Nested array of start time/end time pairs indicating time slots for this
|
||||
# appointment group. Refer to the example request.
|
||||
#
|
||||
# @argument appointment_group[participant_visibility] [Optional, "private"|"protected"]
|
||||
# @argument appointment_group[participant_visibility] ["private"|"protected"]
|
||||
# "private":: participants cannot see who has signed up for a particular
|
||||
# time slot
|
||||
# "protected":: participants can see who has signed up. Defaults to
|
||||
|
|
@ -367,7 +367,7 @@ class AppointmentGroupsController < ApplicationController
|
|||
#
|
||||
# Returns information for a single appointment group
|
||||
#
|
||||
# @argument include[] [Optional, "child_events"|"appointments"]
|
||||
# @argument include[] ["child_events"|"appointments"]
|
||||
# Array of additional information to include. Ssee include[] argument of
|
||||
# "List appointment groups" action.
|
||||
#
|
||||
|
|
@ -390,50 +390,50 @@ class AppointmentGroupsController < ApplicationController
|
|||
# the response will return a new_appointments array (same format as
|
||||
# appointments array, see "List appointment groups" action).
|
||||
#
|
||||
# @argument appointment_group[context_codes][] [String]
|
||||
# @argument appointment_group[context_codes][] [Required, String]
|
||||
# Array of context codes (courses, e.g. course_1) this group should be
|
||||
# linked to (1 or more). Users in the course(s) with appropriate permissions
|
||||
# will be able to sign up for this appointment group.
|
||||
#
|
||||
# @argument appointment_group[sub_context_codes][] [Optional, String]
|
||||
# @argument appointment_group[sub_context_codes][] [String]
|
||||
# Array of sub context codes (course sections or a single group category)
|
||||
# this group should be linked to. Used to limit the appointment group to
|
||||
# particular sections. If a group category is specified, students will sign
|
||||
# up in groups and the participant_type will be "Group" instead of "User".
|
||||
#
|
||||
# @argument appointment_group[title] [Optional, String]
|
||||
# @argument appointment_group[title] [String]
|
||||
# Short title for the appointment group.
|
||||
#
|
||||
# @argument appointment_group[description] [Optional, String]
|
||||
# @argument appointment_group[description] [String]
|
||||
# Longer text description of the appointment group.
|
||||
#
|
||||
# @argument appointment_group[location_name] [Optional, String]
|
||||
# @argument appointment_group[location_name] [String]
|
||||
# Location name of the appointment group.
|
||||
#
|
||||
# @argument appointment_group[location_address] [Optional, String]
|
||||
# @argument appointment_group[location_address] [String]
|
||||
# Location address.
|
||||
#
|
||||
# @argument appointment_group[publish] [Optional, Boolean]
|
||||
# @argument appointment_group[publish] [Boolean]
|
||||
# Indicates whether this appointment group should be published (i.e. made
|
||||
# available for signup). Once published, an appointment group cannot be
|
||||
# unpublished. Defaults to false.
|
||||
#
|
||||
# @argument appointment_group[participants_per_appointment] [Optional, Integer]
|
||||
# @argument appointment_group[participants_per_appointment] [Integer]
|
||||
# Maximum number of participants that may register for each time slot.
|
||||
# Defaults to null (no limit).
|
||||
#
|
||||
# @argument appointment_group[min_appointments_per_participant] [Optional, Integer]
|
||||
# @argument appointment_group[min_appointments_per_participant] [Integer]
|
||||
# Minimum number of time slots a user must register for. If not set, users
|
||||
# do not need to sign up for any time slots.
|
||||
#
|
||||
# @argument appointment_group[max_appointments_per_participant] [Optional, Integer]
|
||||
# @argument appointment_group[max_appointments_per_participant] [Integer]
|
||||
# Maximum number of time slots a user may register for.
|
||||
#
|
||||
# @argument appointment_group[new_appointments][X][] [Optional]
|
||||
# @argument appointment_group[new_appointments][X][]
|
||||
# Nested array of start time/end time pairs indicating time slots for this
|
||||
# appointment group. Refer to the example request.
|
||||
#
|
||||
# @argument appointment_group[participant_visibility] [Optional, "private"|"protected"]
|
||||
# @argument appointment_group[participant_visibility] ["private"|"protected"]
|
||||
# "private":: participants cannot see who has signed up for a particular
|
||||
# time slot
|
||||
# "protected":: participants can see who has signed up. Defaults to "private".
|
||||
|
|
@ -463,7 +463,7 @@ class AppointmentGroupsController < ApplicationController
|
|||
# Delete an appointment group (and associated time slots and reservations)
|
||||
# and return the deleted group
|
||||
#
|
||||
# @argument cancel_reason [Optional, String]
|
||||
# @argument cancel_reason [String]
|
||||
# Reason for deleting/canceling the appointment group.
|
||||
#
|
||||
# @example_request
|
||||
|
|
@ -489,7 +489,7 @@ class AppointmentGroupsController < ApplicationController
|
|||
# Refer to the Users API for the response fields. Returns no results for
|
||||
# appointment groups with the "Group" participant_type.
|
||||
#
|
||||
# @argument registration_status [Optional, "all"|"registered"|"registered"]
|
||||
# @argument registration_status ["all"|"registered"|"registered"]
|
||||
# Limits results to the a given participation status, defaults to "all"
|
||||
def users
|
||||
participants('User'){ |u| user_json(u, @current_user, session) }
|
||||
|
|
@ -501,7 +501,7 @@ class AppointmentGroupsController < ApplicationController
|
|||
# group. Refer to the Groups API for the response fields. Returns no results
|
||||
# for appointment groups with the "User" participant_type.
|
||||
#
|
||||
# @argument registration_status [Optional, "all"|"registered"|"registered"]
|
||||
# @argument registration_status ["all"|"registered"|"registered"]
|
||||
# Limits results to the a given participation status, defaults to "all"
|
||||
def groups
|
||||
participants('Group'){ |g| group_json(g, @current_user, session) }
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ class AssignmentGroupsApiController < ApplicationController
|
|||
# are only valid if "assignments" is also included. The "assignment_visibility" option additionally
|
||||
# requires that the Differentiated Assignments course feature be turned on.
|
||||
#
|
||||
# @argument override_assignment_dates [Optional, Boolean]
|
||||
# @argument override_assignment_dates [Boolean]
|
||||
# Apply assignment overrides for each assignment, defaults to true.
|
||||
#
|
||||
# @returns AssignmentGroup
|
||||
|
|
@ -51,16 +51,16 @@ class AssignmentGroupsApiController < ApplicationController
|
|||
#
|
||||
# Create a new assignment group for this course.
|
||||
#
|
||||
# @argument name [Optional, String]
|
||||
# @argument name [String]
|
||||
# The assignment group's name
|
||||
#
|
||||
# @argument position [Optional, Integer]
|
||||
# @argument position [Integer]
|
||||
# The position of this assignment group in relation to the other assignment groups
|
||||
#
|
||||
# @argument group_weight [Optional, Float]
|
||||
# @argument group_weight [Float]
|
||||
# The percent of the total grade that this assignment group represents
|
||||
#
|
||||
# @argument rules [Optional]
|
||||
# @argument rules
|
||||
# The grading rules that are applied within this assignment group
|
||||
# See the Assignment Group object definition for format
|
||||
#
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ class AssignmentGroupsController < ApplicationController
|
|||
# "assignment_visibility" are only valid are only valid if "assignments" is also included.
|
||||
# The "assignment_visibility" option additionally requires that the Differentiated Assignments course feature be turned on.
|
||||
#
|
||||
# @argument override_assignment_dates [Optional, Boolean]
|
||||
# @argument override_assignment_dates [Boolean]
|
||||
# Apply assignment overrides for each assignment, defaults to true.
|
||||
#
|
||||
# @returns [AssignmentGroup]
|
||||
|
|
|
|||
|
|
@ -146,17 +146,17 @@ class AssignmentOverridesController < ApplicationController
|
|||
# @API Create an assignment override
|
||||
# @beta
|
||||
#
|
||||
# @argument assignment_override[student_ids][] [Optional, Integer] The IDs of
|
||||
# @argument assignment_override[student_ids][] [Integer] The IDs of
|
||||
# the override's target students. If present, the IDs must each identify a
|
||||
# user with an active student enrollment in the course that is not already
|
||||
# targetted by a different adhoc override.
|
||||
#
|
||||
# @argument assignment_override[title] [Optional] The title of the adhoc
|
||||
# @argument assignment_override[title] The title of the adhoc
|
||||
# assignment override. Required if student_ids is present, ignored
|
||||
# otherwise (the title is set to the name of the targetted group or section
|
||||
# instead).
|
||||
#
|
||||
# @argument assignment_override[group_id] [Optional, Integer] The ID of the
|
||||
# @argument assignment_override[group_id] [Integer] The ID of the
|
||||
# override's target group. If present, the following conditions must be met
|
||||
# for the override to be successful:
|
||||
#
|
||||
|
|
@ -166,24 +166,24 @@ class AssignmentOverridesController < ApplicationController
|
|||
#
|
||||
# See {Appendix: Group assignments} for more info.
|
||||
#
|
||||
# @argument assignment_override[course_section_id] [Optional, Integer] The ID
|
||||
# @argument assignment_override[course_section_id] [Integer] The ID
|
||||
# of the override's target section. If present, must identify an active
|
||||
# section of the assignment's course not already targetted by a different
|
||||
# override.
|
||||
#
|
||||
# @argument assignment_override[due_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[due_at] [Timestamp] The day/time
|
||||
# the overridden assignment is due. Accepts times in ISO 8601 format, e.g.
|
||||
# 2014-10-21T18:48:00Z. If absent, this override will not affect due date.
|
||||
# May be present but null to indicate the override removes any previous due
|
||||
# date.
|
||||
#
|
||||
# @argument assignment_override[unlock_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[unlock_at] [Timestamp] The day/time
|
||||
# the overridden assignment becomes unlocked. Accepts times in ISO 8601
|
||||
# format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not
|
||||
# affect the unlock date. May be present but null to indicate the override
|
||||
# removes any previous unlock date.
|
||||
#
|
||||
# @argument assignment_override[lock_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[lock_at] [Timestamp] The day/time
|
||||
# the overridden assignment becomes locked. Accepts times in ISO 8601
|
||||
# format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not
|
||||
# affect the lock date. May be present but null to indicate the override
|
||||
|
|
@ -221,28 +221,28 @@ class AssignmentOverridesController < ApplicationController
|
|||
# @API Update an assignment override
|
||||
# @beta
|
||||
#
|
||||
# @argument assignment_override[student_ids][] [Optional, Integer] The IDs of the
|
||||
# @argument assignment_override[student_ids][] [Integer] The IDs of the
|
||||
# override's target students. If present, the IDs must each identify a
|
||||
# user with an active student enrollment in the course that is not already
|
||||
# targetted by a different adhoc override. Ignored unless the override
|
||||
# being updated is adhoc.
|
||||
#
|
||||
# @argument assignment_override[title] [Optional, String] The title of an adhoc
|
||||
# @argument assignment_override[title] [String] The title of an adhoc
|
||||
# assignment override. Ignored unless the override being updated is adhoc.
|
||||
#
|
||||
# @argument assignment_override[due_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[due_at] [Timestamp] The day/time
|
||||
# the overridden assignment is due. Accepts times in ISO 8601 format, e.g.
|
||||
# 2014-10-21T18:48:00Z. If absent, this override will not affect due date.
|
||||
# May be present but null to indicate the override removes any previous due
|
||||
# date.
|
||||
#
|
||||
# @argument assignment_override[unlock_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[unlock_at] [Timestamp] The day/time
|
||||
# the overridden assignment becomes unlocked. Accepts times in ISO 8601
|
||||
# format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not
|
||||
# affect the unlock date. May be present but null to indicate the override
|
||||
# removes any previous unlock date.
|
||||
#
|
||||
# @argument assignment_override[lock_at] [Optional, Timestamp] The day/time
|
||||
# @argument assignment_override[lock_at] [Timestamp] The day/time
|
||||
# the overridden assignment becomes locked. Accepts times in ISO 8601
|
||||
# format, e.g. 2014-10-21T18:48:00Z. If absent, this override will not
|
||||
# affect the lock date. May be present but null to indicate the override
|
||||
|
|
|
|||
|
|
@ -475,9 +475,9 @@ class AssignmentsApiController < ApplicationController
|
|||
# @argument include[] [String, "submission"|"assignment_visibility"]
|
||||
# Associations to include with the assignment. The "assignment_visibility" option
|
||||
# requires that the Differentiated Assignments course feature be turned on.
|
||||
# @argument search_term [Optional, String]
|
||||
# @argument search_term [String]
|
||||
# The partial title of the assignments to match and return.
|
||||
# @argument override_assignment_dates [Optional, Boolean]
|
||||
# @argument override_assignment_dates [Boolean]
|
||||
# Apply assignment overrides for each assignment, defaults to true.
|
||||
# @returns [Assignment]
|
||||
def index
|
||||
|
|
@ -536,7 +536,7 @@ class AssignmentsApiController < ApplicationController
|
|||
# @argument include[] [String, "submission"|"assignment_visibility"]
|
||||
# Associations to include with the assignment. The "assignment_visibility" option
|
||||
# requires that the Differentiated Assignments course feature be turned on.
|
||||
# @argument override_assignment_dates [Optional, Boolean]
|
||||
# @argument override_assignment_dates [Boolean]
|
||||
# Apply assignment overrides to the assignment, defaults to true.
|
||||
# @returns Assignment
|
||||
def show
|
||||
|
|
@ -564,9 +564,9 @@ class AssignmentsApiController < ApplicationController
|
|||
# Create a new assignment for this course. The assignment is created in the
|
||||
# active state.
|
||||
#
|
||||
# @argument assignment[name] [String] The assignment name.
|
||||
# @argument assignment[name] [Required, String] The assignment name.
|
||||
#
|
||||
# @argument assignment[position] [Optional, Integer]
|
||||
# @argument assignment[position] [Integer]
|
||||
# The position of this assignment in the group when displaying
|
||||
# assignment lists.
|
||||
#
|
||||
|
|
@ -591,53 +591,53 @@ class AssignmentsApiController < ApplicationController
|
|||
# "online_url"
|
||||
# "media_recording" (Only valid when the Kaltura plugin is enabled)
|
||||
#
|
||||
# @argument assignment[allowed_extensions][] [Optional, String]
|
||||
# @argument assignment[allowed_extensions][] [String]
|
||||
# Allowed extensions if submission_types includes "online_upload"
|
||||
#
|
||||
# Example:
|
||||
# allowed_extensions: ["docx","ppt"]
|
||||
#
|
||||
# @argument assignment[turnitin_enabled] [Optional, Boolean]
|
||||
# @argument assignment[turnitin_enabled] [Boolean]
|
||||
# Only applies when the Turnitin plugin is enabled for a course and
|
||||
# the submission_types array includes "online_upload".
|
||||
# Toggles Turnitin submissions for the assignment.
|
||||
# Will be ignored if Turnitin is not available for the course.
|
||||
#
|
||||
# @argument assignment[turnitin_settings] [Optional]
|
||||
# @argument assignment[turnitin_settings]
|
||||
# Settings to send along to turnitin. See Assignment object definition for
|
||||
# format.
|
||||
#
|
||||
# @argument assignment[integration_data] [Optional]
|
||||
# @argument assignment[integration_data]
|
||||
# Data related to third party integrations, JSON string required.
|
||||
#
|
||||
# @argument assignment[integration_id] [Optional]
|
||||
# @argument assignment[integration_id]
|
||||
# Unique ID from third party integrations
|
||||
#
|
||||
# @argument assignment[peer_reviews] [Optional, Boolean]
|
||||
# @argument assignment[peer_reviews] [Boolean]
|
||||
# If submission_types does not include external_tool,discussion_topic,
|
||||
# online_quiz, or on_paper, determines whether or not peer reviews
|
||||
# will be turned on for the assignment.
|
||||
#
|
||||
# @argument assignment[automatic_peer_reviews] [Optional, Boolean]
|
||||
# @argument assignment[automatic_peer_reviews] [Boolean]
|
||||
# Whether peer reviews will be assigned automatically by Canvas or if
|
||||
# teachers must manually assign peer reviews. Does not apply if peer reviews
|
||||
# are not enabled.
|
||||
#
|
||||
# @argument assignment[notify_of_update] [Optional, Boolean]
|
||||
# @argument assignment[notify_of_update] [Boolean]
|
||||
# If true, Canvas will send a notification to students in the class
|
||||
# notifying them that the content has changed.
|
||||
#
|
||||
# @argument assignment[group_category_id] [Optional, Integer]
|
||||
# @argument assignment[group_category_id] [Integer]
|
||||
# If present, the assignment will become a group assignment assigned
|
||||
# to the group.
|
||||
#
|
||||
# @argument assignment[grade_group_students_individually] [Optional, Integer]
|
||||
# @argument assignment[grade_group_students_individually] [Integer]
|
||||
# If this is a group assignment, teachers have the options to grade
|
||||
# students individually. If false, Canvas will apply the assignment's
|
||||
# score to each member of the group. If true, the teacher can manually
|
||||
# assign scores to each member of the group.
|
||||
#
|
||||
# @argument assignment[external_tool_tag_attributes] [Optional]
|
||||
# @argument assignment[external_tool_tag_attributes]
|
||||
# Hash of attributes if submission_types is ["external_tool"]
|
||||
# Example:
|
||||
# external_tool_tag_attributes: {
|
||||
|
|
@ -647,52 +647,52 @@ class AssignmentsApiController < ApplicationController
|
|||
# new_tab: false
|
||||
# }
|
||||
#
|
||||
# @argument assignment[points_possible] [Optional, Float]
|
||||
# @argument assignment[points_possible] [Float]
|
||||
# The maximum points possible on the assignment.
|
||||
#
|
||||
# @argument assignment[grading_type] [Optional, "pass_fail"|"percent"|"letter_grade"|"gpa_scale"|"points"]
|
||||
# @argument assignment[grading_type] ["pass_fail"|"percent"|"letter_grade"|"gpa_scale"|"points"]
|
||||
# The strategy used for grading the assignment.
|
||||
# The assignment is ungraded if this field is omitted.
|
||||
#
|
||||
# @argument assignment[due_at] [Optional, Timestamp]
|
||||
# @argument assignment[due_at] [Timestamp]
|
||||
# The day/time the assignment is due.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[lock_at] [Optional, Timestamp]
|
||||
# @argument assignment[lock_at] [Timestamp]
|
||||
# The day/time the assignment is locked after.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[unlock_at] [Optional, Timestamp]
|
||||
# @argument assignment[unlock_at] [Timestamp]
|
||||
# The day/time the assignment is unlocked.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[description] [Optional, String]
|
||||
# @argument assignment[description] [String]
|
||||
# The assignment's description, supports HTML.
|
||||
#
|
||||
# @argument assignment[assignment_group_id] [Optional, Integer]
|
||||
# @argument assignment[assignment_group_id] [Integer]
|
||||
# The assignment group id to put the assignment in.
|
||||
# Defaults to the top assignment group in the course.
|
||||
#
|
||||
# @argument assignment[muted] [Optional, Boolean]
|
||||
# @argument assignment[muted] [Boolean]
|
||||
# Whether this assignment is muted.
|
||||
# A muted assignment does not send change notifications
|
||||
# and hides grades from students.
|
||||
# Defaults to false.
|
||||
#
|
||||
# @argument assignment[assignment_overrides][] [Optional, AssignmentOverride]
|
||||
# @argument assignment[assignment_overrides][] [AssignmentOverride]
|
||||
# List of overrides for the assignment.
|
||||
# NOTE: The assignment overrides feature is in beta.
|
||||
#
|
||||
# @argument assignment[only_visible_to_overrides] [Optional, Boolean]
|
||||
# @argument assignment[only_visible_to_overrides] [Boolean]
|
||||
# Whether this assignment is only visible to overrides
|
||||
# (Only useful if 'differentiated assignments' account setting is on)
|
||||
#
|
||||
# @argument assignment[published] [Optional, Boolean]
|
||||
# @argument assignment[published] [Boolean]
|
||||
# Whether this assignment is published.
|
||||
# (Only useful if 'draft state' account setting is on)
|
||||
# Unpublished assignments are not visible to students.
|
||||
#
|
||||
# @argument assignment[grading_standard_id] [Optional, Integer]
|
||||
# @argument assignment[grading_standard_id] [Integer]
|
||||
# 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'.
|
||||
#
|
||||
|
|
@ -708,13 +708,13 @@ class AssignmentsApiController < ApplicationController
|
|||
# @API Edit an assignment
|
||||
# Modify an existing assignment.
|
||||
#
|
||||
# @argument assignment[name] [Optional, String] The assignment name.
|
||||
# @argument assignment[name] [String] The assignment name.
|
||||
#
|
||||
# @argument assignment[position] [Optional, Integer]
|
||||
# @argument assignment[position] [Integer]
|
||||
# The position of this assignment in the group when displaying
|
||||
# assignment lists.
|
||||
#
|
||||
# @argument assignment[submission_types][] [Optional, String, "online_quiz"|"none"|"on_paper"|"online_quiz"|"discussion_topic"|"external_tool"|"online_upload"|"online_text_entry"|"online_url"|"media_recording"]
|
||||
# @argument assignment[submission_types][] [String, "online_quiz"|"none"|"on_paper"|"online_quiz"|"discussion_topic"|"external_tool"|"online_upload"|"online_text_entry"|"online_url"|"media_recording"]
|
||||
# List of supported submission types for the assignment.
|
||||
# Unless the assignment is allowing online submissions, the array should
|
||||
# only have one element.
|
||||
|
|
@ -735,53 +735,53 @@ class AssignmentsApiController < ApplicationController
|
|||
# "online_url"
|
||||
# "media_recording" (Only valid when the Kaltura plugin is enabled)
|
||||
#
|
||||
# @argument assignment[allowed_extensions][] [Optional, String]
|
||||
# @argument assignment[allowed_extensions][] [String]
|
||||
# Allowed extensions if submission_types includes "online_upload"
|
||||
#
|
||||
# Example:
|
||||
# allowed_extensions: ["docx","ppt"]
|
||||
#
|
||||
# @argument assignment[turnitin_enabled] [Optional, Boolean]
|
||||
# @argument assignment[turnitin_enabled] [Boolean]
|
||||
# Only applies when the Turnitin plugin is enabled for a course and
|
||||
# the submission_types array includes "online_upload".
|
||||
# Toggles Turnitin submissions for the assignment.
|
||||
# Will be ignored if Turnitin is not available for the course.
|
||||
#
|
||||
# @argument assignment[turnitin_settings] [Optional]
|
||||
# @argument assignment[turnitin_settings]
|
||||
# Settings to send along to turnitin. See Assignment object definition for
|
||||
# format.
|
||||
#
|
||||
# @argument assignment[integration_data] [Optional]
|
||||
# @argument assignment[integration_data]
|
||||
# Data related to third party integrations, JSON string required.
|
||||
#
|
||||
# @argument assignment[integration_id] [Optional]
|
||||
# @argument assignment[integration_id]
|
||||
# Unique ID from third party integrations
|
||||
#
|
||||
# @argument assignment[peer_reviews] [Optional, Boolean]
|
||||
# @argument assignment[peer_reviews] [Boolean]
|
||||
# If submission_types does not include external_tool,discussion_topic,
|
||||
# online_quiz, or on_paper, determines whether or not peer reviews
|
||||
# will be turned on for the assignment.
|
||||
#
|
||||
# @argument assignment[automatic_peer_reviews] [Optional, Boolean]
|
||||
# @argument assignment[automatic_peer_reviews] [Boolean]
|
||||
# Whether peer reviews will be assigned automatically by Canvas or if
|
||||
# teachers must manually assign peer reviews. Does not apply if peer reviews
|
||||
# are not enabled.
|
||||
#
|
||||
# @argument assignment[notify_of_update] [Optional, Boolean]
|
||||
# @argument assignment[notify_of_update] [Boolean]
|
||||
# If true, Canvas will send a notification to students in the class
|
||||
# notifying them that the content has changed.
|
||||
#
|
||||
# @argument assignment[group_category_id] [Optional, Integer]
|
||||
# @argument assignment[group_category_id] [Integer]
|
||||
# If present, the assignment will become a group assignment assigned
|
||||
# to the group.
|
||||
#
|
||||
# @argument assignment[grade_group_students_individually] [Optional, Integer]
|
||||
# @argument assignment[grade_group_students_individually] [Integer]
|
||||
# If this is a group assignment, teachers have the options to grade
|
||||
# students individually. If false, Canvas will apply the assignment's
|
||||
# score to each member of the group. If true, the teacher can manually
|
||||
# assign scores to each member of the group.
|
||||
#
|
||||
# @argument assignment[external_tool_tag_attributes] [Optional]
|
||||
# @argument assignment[external_tool_tag_attributes]
|
||||
# Hash of attributes if submission_types is ["external_tool"]
|
||||
# Example:
|
||||
# external_tool_tag_attributes: {
|
||||
|
|
@ -791,52 +791,52 @@ class AssignmentsApiController < ApplicationController
|
|||
# new_tab: false
|
||||
# }
|
||||
#
|
||||
# @argument assignment[points_possible] [Optional, Float]
|
||||
# @argument assignment[points_possible] [Float]
|
||||
# The maximum points possible on the assignment.
|
||||
#
|
||||
# @argument assignment[grading_type] [Optional, "pass_fail"|"percent"|"letter_grade"|"gpa_scale"|"points"]
|
||||
# @argument assignment[grading_type] ["pass_fail"|"percent"|"letter_grade"|"gpa_scale"|"points"]
|
||||
# The strategy used for grading the assignment.
|
||||
# The assignment is ungraded if this field is omitted.
|
||||
#
|
||||
# @argument assignment[due_at] [Optional, Timestamp]
|
||||
# @argument assignment[due_at] [Timestamp]
|
||||
# The day/time the assignment is due.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[lock_at] [Optional, Timestamp]
|
||||
# @argument assignment[lock_at] [Timestamp]
|
||||
# The day/time the assignment is locked after.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[unlock_at] [Optional, Timestamp]
|
||||
# @argument assignment[unlock_at] [Timestamp]
|
||||
# The day/time the assignment is unlocked.
|
||||
# Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
|
||||
#
|
||||
# @argument assignment[description] [Optional, String]
|
||||
# @argument assignment[description] [String]
|
||||
# The assignment's description, supports HTML.
|
||||
#
|
||||
# @argument assignment[assignment_group_id] [Optional, Integer]
|
||||
# @argument assignment[assignment_group_id] [Integer]
|
||||
# The assignment group id to put the assignment in.
|
||||
# Defaults to the top assignment group in the course.
|
||||
#
|
||||
# @argument assignment[muted] [Optional, Boolean]
|
||||
# @argument assignment[muted] [Boolean]
|
||||
# Whether this assignment is muted.
|
||||
# A muted assignment does not send change notifications
|
||||
# and hides grades from students.
|
||||
# Defaults to false.
|
||||
#
|
||||
# @argument assignment[assignment_overrides][] [Optional, AssignmentOverride]
|
||||
# @argument assignment[assignment_overrides][] [AssignmentOverride]
|
||||
# List of overrides for the assignment.
|
||||
# NOTE: The assignment overrides feature is in beta.
|
||||
#
|
||||
# @argument assignment[only_visible_to_overrides] [Optional, Boolean]
|
||||
# @argument assignment[only_visible_to_overrides] [Boolean]
|
||||
# Whether this assignment is only visible to overrides
|
||||
# (Only useful if 'differentiated assignments' account setting is on)
|
||||
#
|
||||
# @argument assignment[published] [Optional, Boolean]
|
||||
# @argument assignment[published] [Boolean]
|
||||
# Whether this assignment is published.
|
||||
# (Only useful if 'draft state' account setting is on)
|
||||
# Unpublished assignments are not visible to students.
|
||||
#
|
||||
# @argument assignment[grading_standard_id] [Optional, Integer]
|
||||
# @argument assignment[grading_standard_id] [Integer]
|
||||
# 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'.
|
||||
#
|
||||
|
|
|
|||
|
|
@ -75,10 +75,10 @@ class AuthenticationAuditApiController < AuditorApiController
|
|||
#
|
||||
# List authentication events for a given login.
|
||||
#
|
||||
# @argument start_time [Optional, DateTime]
|
||||
# @argument start_time [DateTime]
|
||||
# The beginning of the time range from which you want events.
|
||||
#
|
||||
# @argument end_time [Optional, Datetime]
|
||||
# @argument end_time [Datetime]
|
||||
# The end of the time range from which you want events.
|
||||
#
|
||||
def for_login
|
||||
|
|
@ -95,10 +95,10 @@ class AuthenticationAuditApiController < AuditorApiController
|
|||
#
|
||||
# List authentication events for a given account.
|
||||
#
|
||||
# @argument start_time [Optional, Datetime]
|
||||
# @argument start_time [Datetime]
|
||||
# The beginning of the time range from which you want events.
|
||||
#
|
||||
# @argument end_time [Optional, Datetime]
|
||||
# @argument end_time [Datetime]
|
||||
# The end of the time range from which you want events.
|
||||
#
|
||||
def for_account
|
||||
|
|
@ -115,10 +115,10 @@ class AuthenticationAuditApiController < AuditorApiController
|
|||
#
|
||||
# List authentication events for a given user.
|
||||
#
|
||||
# @argument start_time [Optional, Datetime]
|
||||
# @argument start_time [Datetime]
|
||||
# The beginning of the time range from which you want events.
|
||||
#
|
||||
# @argument end_time [Optional, Datetime]
|
||||
# @argument end_time [Datetime]
|
||||
# The end of the time range from which you want events.
|
||||
#
|
||||
def for_user
|
||||
|
|
|
|||
|
|
@ -257,22 +257,22 @@ class CalendarEventsApiController < ApplicationController
|
|||
#
|
||||
# Retrieve the list of calendar events or assignments for the current user
|
||||
#
|
||||
# @argument type [Optional, String, "event"|"assignment"] Defaults to "event"
|
||||
# @argument start_date [Optional, Date]
|
||||
# @argument type [String, "event"|"assignment"] Defaults to "event"
|
||||
# @argument start_date [Date]
|
||||
# Only return events since the start_date (inclusive).
|
||||
# Defaults to today. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.
|
||||
# @argument end_date [Optional, Date]
|
||||
# @argument end_date [Date]
|
||||
# Only return events before the end_date (inclusive).
|
||||
# Defaults to start_date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.
|
||||
# If end_date is the same as start_date, then only events on that day are
|
||||
# returned.
|
||||
# @argument undated [Optional, Boolean]
|
||||
# @argument undated [Boolean]
|
||||
# Defaults to false (dated events only).
|
||||
# If true, only return undated events and ignore start_date and end_date.
|
||||
# @argument all_events [Optional, Boolean]
|
||||
# @argument all_events [Boolean]
|
||||
# Defaults to false (uses start_date, end_date, and undated criteria).
|
||||
# If true, all events are returned, ignoring start_date, end_date, and undated criteria.
|
||||
# @argument context_codes[] [Optional, String]
|
||||
# @argument context_codes[] [String]
|
||||
# List of context codes of courses/groups/users whose events you want to see.
|
||||
# If not specified, defaults to the current user (i.e personal calendar,
|
||||
# no course/group events). Limited to 10 context codes, additional ones are
|
||||
|
|
@ -318,32 +318,32 @@ class CalendarEventsApiController < ApplicationController
|
|||
#
|
||||
# Create and return a new calendar event
|
||||
#
|
||||
# @argument calendar_event[context_code] [String]
|
||||
# @argument calendar_event[context_code] [Required, String]
|
||||
# Context code of the course/group/user whose calendar this event should be
|
||||
# added to.
|
||||
# @argument calendar_event[title] [Optional, String]
|
||||
# @argument calendar_event[title] [String]
|
||||
# Short title for the calendar event.
|
||||
# @argument calendar_event[description] [Optional, String]
|
||||
# @argument calendar_event[description] [String]
|
||||
# Longer HTML description of the event.
|
||||
# @argument calendar_event[start_at] [Optional, DateTime]
|
||||
# @argument calendar_event[start_at] [DateTime]
|
||||
# Start date/time of the event.
|
||||
# @argument calendar_event[end_at] [Optional, DateTime]
|
||||
# @argument calendar_event[end_at] [DateTime]
|
||||
# End date/time of the event.
|
||||
# @argument calendar_event[location_name] [Optional, String]
|
||||
# @argument calendar_event[location_name] [String]
|
||||
# Location name of the event.
|
||||
# @argument calendar_event[location_address] [Optional, String]
|
||||
# @argument calendar_event[location_address] [String]
|
||||
# Location address
|
||||
# @argument calendar_event[time_zone_edited] [Optional, String]
|
||||
# @argument calendar_event[time_zone_edited] [String]
|
||||
# Time zone of the user editing the event. Allowed time zones are
|
||||
# {http://www.iana.org/time-zones IANA time zones} or friendlier
|
||||
# {http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html Ruby on Rails time zones}.
|
||||
# @argument calendar_event[child_event_data][X][start_at] [Optional, DateTime]
|
||||
# @argument calendar_event[child_event_data][X][start_at] [DateTime]
|
||||
# Section-level start time(s) if this is a course event. X can be any
|
||||
# identifier, provided that it is consistent across the start_at, end_at
|
||||
# and context_code
|
||||
# @argument calendar_event[child_event_data][X][end_at] [Optional, DateTime]
|
||||
# @argument calendar_event[child_event_data][X][end_at] [DateTime]
|
||||
# Section-level end time(s) if this is a course event.
|
||||
# @argument calendar_event[child_event_data][X][context_code] [Optional, String]
|
||||
# @argument calendar_event[child_event_data][X][context_code] [String]
|
||||
# Context code(s) corresponding to the section-level start and end time(s).
|
||||
#
|
||||
# @example_request
|
||||
|
|
@ -385,11 +385,11 @@ class CalendarEventsApiController < ApplicationController
|
|||
#
|
||||
# Reserves a particular time slot and return the new reservation
|
||||
#
|
||||
# @argument participant_id [Optional, String]
|
||||
# @argument participant_id [String]
|
||||
# User or group id for whom you are making the reservation (depends on the
|
||||
# participant type). Defaults to the current user (or user's candidate group).
|
||||
#
|
||||
# @argument cancel_existing [Optional, Boolean]
|
||||
# @argument cancel_existing [Boolean]
|
||||
# Defaults to false. If true, cancel any previous reservation(s) for this
|
||||
# participant and appointment group.
|
||||
#
|
||||
|
|
@ -429,32 +429,32 @@ class CalendarEventsApiController < ApplicationController
|
|||
#
|
||||
# Update and return a calendar event
|
||||
#
|
||||
# @argument calendar_event[context_code] [String]
|
||||
# @argument calendar_event[context_code] [Required, String]
|
||||
# Context code of the course/group/user whose calendar this event should be
|
||||
# added to.
|
||||
# @argument calendar_event[title] [Optional, String]
|
||||
# @argument calendar_event[title] [String]
|
||||
# Short title for the calendar event.
|
||||
# @argument calendar_event[description] [Optional, String]
|
||||
# @argument calendar_event[description] [String]
|
||||
# Longer HTML description of the event.
|
||||
# @argument calendar_event[start_at] [Optional, DateTime]
|
||||
# @argument calendar_event[start_at] [DateTime]
|
||||
# Start date/time of the event.
|
||||
# @argument calendar_event[end_at] [Optional, DateTime]
|
||||
# @argument calendar_event[end_at] [DateTime]
|
||||
# End date/time of the event.
|
||||
# @argument calendar_event[location_name] [Optional, String]
|
||||
# @argument calendar_event[location_name] [String]
|
||||
# Location name of the event.
|
||||
# @argument calendar_event[location_address] [Optional, String]
|
||||
# @argument calendar_event[location_address] [String]
|
||||
# Location address
|
||||
# @argument calendar_event[time_zone_edited] [Optional, String]
|
||||
# @argument calendar_event[time_zone_edited] [String]
|
||||
# Time zone of the user editing the event. Allowed time zones are
|
||||
# {http://www.iana.org/time-zones IANA time zones} or friendlier
|
||||
# {http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html Ruby on Rails time zones}.
|
||||
# @argument calendar_event[child_event_data][X][start_at] [Optional, DateTime]
|
||||
# @argument calendar_event[child_event_data][X][start_at] [DateTime]
|
||||
# Section-level start time(s) if this is a course event. X can be any
|
||||
# identifier, provided that it is consistent across the start_at, end_at
|
||||
# and context_code
|
||||
# @argument calendar_event[child_event_data][X][end_at] [Optional, DateTime]
|
||||
# @argument calendar_event[child_event_data][X][end_at] [DateTime]
|
||||
# Section-level end time(s) if this is a course event.
|
||||
# @argument calendar_event[child_event_data][X][context_code] [Optional, String]
|
||||
# @argument calendar_event[child_event_data][X][context_code] [String]
|
||||
# Context code(s) corresponding to the section-level start and end time(s).
|
||||
#
|
||||
# @example_request
|
||||
|
|
@ -488,7 +488,7 @@ class CalendarEventsApiController < ApplicationController
|
|||
#
|
||||
# Delete an event from the calendar and return the deleted event
|
||||
#
|
||||
# @argument cancel_reason [Optional, String]
|
||||
# @argument cancel_reason [String]
|
||||
# Reason for deleting/canceling the event.
|
||||
#
|
||||
# @example_request
|
||||
|
|
|
|||
Loading…
Reference in New Issue