lms-graphql-api 0.7.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lms_graphql/canvas.rb +1 -0
- data/lib/lms_graphql/mutations/canvas/add_domain_to_account_whitelist.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/create_assignment.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/create_conversation.rb +3 -1
- data/lib/lms_graphql/mutations/canvas/create_planner_override.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/edit_assignment.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/enable_disable_or_clear_explicit_csp_setting_accounts.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/enable_disable_or_clear_explicit_csp_setting_courses.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/mutations.rb +6 -1
- data/lib/lms_graphql/mutations/canvas/remove_domain_from_account_whitelist.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/set_extensions_for_student_assignment_submissions.rb +26 -0
- data/lib/lms_graphql/mutations/canvas/update_planner_note.rb +28 -0
- data/lib/lms_graphql/resolvers/canvas/get_current_settings_for_account_or_course_accounts.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/get_current_settings_for_account_or_course_courses.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/get_single_course_accounts.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/get_single_course_courses.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/get_sis_import_error_list_sis_import_errors.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/get_sis_import_error_list_sis_imports.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/get_sis_import_list.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/list_activity_stream_activity_stream.rb +3 -3
- data/lib/lms_graphql/resolvers/canvas/list_activity_stream_self.rb +3 -3
- data/lib/lms_graphql/resolvers/canvas/show_planner_note.rb +20 -0
- data/lib/lms_graphql/types/canvas/admin_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/appointment_group_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/assignment.rb +1 -0
- data/lib/lms_graphql/types/canvas/assignment_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/assignment_extension.rb +16 -0
- data/lib/lms_graphql/types/canvas/assignment_extension_input.rb +16 -0
- data/lib/lms_graphql/types/canvas/assignment_group_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/assignment_input.rb +10 -9
- data/lib/lms_graphql/types/canvas/authentication_provider_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/conference_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/content_detail_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/content_export_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/conversation_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/course_epub_export_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/course_event_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/course_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/discussion_topic_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/enrollment.rb +12 -8
- data/lib/lms_graphql/types/canvas/enrollment_input.rb +14 -10
- data/lib/lms_graphql/types/canvas/epub_export_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/feature_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/grade_change_event_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/grading_standard_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/group_category_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/help_link_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/module_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/module_item_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/module_item_sequence_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/module_item_sequence_node_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/outcome_group_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/outcome_import_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/outcome_link_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_path_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/outcome_rollup_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_rollup_score_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/page_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/page_revision_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/page_view_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/poll_session_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/profile_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/query_type.rb +12 -4
- data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_container_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/quiz_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/quiz_question_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/quiz_report_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/quiz_statistic_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/quiz_statistics_question_statistic_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/report_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/result_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/role_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/rubric_criterium_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/rubric_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/section_attribute_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/sis_assignment_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/sis_import.rb +12 -2
- data/lib/lms_graphql/types/canvas/sis_import_datum_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/sis_import_error.rb +1 -0
- data/lib/lms_graphql/types/canvas/sis_import_error_input.rb +1 -0
- data/lib/lms_graphql/types/canvas/sis_import_input.rb +15 -5
- data/lib/lms_graphql/types/canvas/sis_import_statistic.rb +39 -0
- data/lib/lms_graphql/types/canvas/sis_import_statistic_input.rb +39 -0
- data/lib/lms_graphql/types/canvas/submission.rb +1 -0
- data/lib/lms_graphql/types/canvas/submission_comment_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/submission_history_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/submission_input.rb +2 -1
- data/lib/lms_graphql/types/canvas/user_assignment_override_attribute_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/user_input.rb +1 -1
- data/lib/lms_graphql/types/canvas_forward_declarations.rb +375 -16
- data/lib/lms_graphql/types/canvas_hacks.rb +15 -0
- data/lib/lms_graphql/version.rb +1 -1
- metadata +16 -2
@@ -0,0 +1,20 @@
|
|
1
|
+
require_relative "../canvas_base_resolver"
|
2
|
+
require_relative "../../types/canvas/planner_note"
|
3
|
+
module LMSGraphQL
|
4
|
+
module Resolvers
|
5
|
+
module Canvas
|
6
|
+
class ShowPlannerNote < CanvasBaseResolver
|
7
|
+
type LMSGraphQL::Types::Canvas::CanvasPlannerNote, null: false
|
8
|
+
argument :id, ID, required: true
|
9
|
+
def resolve(id:)
|
10
|
+
context[:canvas_api].call("SHOW_PLANNER_NOTE").proxy(
|
11
|
+
"SHOW_PLANNER_NOTE",
|
12
|
+
{
|
13
|
+
"id": id },
|
14
|
+
nil,
|
15
|
+
).parsed_response
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
8
8
|
description "Admins. API Docs: https://canvas.instructure.com/doc/api/admins.html"
|
9
9
|
argument :id, ID, "The unique identifier for the account role/user assignment..Example: 1023", required: false
|
10
10
|
argument :role, String, "The account role assigned. This can be 'AccountAdmin' or a user-defined role created by the Roles API..Example: AccountAdmin", required: false
|
11
|
-
argument :user, LMSGraphQL::Types::Canvas::
|
11
|
+
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user the role is assigned to. See the Users API for details..", required: false
|
12
12
|
argument :workflow_state, String, "The status of the account role/user assignment..Example: deleted", required: false
|
13
13
|
|
14
14
|
end
|
@@ -31,14 +31,14 @@ module LMSGraphQL
|
|
31
31
|
argument :location_name, String, "The location name of the appointment group.Example: El Tigre Chino's office", required: false
|
32
32
|
argument :location_address, String, "The address of the appointment group's location.Example: Room 234", required: false
|
33
33
|
argument :participant_count, Int, "The number of participant who have reserved slots (see include[] argument).Example: 2", required: false
|
34
|
-
argument :reserved_times, [LMSGraphQL::Types::Canvas::
|
34
|
+
argument :reserved_times, [LMSGraphQL::Types::Canvas::CanvasAppointmentInput], "The start and end times of slots reserved by the current user as well as the id of the calendar event for the reservation (see include[] argument).Example: {'id'=>987, 'start_at'=>'2012-07-20T15:00:00-06:00', 'end_at'=>'2012-07-20T15:00:00-06:00'}", required: false
|
35
35
|
argument :context_codes, String, "The context codes (i.e. courses) this appointment group belongs to. Only people in these courses will be eligible to sign up..Example: course_123", required: false
|
36
36
|
argument :sub_context_codes, Int, "The sub-context codes (i.e. course sections and group categories) this appointment group is restricted to.Example: course_section_234", required: false
|
37
37
|
argument :workflow_state, AppointmentGroupWorkflowStateEnum, "Current state of the appointment group ('pending', 'active' or 'deleted'). 'pending' indicates that it has not been published yet and is invisible to participants..Example: active", required: false
|
38
38
|
argument :requiring_action, Boolean, "Boolean indicating whether the current user needs to sign up for this appointment group (i.e. it's reservable and the min_appointments_per_participant limit has not been met by this user)..Example: true", required: false
|
39
39
|
argument :appointments_count, Int, "Number of time slots in this appointment group.Example: 2", required: false
|
40
|
-
argument :appointments, [LMSGraphQL::Types::Canvas::
|
41
|
-
argument :new_appointments, [LMSGraphQL::Types::Canvas::
|
40
|
+
argument :appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEventInput], "Calendar Events representing the time slots (see include[] argument) Refer to the Calendar Events API for more information.", required: false
|
41
|
+
argument :new_appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEventInput], "Newly created time slots (same format as appointments above). Only returned in Create/Update responses where new time slots have been added.", required: false
|
42
42
|
argument :max_appointments_per_participant, Int, "Maximum number of time slots a user may register for, or null if no limit.Example: 1", required: false
|
43
43
|
argument :min_appointments_per_participant, Int, "Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots.Example: 1", required: false
|
44
44
|
argument :participants_per_appointment, Int, "Maximum number of participants that may register for each time slot, or null if no limit.Example: 1", required: false
|
@@ -94,6 +94,7 @@ module LMSGraphQL
|
|
94
94
|
field :overrides, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverride], "(Optional) If 'overrides' is included in the 'include' parameter, includes an array of assignment override objects..", null: true
|
95
95
|
field :omit_from_final_grade, Boolean, "(Optional) If true, the assignment will be omitted from the student's final grade.Example: true", null: true
|
96
96
|
field :moderated_grading, Boolean, "Boolean indicating if the assignment is moderated..Example: true", null: true
|
97
|
+
field :allowed_attempts, Int, "The number of submission attempts a student can make for this assignment. -1 is considered unlimited..Example: 2", null: true
|
97
98
|
|
98
99
|
end
|
99
100
|
end
|
@@ -24,8 +24,8 @@ module LMSGraphQL
|
|
24
24
|
argument :all_day, Boolean, "Boolean indicating whether this is an all-day event (e.g. assignment due at midnight).Example: true", required: false
|
25
25
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "When the assignment was created.Example: 2012-07-12T10:55:20-06:00", required: false
|
26
26
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "When the assignment was last updated.Example: 2012-07-12T10:55:20-06:00", required: false
|
27
|
-
argument :assignment, LMSGraphQL::Types::Canvas::
|
28
|
-
argument :assignment_overrides, LMSGraphQL::Types::Canvas::
|
27
|
+
argument :assignment, LMSGraphQL::Types::Canvas::CanvasAssignmentInput, "The full assignment JSON data (See the Assignments API).", required: false
|
28
|
+
argument :assignment_overrides, LMSGraphQL::Types::Canvas::CanvasAssignmentOverrideInput, "The list of AssignmentOverrides that apply to this event (See the Assignments API). This information is useful for determining which students or sections this assignment-due event applies to..", required: false
|
29
29
|
|
30
30
|
end
|
31
31
|
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require_relative "../canvas_base_type"
|
2
|
+
|
3
|
+
|
4
|
+
module LMSGraphQL
|
5
|
+
module Types
|
6
|
+
module Canvas
|
7
|
+
class CanvasAssignmentExtension < BaseType
|
8
|
+
description "Assignment Extensions. API Docs: https://canvas.instructure.com/doc/api/assignment_extensions.html"
|
9
|
+
field :assignment_id, ID, "The ID of the Assignment the extension belongs to..Example: 2", null: true
|
10
|
+
field :user_id, ID, "The ID of the Student that needs the assignment extension..Example: 3", null: true
|
11
|
+
field :extra_attempts, Int, "Number of times the student is allowed to re-submit the assignment.Example: 2", null: true
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require_relative "../canvas_base_input_type"
|
2
|
+
|
3
|
+
|
4
|
+
module LMSGraphQL
|
5
|
+
module Types
|
6
|
+
module Canvas
|
7
|
+
class CanvasAssignmentExtensionInput < BaseInputObject
|
8
|
+
description "Assignment Extensions. API Docs: https://canvas.instructure.com/doc/api/assignment_extensions.html"
|
9
|
+
argument :assignment_id, ID, "The ID of the Assignment the extension belongs to..Example: 2", required: false
|
10
|
+
argument :user_id, ID, "The ID of the Student that needs the assignment extension..Example: 3", required: false
|
11
|
+
argument :extra_attempts, Int, "Number of times the student is allowed to re-submit the assignment.Example: 2", required: false
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -13,7 +13,7 @@ module LMSGraphQL
|
|
13
13
|
argument :sis_source_id, ID, "the sis source id of the Assignment Group.Example: 1234", required: false
|
14
14
|
argument :integration_data, String, "the integration data of the Assignment Group.Example: 0954", required: false
|
15
15
|
argument :assignments, Int, "the assignments in this Assignment Group (see the Assignment API for a detailed list of fields).", required: false
|
16
|
-
argument :rules, LMSGraphQL::Types::Canvas::
|
16
|
+
argument :rules, LMSGraphQL::Types::Canvas::CanvasGradingRuleInput, "the grading rules that this Assignment Group has.", required: false
|
17
17
|
|
18
18
|
end
|
19
19
|
end
|
@@ -43,7 +43,7 @@ module LMSGraphQL
|
|
43
43
|
argument :lock_at, LMSGraphQL::Types::DateTimeType, "the lock date (assignment is locked after this date). returns null if not present. NOTE: If this assignment has assignment overrides, this field will be the lock date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", required: false
|
44
44
|
argument :unlock_at, LMSGraphQL::Types::DateTimeType, "the unlock date (assignment is unlocked after this date) returns null if not present NOTE: If this assignment has assignment overrides, this field will be the unlock date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", required: false
|
45
45
|
argument :has_overrides, Boolean, "whether this assignment has overrides.Example: true", required: false
|
46
|
-
argument :all_dates, [LMSGraphQL::Types::Canvas::
|
46
|
+
argument :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDateInput], "(Optional) all dates associated with the assignment, if applicable.", required: false
|
47
47
|
argument :course_id, ID, "the ID of the course the assignment belongs to.Example: 123", required: false
|
48
48
|
argument :html_url, String, "the URL to the assignment's web page.Example: https://.", required: false
|
49
49
|
argument :submissions_download_url, String, "the URL to download all submissions as a zip.Example: https://example.com/courses/:course_id/assignments/:id/submissions?zip=1", required: false
|
@@ -53,9 +53,9 @@ module LMSGraphQL
|
|
53
53
|
argument :max_name_length, Int, "An integer indicating the maximum length an assignment's name may be.Example: 15", required: false
|
54
54
|
argument :turnitin_enabled, Boolean, "Boolean flag indicating whether or not Turnitin has been enabled for the assignment. NOTE: This flag will not appear unless your account has the Turnitin plugin available.Example: true", required: false
|
55
55
|
argument :vericite_enabled, Boolean, "Boolean flag indicating whether or not VeriCite has been enabled for the assignment. NOTE: This flag will not appear unless your account has the VeriCite plugin available.Example: true", required: false
|
56
|
-
argument :turnitin_settings, LMSGraphQL::Types::Canvas::
|
56
|
+
argument :turnitin_settings, LMSGraphQL::Types::Canvas::CanvasTurnitinSettingInput, "Settings to pass along to turnitin to control what kinds of matches should be considered. originality_report_visibility can be 'immediate', 'after_grading', 'after_due_date', or 'never' exclude_small_matches_type can be null, 'percent', 'words' exclude_small_matches_value: - if type is null, this will be null also - if type is 'percent', this will be a number between 0 and 100 representing match size to exclude as a percentage of the document size. - if type is 'words', this will be number > 0 representing how many words a match must contain for it to be considered NOTE: This flag will not appear unless your account has the Turnitin plugin available.", required: false
|
57
57
|
argument :grade_group_students_individually, Boolean, "If this is a group assignment, boolean flag indicating whether or not students will be graded individually..", required: false
|
58
|
-
argument :external_tool_tag_attributes, LMSGraphQL::Types::Canvas::
|
58
|
+
argument :external_tool_tag_attributes, LMSGraphQL::Types::Canvas::CanvasExternalToolTagAttributeInput, "(Optional) assignment's settings for external tools if submission_types include 'external_tool'. Only url and new_tab are included (new_tab defaults to false). Use the 'External Tools' API if you need more information about an external tool..", required: false
|
59
59
|
argument :peer_reviews, Boolean, "Boolean indicating if peer reviews are required for this assignment.", required: false
|
60
60
|
argument :automatic_peer_reviews, Boolean, "Boolean indicating peer reviews are assigned automatically. If false, the teacher is expected to manually assign peer reviews..", required: false
|
61
61
|
argument :peer_review_count, Int, "Integer representing the amount of reviews each user is assigned. NOTE: This key is NOT present unless you have automatic_peer_reviews set to true..Example: 0", required: false
|
@@ -63,7 +63,7 @@ module LMSGraphQL
|
|
63
63
|
argument :intra_group_peer_reviews, Boolean, "Boolean representing whether or not members from within the same group on a group assignment can be assigned to peer review their own group's work.Example: false", required: false
|
64
64
|
argument :group_category_id, ID, "The ID of the assignment’s group set, if this is a group assignment. For group discussions, set group_category_id on the discussion topic, not the linked assignment..Example: 1", required: false
|
65
65
|
argument :needs_grading_count, Int, "if the requesting user has grading rights, the number of submissions that need grading..Example: 17", required: false
|
66
|
-
argument :needs_grading_count_by_section, [LMSGraphQL::Types::Canvas::
|
66
|
+
argument :needs_grading_count_by_section, [LMSGraphQL::Types::Canvas::CanvasNeedsGradingCountInput], "if the requesting user has grading rights and the 'needs_grading_count_by_section' flag is specified, the number of submissions that need grading split out by section. NOTE: This key is NOT present unless you pass the 'needs_grading_count_by_section' argument as true. ANOTHER NOTE: it's possible to be enrolled in multiple sections, and if a student is setup that way they will show an assignment that needs grading in multiple sections (effectively the count will be duplicated between sections).Example: {'section_id'=>'123456', 'needs_grading_count'=>5}, {'section_id'=>'654321', 'needs_grading_count'=>0}", required: false
|
67
67
|
argument :position, Int, "the sorting order of the assignment in the group.Example: 1", required: false
|
68
68
|
argument :post_to_sis, Boolean, "(optional, present if Sync Grades to SIS feature is enabled).Example: true", required: false
|
69
69
|
argument :integration_id, ID, "(optional, Third Party unique identifier for Assignment).Example: 12341234", required: false
|
@@ -78,22 +78,23 @@ module LMSGraphQL
|
|
78
78
|
argument :unpublishable, Boolean, "Whether the assignment's 'published' state can be changed to false. Will be false if there are student submissions for the assignment..", required: false
|
79
79
|
argument :only_visible_to_overrides, Boolean, "Whether the assignment is only visible to overrides..", required: false
|
80
80
|
argument :locked_for_user, Boolean, "Whether or not this is locked for the user..", required: false
|
81
|
-
argument :lock_info, LMSGraphQL::Types::Canvas::
|
81
|
+
argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
|
82
82
|
argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This assignment is locked until September 1 at 12:00am", required: false
|
83
83
|
argument :quiz_id, ID, "(Optional) id of the associated quiz (applies only when submission_types is ['online_quiz']).Example: 620", required: false
|
84
84
|
argument :anonymous_submissions, Boolean, "(Optional) whether anonymous submissions are accepted (applies only to quiz assignments).", required: false
|
85
|
-
argument :discussion_topic, LMSGraphQL::Types::Canvas::
|
85
|
+
argument :discussion_topic, LMSGraphQL::Types::Canvas::CanvasDiscussionTopicInput, "(Optional) the DiscussionTopic associated with the assignment, if applicable.", required: false
|
86
86
|
argument :freeze_on_copy, Boolean, "(Optional) Boolean indicating if assignment will be frozen when it is copied. NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..", required: false
|
87
87
|
argument :frozen, Boolean, "(Optional) Boolean indicating if assignment is frozen for the calling user. NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..", required: false
|
88
88
|
argument :frozen_attributes, String, "(Optional) Array of frozen attributes for the assignment. Only account administrators currently have permission to change an attribute in this list. Will be empty if no attributes are frozen for this assignment. Possible frozen attributes are: title, description, lock_at, points_possible, grading_type, submission_types, assignment_group_id, allowed_extensions, group_category_id, notify_of_update, peer_reviews NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..Example: title", required: false
|
89
|
-
argument :submission, LMSGraphQL::Types::Canvas::
|
89
|
+
argument :submission, LMSGraphQL::Types::Canvas::CanvasSubmissionInput, "(Optional) If 'submission' is included in the 'include' parameter, includes a Submission object that represents the current user's (user who is requesting information from the api) current submission for the assignment. See the Submissions API for an example response. If the user does not have a submission, this key will be absent..", required: false
|
90
90
|
argument :use_rubric_for_grading, Boolean, "(Optional) If true, the rubric is directly tied to grading the assignment. Otherwise, it is only advisory. Included if there is an associated rubric..Example: true", required: false
|
91
91
|
argument :rubric_settings, String, "(Optional) An object describing the basic attributes of the rubric, including the point total. Included if there is an associated rubric..Example: {'points_possible'=>12}", required: false
|
92
|
-
argument :rubric, [LMSGraphQL::Types::Canvas::
|
92
|
+
argument :rubric, [LMSGraphQL::Types::Canvas::CanvasRubricCriteriumInput], "(Optional) A list of scoring criteria and ratings for each rubric criterion. Included if there is an associated rubric..", required: false
|
93
93
|
argument :assignment_visibility, Int, "(Optional) If 'assignment_visibility' is included in the 'include' parameter, includes an array of student IDs who can see this assignment..Example: 137, 381, 572", required: false
|
94
|
-
argument :overrides, [LMSGraphQL::Types::Canvas::
|
94
|
+
argument :overrides, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverrideInput], "(Optional) If 'overrides' is included in the 'include' parameter, includes an array of assignment override objects..", required: false
|
95
95
|
argument :omit_from_final_grade, Boolean, "(Optional) If true, the assignment will be omitted from the student's final grade.Example: true", required: false
|
96
96
|
argument :moderated_grading, Boolean, "Boolean indicating if the assignment is moderated..Example: true", required: false
|
97
|
+
argument :allowed_attempts, Int, "The number of submission attempts a student can make for this assignment. -1 is considered unlimited..Example: 2", required: false
|
97
98
|
|
98
99
|
end
|
99
100
|
end
|
@@ -24,7 +24,7 @@ module LMSGraphQL
|
|
24
24
|
argument :login_attribute, String, "Valid for SAML providers..Example: nameid", required: false
|
25
25
|
argument :sig_alg, String, "Valid for SAML providers..Example: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256", required: false
|
26
26
|
argument :jit_provisioning, Boolean, "Just In Time provisioning. Valid for all providers except Canvas (which has the similar in concept self_registration setting)..", required: false
|
27
|
-
argument :federated_attributes, LMSGraphQL::Types::Canvas::
|
27
|
+
argument :federated_attributes, LMSGraphQL::Types::Canvas::CanvasFederatedAttributesConfigInput, "", required: false
|
28
28
|
|
29
29
|
end
|
30
30
|
end
|
@@ -18,7 +18,7 @@ module LMSGraphQL
|
|
18
18
|
argument :has_advanced_settings, Boolean, "True if the conference type has advanced settings..", required: false
|
19
19
|
argument :long_running, Boolean, "If true the conference is long running and has no expected end time.", required: false
|
20
20
|
argument :user_settings, String, "A collection of settings specific to the conference type.Example: true", required: false
|
21
|
-
argument :recordings, [LMSGraphQL::Types::Canvas::
|
21
|
+
argument :recordings, [LMSGraphQL::Types::Canvas::CanvasConferenceRecordingInput], "A List of recordings for the conference.", required: false
|
22
22
|
argument :url, String, "URL for the conference, may be null if the conference type doesn't set it.", required: false
|
23
23
|
argument :join_url, String, "URL to join the conference, may be null if the conference type doesn't set it.", required: false
|
24
24
|
|
@@ -12,7 +12,7 @@ module LMSGraphQL
|
|
12
12
|
argument :lock_at, LMSGraphQL::Types::DateTimeType, "Example: 2012-12-31T06:00:00-06:00", required: false
|
13
13
|
argument :locked_for_user, Boolean, "Example: true", required: false
|
14
14
|
argument :lock_explanation, String, "Example: This quiz is part of an unpublished module and is not available yet.", required: false
|
15
|
-
argument :lock_info, LMSGraphQL::Types::Canvas::
|
15
|
+
argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "Example: assignment_4, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00, {}", required: false
|
16
16
|
|
17
17
|
end
|
18
18
|
end
|
@@ -20,7 +20,7 @@ module LMSGraphQL
|
|
20
20
|
argument :id, ID, "the unique identifier for the export.Example: 101", required: false
|
21
21
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "the date and time this export was requested.Example: 2014-01-01T00:00:00Z", required: false
|
22
22
|
argument :export_type, ContentExportExportTypeEnum, "the type of content migration: 'common_cartridge' or 'qti'.Example: common_cartridge", required: false
|
23
|
-
argument :attachment, LMSGraphQL::Types::Canvas::
|
23
|
+
argument :attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "attachment api object for the export package (not present before the export completes or after it becomes unavailable for download.).Example: https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh", required: false
|
24
24
|
argument :progress_url, String, "The api endpoint for polling the current progress.Example: https://example.com/api/v1/progress/4", required: false
|
25
25
|
argument :user_id, ID, "The ID of the user who started the export.Example: 4", required: false
|
26
26
|
argument :workflow_state, ContentExportWorkflowStateEnum, "Current state of the content migration: created exporting exported failed.Example: exported", required: false
|
@@ -19,7 +19,7 @@ module LMSGraphQL
|
|
19
19
|
argument :audience, Int, "Array of user ids who are involved in the conversation, ordered by participation level, then alphabetical. Excludes current user, unless this is a monologue..", required: false
|
20
20
|
argument :audience_contexts, String, "Most relevant shared contexts (courses and groups) between current user and other participants. If there is only one participant, it will also include that user's enrollment(s)/ membership type(s) in each course/group..", required: false
|
21
21
|
argument :avatar_url, String, "URL to appropriate icon for this conversation (custom, individual or group avatar, depending on audience)..Example: https://canvas.instructure.com/images/messages/avatar-group-50.png", required: false
|
22
|
-
argument :participants, [LMSGraphQL::Types::Canvas::
|
22
|
+
argument :participants, [LMSGraphQL::Types::Canvas::CanvasConversationParticipantInput], "Array of users participating in the conversation. Includes current user..", required: false
|
23
23
|
argument :visible, Boolean, "indicates whether the conversation is visible under the current scope and filter. This attribute is always true in the index API response, and is primarily useful in create/update responses so that you can know if the record should be displayed in the UI. The default scope is assumed, unless a scope or filter is passed to the create/update API call..Example: true", required: false
|
24
24
|
argument :context_name, String, "Name of the course or group in which the conversation is occurring..Example: Canvas 101", required: false
|
25
25
|
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
8
8
|
description "ePub Exports. API Docs: https://canvas.instructure.com/doc/api/e_pub_exports.html"
|
9
9
|
argument :id, ID, "the unique identifier for the course.Example: 101", required: false
|
10
10
|
argument :name, String, "the name for the course.Example: Maths 101", required: false
|
11
|
-
argument :epub_export, LMSGraphQL::Types::Canvas::
|
11
|
+
argument :epub_export, LMSGraphQL::Types::Canvas::CanvasEpubExportInput, "ePub export API object.", required: false
|
12
12
|
|
13
13
|
end
|
14
14
|
end
|
@@ -11,7 +11,7 @@ module LMSGraphQL
|
|
11
11
|
argument :event_type, String, "Course event type The event type defines the type and schema of the event_data object..Example: updated", required: false
|
12
12
|
argument :event_data, String, "Course event data depending on the event type. This will return an object containing the relevant event data. An updated event type will return an UpdatedEventData object..Example: {}", required: false
|
13
13
|
argument :event_source, String, "Course event source depending on the event type. This will return a string containing the source of the event..Example: manual|sis|api", required: false
|
14
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
14
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasCourseEventLinkInput, "Jsonapi.org links.Example: 12345, 12345, e2b76430-27a5-0131-3ca1-48e0eb13f29b", required: false
|
15
15
|
|
16
16
|
end
|
17
17
|
end
|
@@ -39,14 +39,14 @@ module LMSGraphQL
|
|
39
39
|
argument :start_at, LMSGraphQL::Types::DateTimeType, "the start date for the course, if applicable.Example: 2012-06-01T00:00:00-06:00", required: false
|
40
40
|
argument :end_at, LMSGraphQL::Types::DateTimeType, "the end date for the course, if applicable.Example: 2012-09-01T00:00:00-06:00", required: false
|
41
41
|
argument :locale, String, "the course-set locale, if applicable.Example: en", required: false
|
42
|
-
argument :enrollments, [LMSGraphQL::Types::Canvas::
|
42
|
+
argument :enrollments, [LMSGraphQL::Types::Canvas::CanvasEnrollmentInput], "A list of enrollments linking the current user to the course. for student enrollments, grading information may be included if include[]=total_scores.", required: false
|
43
43
|
argument :total_students, Int, "optional: the total number of active and invited students in the course.Example: 32", required: false
|
44
|
-
argument :calendar, LMSGraphQL::Types::Canvas::
|
44
|
+
argument :calendar, LMSGraphQL::Types::Canvas::CanvasCalendarLinkInput, "course calendar.", required: false
|
45
45
|
argument :default_view, CourseDefaultViewEnum, "the type of page that users will see when they first visit the course - 'feed': Recent Activity Dashboard - 'wiki': Wiki Front Page - 'modules': Course Modules/Sections Page - 'assignments': Course Assignments List - 'syllabus': Course Syllabus Page other types may be added in the future.Example: feed", required: false
|
46
46
|
argument :syllabus_body, String, "optional: user-generated HTML for the course syllabus.Example: <p>syllabus html goes here</p>", required: false
|
47
47
|
argument :needs_grading_count, Int, "optional: the number of submissions needing grading returned only if the current user has grading rights and include[]=needs_grading_count.Example: 17", required: false
|
48
|
-
argument :term, LMSGraphQL::Types::Canvas::
|
49
|
-
argument :course_progress, LMSGraphQL::Types::Canvas::
|
48
|
+
argument :term, LMSGraphQL::Types::Canvas::CanvasTermInput, "optional: the enrollment term object for the course returned only if include[]=term.", required: false
|
49
|
+
argument :course_progress, LMSGraphQL::Types::Canvas::CanvasCourseProgressInput, "optional (beta): information on progress through the course returned only if include[]=course_progress.", required: false
|
50
50
|
argument :apply_assignment_group_weights, Boolean, "weight final grade based on assignment group percentages.Example: true", required: false
|
51
51
|
argument :permissions, String, "optional: the permissions the user has for the course. returned only for a single course and include[]=permissions.Example: true, true", required: false
|
52
52
|
argument :is_public, Boolean, "Example: true", required: false
|
@@ -43,7 +43,7 @@ module LMSGraphQL
|
|
43
43
|
argument :locked, Boolean, "Whether or not the discussion is 'closed for comments'..", required: false
|
44
44
|
argument :pinned, Boolean, "Whether or not the discussion has been 'pinned' by an instructor.", required: false
|
45
45
|
argument :locked_for_user, Boolean, "Whether or not this is locked for the user..Example: true", required: false
|
46
|
-
argument :lock_info, LMSGraphQL::Types::Canvas::
|
46
|
+
argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
|
47
47
|
argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This discussion is locked until September 1 at 12:00am", required: false
|
48
48
|
argument :user_name, String, "The username of the topic creator..Example: User Name", required: false
|
49
49
|
argument :topic_children, Int, "DEPRECATED An array of topic_ids for the group discussions the user is a part of..Example: 5, 7, 10", required: false
|
@@ -52,7 +52,7 @@ module LMSGraphQL
|
|
52
52
|
argument :podcast_url, String, "If the topic is a podcast topic this is the feed url for the current user..Example: /feeds/topics/1/enrollment_1XAcepje4u228rt4mi7Z1oFbRpn3RAkTzuXIGOPe.rss", required: false
|
53
53
|
argument :discussion_type, DiscussionTopicDiscussionTypeEnum, "The type of discussion. Values are 'side_comment', for discussions that only allow one level of nested comments, and 'threaded' for fully threaded discussions..Example: side_comment", required: false
|
54
54
|
argument :group_category_id, ID, "The unique identifier of the group category if the topic is a group discussion, otherwise null..", required: false
|
55
|
-
argument :attachments, [LMSGraphQL::Types::Canvas::
|
55
|
+
argument :attachments, [LMSGraphQL::Types::Canvas::CanvasFileAttachmentInput], "Array of file attachments..", required: false
|
56
56
|
argument :permissions, String, "The current user's permissions on this topic..Example: true", required: false
|
57
57
|
argument :allow_rating, Boolean, "Whether or not users can rate entries in this topic..Example: true", required: false
|
58
58
|
argument :only_graders_can_rate, Boolean, "Whether or not grade permissions are required to rate entries..Example: true", required: false
|
@@ -35,10 +35,12 @@ module LMSGraphQL
|
|
35
35
|
field :html_url, String, "The URL to the Canvas web UI page for this course enrollment..Example: https://.", null: true
|
36
36
|
field :grades, LMSGraphQL::Types::Canvas::CanvasGrade, "The URL to the Canvas web UI page containing the grades associated with this enrollment..Example: https://., 35, , 6.67, ", null: true
|
37
37
|
field :user, LMSGraphQL::Types::Canvas::CanvasUser, "A description of the user..Example: 3, Student 1, 1, Student, Stud 1", null: true
|
38
|
-
field :computed_current_score, Float, "optional: The student's score in the course, ignoring ungraded assignments. (applies only to student enrollments, and only available in course endpoints).Example: 90.25", null: true
|
39
|
-
field :computed_final_score, Float, "optional: The student's score in the course including ungraded assignments with a score of 0. (applies only to student enrollments, and only available in course endpoints).Example: 80.67", null: true
|
40
|
-
field :computed_current_grade, String, "optional: The letter grade equivalent of computed_current_score, if available. (applies only to student enrollments, and only available in course endpoints).Example: A-", null: true
|
41
|
-
field :computed_final_grade, String, "optional: The letter grade equivalent of computed_final_score, if available. (applies only to student enrollments, and only available in course endpoints).Example: B-", null: true
|
38
|
+
field :computed_current_score, Float, "optional: The student's score in the course, ignoring ungraded assignments. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed current score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 90.25", null: true
|
39
|
+
field :computed_final_score, Float, "optional: The student's score in the course including ungraded assignments with a score of 0. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed final score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 80.67", null: true
|
40
|
+
field :computed_current_grade, String, "optional: The letter grade equivalent of computed_current_score, if available. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed current grade..Example: A-", null: true
|
41
|
+
field :computed_final_grade, String, "optional: The letter grade equivalent of computed_final_score, if available. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed final grade..Example: B-", null: true
|
42
|
+
field :override_grade, String, "The user's override grade for the course..Example: A", null: true
|
43
|
+
field :override_score, Float, "The user's override score for the course..Example: 99.99", null: true
|
42
44
|
field :unposted_current_grade, String, "The user's current grade in the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins..", null: true
|
43
45
|
field :unposted_final_grade, String, "The user's final grade for the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins...", null: true
|
44
46
|
field :unposted_current_score, String, "The user's current score in the class including muted/unposted assignments. Only included if user has permissions to view this score, typically teachers, TAs, and admins...", null: true
|
@@ -47,10 +49,12 @@ module LMSGraphQL
|
|
47
49
|
field :totals_for_all_grading_periods_option, Boolean, "optional: Indicates whether the course the enrollment belongs to has the Display Totals for 'All Grading Periods' feature enabled. (applies only to student enrollments, and only available in course endpoints).Example: true", null: true
|
48
50
|
field :current_grading_period_title, String, "optional: The name of the currently active grading period, if one exists. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: Fall Grading Period", null: true
|
49
51
|
field :current_grading_period_id, ID, "optional: The id of the currently active grading period, if one exists. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 5", null: true
|
50
|
-
field :current_period_computed_current_score, Float, "optional: The student's score in the course for the current grading period, ignoring ungraded assignments. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 95.8", null: true
|
51
|
-
field :current_period_computed_final_score, Float, "optional: The student's score in the course for the current grading period, including ungraded assignments with a score of 0. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 85.25", null: true
|
52
|
-
field :current_period_computed_current_grade, String, "optional: The letter grade equivalent of current_period_computed_current_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: A", null: true
|
53
|
-
field :current_period_computed_final_grade, String, "optional: The letter grade equivalent of current_period_computed_final_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: B", null: true
|
52
|
+
field :current_period_computed_current_score, Float, "optional: The student's score in the course for the current grading period, ignoring ungraded assignments. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed current score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 95.8", null: true
|
53
|
+
field :current_period_computed_final_score, Float, "optional: The student's score in the course for the current grading period, including ungraded assignments with a score of 0. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed final score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 85.25", null: true
|
54
|
+
field :current_period_computed_current_grade, String, "optional: The letter grade equivalent of current_period_computed_current_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed current grade..Example: A", null: true
|
55
|
+
field :current_period_computed_final_grade, String, "optional: The letter grade equivalent of current_period_computed_final_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed final grade..Example: B", null: true
|
56
|
+
field :current_period_override_grade, String, "The user's override grade for the current grading period..Example: A", null: true
|
57
|
+
field :current_period_override_score, Float, "The user's override score for the current grading period..Example: 99.99", null: true
|
54
58
|
field :current_period_unposted_current_score, Float, "optional: The student's score in the course for the current grading period, including muted/unposted assignments. Only included if user has permission to view this score, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 95.8", null: true
|
55
59
|
field :current_period_unposted_final_score, Float, "optional: The student's score in the course for the current grading period, including muted/unposted assignments and including ungraded assignments with a score of 0. Only included if user has permission to view this score, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 85.25", null: true
|
56
60
|
field :current_period_unposted_current_grade, String, "optional: The letter grade equivalent of current_period_unposted_current_score, if available. Only included if user has permission to view this grade, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: A", null: true
|
@@ -33,12 +33,14 @@ module LMSGraphQL
|
|
33
33
|
argument :last_attended_at, LMSGraphQL::Types::DateTimeType, "The last attended date of the user for the enrollment in a course, in ISO8601 format..Example: 2012-04-18T23:08:51Z", required: false
|
34
34
|
argument :total_activity_time, Int, "The total activity time of the user for the enrollment, in seconds..Example: 260", required: false
|
35
35
|
argument :html_url, String, "The URL to the Canvas web UI page for this course enrollment..Example: https://.", required: false
|
36
|
-
argument :grades, LMSGraphQL::Types::Canvas::
|
37
|
-
argument :user, LMSGraphQL::Types::Canvas::
|
38
|
-
argument :computed_current_score, Float, "optional: The student's score in the course, ignoring ungraded assignments. (applies only to student enrollments, and only available in course endpoints).Example: 90.25", required: false
|
39
|
-
argument :computed_final_score, Float, "optional: The student's score in the course including ungraded assignments with a score of 0. (applies only to student enrollments, and only available in course endpoints).Example: 80.67", required: false
|
40
|
-
argument :computed_current_grade, String, "optional: The letter grade equivalent of computed_current_score, if available. (applies only to student enrollments, and only available in course endpoints).Example: A-", required: false
|
41
|
-
argument :computed_final_grade, String, "optional: The letter grade equivalent of computed_final_score, if available. (applies only to student enrollments, and only available in course endpoints).Example: B-", required: false
|
36
|
+
argument :grades, LMSGraphQL::Types::Canvas::CanvasGradeInput, "The URL to the Canvas web UI page containing the grades associated with this enrollment..Example: https://., 35, , 6.67, ", required: false
|
37
|
+
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "A description of the user..Example: 3, Student 1, 1, Student, Stud 1", required: false
|
38
|
+
argument :computed_current_score, Float, "optional: The student's score in the course, ignoring ungraded assignments. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed current score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 90.25", required: false
|
39
|
+
argument :computed_final_score, Float, "optional: The student's score in the course including ungraded assignments with a score of 0. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed final score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 80.67", required: false
|
40
|
+
argument :computed_current_grade, String, "optional: The letter grade equivalent of computed_current_score, if available. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed current grade..Example: A-", required: false
|
41
|
+
argument :computed_final_grade, String, "optional: The letter grade equivalent of computed_final_score, if available. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed final grade..Example: B-", required: false
|
42
|
+
argument :override_grade, String, "The user's override grade for the course..Example: A", required: false
|
43
|
+
argument :override_score, Float, "The user's override score for the course..Example: 99.99", required: false
|
42
44
|
argument :unposted_current_grade, String, "The user's current grade in the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins..", required: false
|
43
45
|
argument :unposted_final_grade, String, "The user's final grade for the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins...", required: false
|
44
46
|
argument :unposted_current_score, String, "The user's current score in the class including muted/unposted assignments. Only included if user has permissions to view this score, typically teachers, TAs, and admins...", required: false
|
@@ -47,10 +49,12 @@ module LMSGraphQL
|
|
47
49
|
argument :totals_for_all_grading_periods_option, Boolean, "optional: Indicates whether the course the enrollment belongs to has the Display Totals for 'All Grading Periods' feature enabled. (applies only to student enrollments, and only available in course endpoints).Example: true", required: false
|
48
50
|
argument :current_grading_period_title, String, "optional: The name of the currently active grading period, if one exists. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: Fall Grading Period", required: false
|
49
51
|
argument :current_grading_period_id, ID, "optional: The id of the currently active grading period, if one exists. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 5", required: false
|
50
|
-
argument :current_period_computed_current_score, Float, "optional: The student's score in the course for the current grading period, ignoring ungraded assignments. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 95.8", required: false
|
51
|
-
argument :current_period_computed_final_score, Float, "optional: The student's score in the course for the current grading period, including ungraded assignments with a score of 0. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 85.25", required: false
|
52
|
-
argument :current_period_computed_current_grade, String, "optional: The letter grade equivalent of current_period_computed_current_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: A", required: false
|
53
|
-
argument :current_period_computed_final_grade, String, "optional: The letter grade equivalent of current_period_computed_final_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: B", required: false
|
52
|
+
argument :current_period_computed_current_score, Float, "optional: The student's score in the course for the current grading period, ignoring ungraded assignments. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed current score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 95.8", required: false
|
53
|
+
argument :current_period_computed_final_score, Float, "optional: The student's score in the course for the current grading period, including ungraded assignments with a score of 0. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override score exists, a student will receive the override score while a teacher receives the actual computed final score. If a grading standard exists for the course, the returned override score is the lower bound of its grade..Example: 85.25", required: false
|
54
|
+
argument :current_period_computed_current_grade, String, "optional: The letter grade equivalent of current_period_computed_current_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed current grade..Example: A", required: false
|
55
|
+
argument :current_period_computed_final_grade, String, "optional: The letter grade equivalent of current_period_computed_final_score, if available. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints). If an override grade exists, a student will receive the override grade while a teacher receives the actual computed final grade..Example: B", required: false
|
56
|
+
argument :current_period_override_grade, String, "The user's override grade for the current grading period..Example: A", required: false
|
57
|
+
argument :current_period_override_score, Float, "The user's override score for the current grading period..Example: 99.99", required: false
|
54
58
|
argument :current_period_unposted_current_score, Float, "optional: The student's score in the course for the current grading period, including muted/unposted assignments. Only included if user has permission to view this score, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 95.8", required: false
|
55
59
|
argument :current_period_unposted_final_score, Float, "optional: The student's score in the course for the current grading period, including muted/unposted assignments and including ungraded assignments with a score of 0. Only included if user has permission to view this score, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: 85.25", required: false
|
56
60
|
argument :current_period_unposted_current_grade, String, "optional: The letter grade equivalent of current_period_unposted_current_score, if available. Only included if user has permission to view this grade, typically teachers, TAs, and admins. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints).Example: A", required: false
|
@@ -16,7 +16,7 @@ module LMSGraphQL
|
|
16
16
|
description "ePub Exports. API Docs: https://canvas.instructure.com/doc/api/e_pub_exports.html"
|
17
17
|
argument :id, ID, "the unique identifier for the export.Example: 101", required: false
|
18
18
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "the date and time this export was requested.Example: 2014-01-01T00:00:00Z", required: false
|
19
|
-
argument :attachment, LMSGraphQL::Types::Canvas::
|
19
|
+
argument :attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "attachment api object for the export ePub (not present until the export completes).Example: https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh", required: false
|
20
20
|
argument :progress_url, String, "The api endpoint for polling the current progress.Example: https://example.com/api/v1/progress/4", required: false
|
21
21
|
argument :user_id, ID, "The ID of the user who started the export.Example: 4", required: false
|
22
22
|
argument :workflow_state, EpubExportWorkflowStateEnum, "Current state of the ePub export: created exporting exported generating generated failed.Example: exported", required: false
|
@@ -20,7 +20,7 @@ module LMSGraphQL
|
|
20
20
|
* Course features may be controlled by flags on courses and their parent accounts.
|
21
21
|
* User features may be controlled by flags on users and site admin only..Example: Course", required: false
|
22
22
|
argument :enable_at, LMSGraphQL::Types::DateTimeType, "The date this feature will be globally enabled, or null if this is not planned. (This information is subject to change.).Example: 2014-01-01T00:00:00Z", required: false
|
23
|
-
argument :feature_flag, LMSGraphQL::Types::Canvas::
|
23
|
+
argument :feature_flag, LMSGraphQL::Types::Canvas::CanvasFeatureFlagInput, "The FeatureFlag that applies to the caller.Example: fancy_wickets, allowed", required: false
|
24
24
|
argument :root_opt_in, Boolean, "If true, a feature that is 'allowed' globally will be 'off' by default in root accounts. Otherwise, root accounts inherit the global 'allowed' setting, which allows sub-accounts and courses to turn features on with no root account action..Example: true", required: false
|
25
25
|
argument :beta, Boolean, "Whether the feature is a beta feature. If true, the feature may not be fully polished and may be subject to change in the future..Example: true", required: false
|
26
26
|
argument :autoexpand, Boolean, "Whether the details of the feature are autoexpanded on page load vs. the user clicking to expand..Example: true", required: false
|
@@ -16,7 +16,7 @@ module LMSGraphQL
|
|
16
16
|
argument :graded_anonymously, Boolean, "Boolean indicating whether the student name was visible when the grade was given. Could be null if the grade change record was created before this feature existed..Example: true", required: false
|
17
17
|
argument :version_number, String, "Version Number of the grade change submission..Example: 1", required: false
|
18
18
|
argument :request_id, ID, "The unique request id of the request during the grade change..Example: e2b76430-27a5-0131-3ca1-48e0eb13f29b", required: false
|
19
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
19
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasGradeChangeEventLinkInput, "", required: false
|
20
20
|
|
21
21
|
end
|
22
22
|
end
|
@@ -10,7 +10,7 @@ module LMSGraphQL
|
|
10
10
|
argument :id, ID, "the id of the grading standard.Example: 1", required: false
|
11
11
|
argument :context_type, String, "the context this standard is associated with, either 'Account' or 'Course'.Example: Account", required: false
|
12
12
|
argument :context_id, ID, "the id for the context either the Account or Course id.Example: 1", required: false
|
13
|
-
argument :grading_scheme, [LMSGraphQL::Types::Canvas::
|
13
|
+
argument :grading_scheme, [LMSGraphQL::Types::Canvas::CanvasGradingSchemeEntryInput], "A list of GradingSchemeEntry that make up the Grading Standard as an array of values with the scheme name and value.Example: {'name'=>'A', 'value'=>0.9}, {'name'=>'B', 'value'=>0.8}, {'name'=>'C', 'value'=>0.7}, {'name'=>'D', 'value'=>0.6}", required: false
|
14
14
|
|
15
15
|
end
|
16
16
|
end
|
@@ -25,7 +25,7 @@ module LMSGraphQL
|
|
25
25
|
argument :group_limit, Int, "If self-signup is enabled, group_limit can be set to cap the number of users in each group. If null, there is no limit..", required: false
|
26
26
|
argument :sis_group_category_id, ID, "The SIS identifier for the group category. This field is only included if the user has permission to manage or view SIS information..", required: false
|
27
27
|
argument :sis_import_id, ID, "The unique identifier for the SIS import. This field is only included if the user has permission to manage SIS information..", required: false
|
28
|
-
argument :progress, LMSGraphQL::Types::Canvas::
|
28
|
+
argument :progress, LMSGraphQL::Types::Canvas::CanvasProgressInput, "If the group category has not yet finished a randomly student assignment request, a progress object will be attached, which will contain information related to the progress of the assignment request. Refer to the Progress API for more information.", required: false
|
29
29
|
|
30
30
|
end
|
31
31
|
end
|
@@ -9,8 +9,8 @@ module LMSGraphQL
|
|
9
9
|
description "Accounts. API Docs: https://canvas.instructure.com/doc/api/accounts.html"
|
10
10
|
argument :help_link_name, String, "Help link button title.Example: Help And Policies", required: false
|
11
11
|
argument :help_link_icon, String, "Help link button icon.Example: help", required: false
|
12
|
-
argument :custom_help_links, [LMSGraphQL::Types::Canvas::
|
13
|
-
argument :default_help_links, [LMSGraphQL::Types::Canvas::
|
12
|
+
argument :custom_help_links, [LMSGraphQL::Types::Canvas::CanvasHelpLinkInput], "Help links defined by the account. Could include default help links..Example: {'id'=>'link1', 'text'=>'Custom Link!', 'subtext'=>'Something something.', 'url'=>'https://google.com', 'type'=>'custom', 'available_to'=>['user', 'student', 'teacher', 'admin', 'observer', 'unenrolled']}", required: false
|
13
|
+
argument :default_help_links, [LMSGraphQL::Types::Canvas::CanvasHelpLinkInput], "Default help links provided when account has not set help links of their own..Example: {'available_to'=>['student'], 'text'=>'Ask Your Instructor a Question', 'subtext'=>'Questions are submitted to your instructor', 'url'=>'#teacher_feedback', 'type'=>'default', 'id'=>'instructor_question'}, {'available_to'=>['user', 'student', 'teacher', 'admin', 'observer', 'unenrolled'], 'text'=>'Search the Canvas Guides', 'subtext'=>'Find answers to common questions', 'url'=>'http://community.canvaslms.com/community/answers/guides', 'type'=>'default', 'id'=>'search_the_canvas_guides'}, {'available_to'=>['user', 'student', 'teacher', 'admin', 'observer', 'unenrolled'], 'text'=>'Report a Problem', 'subtext'=>'If Canvas misbehaves, tell us about it', 'url'=>'#create_ticket', 'type'=>'default', 'id'=>'report_a_problem'}", required: false
|
14
14
|
|
15
15
|
end
|
16
16
|
end
|
@@ -26,7 +26,7 @@ module LMSGraphQL
|
|
26
26
|
argument :prerequisite_module_ids, [ID], "IDs of Modules that must be completed before this one is unlocked.Example: 121, 122", required: false
|
27
27
|
argument :items_count, Int, "The number of items in the module.Example: 10", required: false
|
28
28
|
argument :items_url, String, "The API URL to retrive this module's items.Example: https://canvas.example.com/api/v1/modules/123/items", required: false
|
29
|
-
argument :items, [LMSGraphQL::Types::Canvas::
|
29
|
+
argument :items, [LMSGraphQL::Types::Canvas::CanvasModuleItemInput], "The contents of this module, as an array of Module Items. (Present only if requested via include[]=items AND the module is not deemed too large by Canvas.).", required: false
|
30
30
|
argument :state, ModuleStateEnum, "The state of this Module for the calling user one of 'locked', 'unlocked', 'started', 'completed' (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).Example: started", required: false
|
31
31
|
argument :completed_at, LMSGraphQL::Types::DateTimeType, "the date the calling user completed the module (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).", required: false
|
32
32
|
argument :publish_final_grade, Boolean, "if the student's final grade for the course should be published to the SIS upon completion of this module.", required: false
|
@@ -29,8 +29,8 @@ module LMSGraphQL
|
|
29
29
|
argument :page_url, String, "(only for 'Page' type) unique locator for the linked wiki page.Example: my-page-title", required: false
|
30
30
|
argument :external_url, String, "(only for 'ExternalUrl' and 'ExternalTool' types) external url that the item points to.Example: https://www.example.com/externalurl", required: false
|
31
31
|
argument :new_tab, Boolean, "(only for 'ExternalTool' type) whether the external tool opens in a new tab.", required: false
|
32
|
-
argument :completion_requirement, LMSGraphQL::Types::Canvas::
|
33
|
-
argument :content_details, LMSGraphQL::Types::Canvas::
|
32
|
+
argument :completion_requirement, LMSGraphQL::Types::Canvas::CanvasCompletionRequirementInput, "Completion requirement for this module item.Example: min_score, 10, true", required: false
|
33
|
+
argument :content_details, LMSGraphQL::Types::Canvas::CanvasContentDetailInput, "(Present only if requested through include[]=content_details) If applicable, returns additional details specific to the associated object.Example: 20, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00", required: false
|
34
34
|
argument :published, Boolean, "(Optional) Whether this module item is published. This field is present only if the caller has permission to view unpublished items..Example: true", required: false
|
35
35
|
|
36
36
|
end
|