lms-graphql-api 0.5.0 → 0.5.1
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/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_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/assignment_group_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/assignment_input.rb +9 -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_input.rb +2 -2
- 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/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/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_datum_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/sis_import_input.rb +3 -3
- 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 +1 -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/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eace2d51c1bf0e47c09926efba1c092c7e1c09c707a4a640857a4645bbe74da7
|
|
4
|
+
data.tar.gz: '07692b09094d1f26f14fb8f1a18997e9357f3ee15aff80f1e7c7f7bc4af1d278'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 05c9f3d029845e46e4a326be849dcde7d7aa3b2ef17aeddd68ebdcabd76e2e44db8072b2039a944a25ab247adcacb49bbc55cbfa4bf7b81ad77d9dc19ac1177e
|
|
7
|
+
data.tar.gz: 1611cba7a0a507a2141a16da891b50bdcbe8494e2707919b83f75e1ced60ff40036a211b086e3019139035dcef554f4665e475b36f33b85418cad02a946db117
|
|
@@ -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
|
|
@@ -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
|
|
@@ -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,20 +78,20 @@ 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
97
|
|
|
@@ -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
|
|
@@ -38,14 +38,14 @@ module LMSGraphQL
|
|
|
38
38
|
argument :start_at, LMSGraphQL::Types::DateTimeType, "the start date for the course, if applicable.Example: 2012-06-01T00:00:00-06:00", required: false
|
|
39
39
|
argument :end_at, LMSGraphQL::Types::DateTimeType, "the end date for the course, if applicable.Example: 2012-09-01T00:00:00-06:00", required: false
|
|
40
40
|
argument :locale, String, "the course-set locale, if applicable.Example: en", required: false
|
|
41
|
-
argument :enrollments, [LMSGraphQL::Types::Canvas::
|
|
41
|
+
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
|
|
42
42
|
argument :total_students, Int, "optional: the total number of active and invited students in the course.Example: 32", required: false
|
|
43
|
-
argument :calendar, LMSGraphQL::Types::Canvas::
|
|
43
|
+
argument :calendar, LMSGraphQL::Types::Canvas::CanvasCalendarLinkInput, "course calendar.", required: false
|
|
44
44
|
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
|
|
45
45
|
argument :syllabus_body, String, "optional: user-generated HTML for the course syllabus.Example: <p>syllabus html goes here</p>", required: false
|
|
46
46
|
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
|
|
47
|
-
argument :term, LMSGraphQL::Types::Canvas::
|
|
48
|
-
argument :course_progress, LMSGraphQL::Types::Canvas::
|
|
47
|
+
argument :term, LMSGraphQL::Types::Canvas::CanvasTermInput, "optional: the enrollment term object for the course returned only if include[]=term.", required: false
|
|
48
|
+
argument :course_progress, LMSGraphQL::Types::Canvas::CanvasCourseProgressInput, "optional (beta): information on progress through the course returned only if include[]=course_progress.", required: false
|
|
49
49
|
argument :apply_assignment_group_weights, Boolean, "weight final grade based on assignment group percentages.Example: true", required: false
|
|
50
50
|
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
|
|
51
51
|
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
|
|
@@ -33,8 +33,8 @@ 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::
|
|
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
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
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
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
|
|
@@ -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
|
|
@@ -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
|
|
@@ -7,8 +7,8 @@ module LMSGraphQL
|
|
|
7
7
|
module Canvas
|
|
8
8
|
class CanvasModuleItemSequenceInput < BaseInputObject
|
|
9
9
|
description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
|
|
10
|
-
argument :items, [LMSGraphQL::Types::Canvas::
|
|
11
|
-
argument :modules, [LMSGraphQL::Types::Canvas::
|
|
10
|
+
argument :items, [LMSGraphQL::Types::Canvas::CanvasModuleItemSequenceNodeInput], "an array containing one ModuleItemSequenceNode for each appearence of the asset in the module sequence (up to 10 total).Example: {'prev'=>nil, 'current'=>{'id'=>768, 'module_id'=>123, 'title'=>'A lonely page', 'type'=>'Page'}, 'next'=>{'id'=>769, 'module_id'=>127, 'title'=>'Project 1', 'type'=>'Assignment'}, 'mastery_path'=>{'locked'=>true, 'assignment_sets'=>[], 'selected_set_id'=>nil, 'awaiting_choice'=>false, 'still_processing'=>false, 'modules_url'=>'/courses/11/modules', 'choose_url'=>'/courses/11/modules/items/9/choose', 'modules_tab_disabled'=>false}}", required: false
|
|
11
|
+
argument :modules, [LMSGraphQL::Types::Canvas::CanvasModuleInput], "an array containing each Module referenced above.Example: {'id'=>123, 'name'=>'Overview'}, {'id'=>127, 'name'=>'Imaginary Numbers'}", required: false
|
|
12
12
|
|
|
13
13
|
end
|
|
14
14
|
end
|
|
@@ -8,9 +8,9 @@ module LMSGraphQL
|
|
|
8
8
|
module Canvas
|
|
9
9
|
class CanvasModuleItemSequenceNodeInput < BaseInputObject
|
|
10
10
|
description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
|
|
11
|
-
argument :prev, LMSGraphQL::Types::Canvas::
|
|
12
|
-
argument :current, LMSGraphQL::Types::Canvas::
|
|
13
|
-
argument :next, LMSGraphQL::Types::Canvas::
|
|
11
|
+
argument :prev, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The previous ModuleItem in the sequence.", required: false
|
|
12
|
+
argument :current, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The ModuleItem being queried.Example: 768, 123, A lonely page, Page", required: false
|
|
13
|
+
argument :next, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The next ModuleItem in the sequence.Example: 769, 127, Project 1, Assignment", required: false
|
|
14
14
|
argument :mastery_path, String, "The conditional release rule for the module item, if applicable.Example: true, , , false, false, /courses/11/modules, /courses/11/modules/items/9/choose, false", required: false
|
|
15
15
|
|
|
16
16
|
end
|
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
|
8
8
|
description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
|
|
9
9
|
argument :id, ID, "the ID of the outcome group.Example: 1", required: false
|
|
10
10
|
argument :url, String, "the URL for fetching/updating the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1", required: false
|
|
11
|
-
argument :parent_outcome_group, LMSGraphQL::Types::Canvas::
|
|
11
|
+
argument :parent_outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroupInput, "an abbreviated OutcomeGroup object representing the parent group of this outcome group, if any. omitted in the abbreviated form..", required: false
|
|
12
12
|
argument :context_id, ID, "the context owning the outcome group. may be null for global outcome groups. omitted in the abbreviated form..Example: 1", required: false
|
|
13
13
|
argument :context_type, String, "Example: Account", required: false
|
|
14
14
|
argument :title, String, "title of the outcome group.Example: Outcome group title", required: false
|
|
@@ -22,9 +22,9 @@ module LMSGraphQL
|
|
|
22
22
|
- 'importing': The outcome import is currently processing.
|
|
23
23
|
- 'succeeded': The outcome import has completed successfully.
|
|
24
24
|
- 'failed': The outcome import failed..Example: imported", required: false
|
|
25
|
-
argument :data, LMSGraphQL::Types::Canvas::
|
|
25
|
+
argument :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatumInput, "See the OutcomeImportData specification above..", required: false
|
|
26
26
|
argument :progress, String, "The progress of the outcome import..Example: 100", required: false
|
|
27
|
-
argument :user, LMSGraphQL::Types::Canvas::
|
|
27
|
+
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the outcome_import. See the Users API for details..", required: false
|
|
28
28
|
argument :processing_errors, String, "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", required: false
|
|
29
29
|
|
|
30
30
|
end
|
|
@@ -24,7 +24,7 @@ module LMSGraphQL
|
|
|
24
24
|
argument :mastery_points, Int, "points necessary to demonstrate mastery outcomes. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 3", required: false
|
|
25
25
|
argument :calculation_method, OutcomeCalculationMethodEnum, "the method used to calculate a students score.Example: decaying_average", required: false
|
|
26
26
|
argument :calculation_int, Int, "this defines the variable value used by the calculation_method. included only if calculation_method uses it.Example: 75", required: false
|
|
27
|
-
argument :ratings, [LMSGraphQL::Types::Canvas::
|
|
27
|
+
argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRatingInput], "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..", required: false
|
|
28
28
|
argument :can_edit, Boolean, "whether the current user can update the outcome.Example: true", required: false
|
|
29
29
|
argument :can_unlink, Boolean, "whether the outcome can be unlinked.Example: true", required: false
|
|
30
30
|
argument :assessed, Boolean, "whether this outcome has been used to assess a student.Example: true", required: false
|
|
@@ -10,8 +10,8 @@ module LMSGraphQL
|
|
|
10
10
|
argument :url, String, "the URL for fetching/updating the outcome link. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes/1", required: false
|
|
11
11
|
argument :context_id, ID, "the context owning the outcome link. will match the context owning the outcome group containing the outcome link; included for convenience. may be null for links in global outcome groups..Example: 1", required: false
|
|
12
12
|
argument :context_type, String, "Example: Account", required: false
|
|
13
|
-
argument :outcome_group, LMSGraphQL::Types::Canvas::
|
|
14
|
-
argument :outcome, LMSGraphQL::Types::Canvas::
|
|
13
|
+
argument :outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroupInput, "an abbreviated OutcomeGroup object representing the group containing the outcome link..", required: false
|
|
14
|
+
argument :outcome, LMSGraphQL::Types::Canvas::CanvasOutcomeInput, "an abbreviated Outcome object representing the outcome linked into the containing outcome group..", required: false
|
|
15
15
|
argument :assessed, Boolean, "whether this outcome has been used to assess a student in the context of this outcome link. In other words, this will be set to true if the context is a course, and a student has been assessed with this outcome in that course..Example: true", required: false
|
|
16
16
|
argument :can_unlink, Boolean, "whether this outcome link is manageable and is not the last link to an aligned outcome.", required: false
|
|
17
17
|
|
|
@@ -7,7 +7,7 @@ module LMSGraphQL
|
|
|
7
7
|
class CanvasOutcomePathInput < BaseInputObject
|
|
8
8
|
description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
|
|
9
9
|
argument :id, ID, "A unique identifier for this outcome.Example: 42", required: false
|
|
10
|
-
argument :parts, LMSGraphQL::Types::Canvas::
|
|
10
|
+
argument :parts, LMSGraphQL::Types::Canvas::CanvasOutcomePathPartInput, "an array of OutcomePathPart objects.", required: false
|
|
11
11
|
|
|
12
12
|
end
|
|
13
13
|
end
|
|
@@ -7,9 +7,9 @@ module LMSGraphQL
|
|
|
7
7
|
module Canvas
|
|
8
8
|
class CanvasOutcomeRollupInput < BaseInputObject
|
|
9
9
|
description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
|
|
10
|
-
argument :scores, LMSGraphQL::Types::Canvas::
|
|
10
|
+
argument :scores, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScoreInput, "an array of OutcomeRollupScore objects.", required: false
|
|
11
11
|
argument :name, String, "The name of the resource for this rollup. For example, the user name..Example: John Doe", required: false
|
|
12
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
|
12
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupLinkInput, "Example: 42, 42, 57", required: false
|
|
13
13
|
|
|
14
14
|
end
|
|
15
15
|
end
|
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
|
8
8
|
description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
|
|
9
9
|
argument :score, Int, "The rollup score for the outcome, based on the student alignment scores related to the outcome. This could be null if the student has no related scores..Example: 3", required: false
|
|
10
10
|
argument :count, Int, "The number of alignment scores included in this rollup..Example: 6", required: false
|
|
11
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
|
11
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScoreLinkInput, "Example: 42", required: false
|
|
12
12
|
|
|
13
13
|
end
|
|
14
14
|
end
|
|
@@ -13,12 +13,12 @@ module LMSGraphQL
|
|
|
13
13
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "the date the page was last updated.Example: 2012-08-08T14:25:20-06:00", required: false
|
|
14
14
|
argument :hide_from_students, Boolean, "(DEPRECATED) whether this page is hidden from students (note: this is always reflected as the inverse of the published value).", required: false
|
|
15
15
|
argument :editing_roles, String, "roles allowed to edit the page; comma-separated list comprising a combination of 'teachers', 'students', 'members', and/or 'public' if not supplied, course defaults are used.Example: teachers,students", required: false
|
|
16
|
-
argument :last_edited_by, LMSGraphQL::Types::Canvas::
|
|
16
|
+
argument :last_edited_by, LMSGraphQL::Types::Canvas::CanvasUserInput, "the User who last edited the page (this may not be present if the page was imported from another system).", required: false
|
|
17
17
|
argument :body, String, "the page content, in HTML (present when requesting a single page; omitted when listing pages).Example: <p>Page Content</p>", required: false
|
|
18
18
|
argument :published, Boolean, "whether the page is published (true) or draft state (false)..Example: true", required: false
|
|
19
19
|
argument :front_page, Boolean, "whether this page is the front page for the wiki.", required: false
|
|
20
20
|
argument :locked_for_user, Boolean, "Whether or not this is locked for the user..", required: false
|
|
21
|
-
argument :lock_info, LMSGraphQL::Types::Canvas::
|
|
21
|
+
argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
|
|
22
22
|
argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This page is locked until September 1 at 12:00am", required: false
|
|
23
23
|
|
|
24
24
|
end
|
|
@@ -9,7 +9,7 @@ module LMSGraphQL
|
|
|
9
9
|
argument :revision_id, ID, "an identifier for this revision of the page.Example: 7", required: false
|
|
10
10
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "the time when this revision was saved.Example: 2012-08-07T11:23:58-06:00", required: false
|
|
11
11
|
argument :latest, Boolean, "whether this is the latest revision or not.Example: true", required: false
|
|
12
|
-
argument :edited_by, LMSGraphQL::Types::Canvas::
|
|
12
|
+
argument :edited_by, LMSGraphQL::Types::Canvas::CanvasUserInput, "the User who saved this revision, if applicable (this may not be present if the page was imported from another system).", required: false
|
|
13
13
|
argument :url, String, "the following fields are not included in the index action and may be omitted from the show action via summary=1 the historic url of the page.Example: old-page-title", required: false
|
|
14
14
|
argument :title, String, "the historic page title.Example: Old Page Title", required: false
|
|
15
15
|
argument :body, String, "the historic page contents.Example: <p>Old Page Content</p>", required: false
|
|
@@ -22,7 +22,7 @@ module LMSGraphQL
|
|
|
22
22
|
argument :participated, Boolean, "True if the request counted as participating, such as submitting homework.Example: false", required: false
|
|
23
23
|
argument :http_method, String, "The HTTP method such as GET or POST.Example: GET", required: false
|
|
24
24
|
argument :remote_ip, String, "The origin IP address of the request.Example: 173.194.46.71", required: false
|
|
25
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
|
25
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasPageViewLinkInput, "The page view links to define the relationships.Example: 1234, 1234", required: false
|
|
26
26
|
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -14,7 +14,7 @@ module LMSGraphQL
|
|
|
14
14
|
argument :has_public_results, Boolean, "Specifies whether the results are viewable by students..Example: true", required: false
|
|
15
15
|
argument :created_at, String, "The time at which the poll session was created..Example: 2014-01-07T15:16:18Z", required: false
|
|
16
16
|
argument :results, String, "The results of the submissions of the poll. Each key is the poll choice id, and the value is the count of submissions..Example: 10, 3, 27, 8", required: false
|
|
17
|
-
argument :poll_submissions, LMSGraphQL::Types::Canvas::
|
|
17
|
+
argument :poll_submissions, LMSGraphQL::Types::Canvas::CanvasPollSubmissionInput, "If the poll session has public results, this will return an array of all submissions, viewable by both students and teachers. If the results are not public, for students it will return their submission only..", required: false
|
|
18
18
|
|
|
19
19
|
end
|
|
20
20
|
end
|
|
@@ -17,7 +17,7 @@ module LMSGraphQL
|
|
|
17
17
|
argument :sis_user_id, ID, "sis1.Example: sis1", required: false
|
|
18
18
|
argument :lti_user_id, ID, "", required: false
|
|
19
19
|
argument :avatar_url, String, "The avatar_url can change over time, so we recommend not caching it for more than a few hours.Example: url", required: false
|
|
20
|
-
argument :calendar, LMSGraphQL::Types::Canvas::
|
|
20
|
+
argument :calendar, LMSGraphQL::Types::Canvas::CanvasCalendarLinkInput, "", required: false
|
|
21
21
|
argument :time_zone, String, "Optional: This field is only returned in certain API calls, and will return the IANA time zone name of the user's preferred timezone..Example: America/Denver", required: false
|
|
22
22
|
argument :locale, String, "The users locale..", required: false
|
|
23
23
|
|
|
@@ -6,7 +6,7 @@ module LMSGraphQL
|
|
|
6
6
|
module Canvas
|
|
7
7
|
class CanvasQuizAssignmentOverrideSetContainerInput < BaseInputObject
|
|
8
8
|
description "Quiz Assignment Overrides. API Docs: https://canvas.instructure.com/doc/api/quiz_assignment_overrides.html"
|
|
9
|
-
argument :quiz_assignment_overrides, [LMSGraphQL::Types::Canvas::
|
|
9
|
+
argument :quiz_assignment_overrides, [LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideSetInput], "The QuizAssignmentOverrideSet.", required: false
|
|
10
10
|
|
|
11
11
|
end
|
|
12
12
|
end
|
|
@@ -8,8 +8,8 @@ module LMSGraphQL
|
|
|
8
8
|
class CanvasQuizAssignmentOverrideSetInput < BaseInputObject
|
|
9
9
|
description "Quiz Assignment Overrides. API Docs: https://canvas.instructure.com/doc/api/quiz_assignment_overrides.html"
|
|
10
10
|
argument :quiz_id, ID, "ID of the quiz those dates are for..Example: 1", required: false
|
|
11
|
-
argument :due_dates, LMSGraphQL::Types::Canvas::
|
|
12
|
-
argument :all_dates, LMSGraphQL::Types::Canvas::
|
|
11
|
+
argument :due_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideInput, "An array of quiz assignment overrides. For students, this array will always contain a single item which is the set of dates that apply to that student. For teachers and staff, it may contain more..", required: false
|
|
12
|
+
argument :all_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideInput, "An array of all assignment overrides active for the quiz. This is visible only to teachers and staff..", required: false
|
|
13
13
|
|
|
14
14
|
end
|
|
15
15
|
end
|
|
@@ -54,12 +54,12 @@ module LMSGraphQL
|
|
|
54
54
|
argument :published, Boolean, "whether the quiz has a published or unpublished draft state..Example: true", required: false
|
|
55
55
|
argument :unpublishable, Boolean, "Whether the assignment's 'published' state can be changed to false. Will be false if there are student submissions for the quiz..Example: true", required: false
|
|
56
56
|
argument :locked_for_user, Boolean, "Whether or not this is locked for the user..", required: false
|
|
57
|
-
argument :lock_info, LMSGraphQL::Types::Canvas::
|
|
57
|
+
argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
|
|
58
58
|
argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This quiz is locked until September 1 at 12:00am", required: false
|
|
59
59
|
argument :speedgrader_url, String, "Link to Speed Grader for this quiz. Will not be present if quiz is unpublished.Example: http://canvas.instructure.com/courses/1/speed_grader?assignment_id=1", required: false
|
|
60
60
|
argument :quiz_extensions_url, String, "Link to endpoint to send extensions for this quiz..Example: http://canvas.instructure.com/courses/1/quizzes/2/quiz_extensions", required: false
|
|
61
|
-
argument :permissions, LMSGraphQL::Types::Canvas::
|
|
62
|
-
argument :all_dates, [LMSGraphQL::Types::Canvas::
|
|
61
|
+
argument :permissions, LMSGraphQL::Types::Canvas::CanvasQuizPermissionInput, "Permissions the user has for the quiz.", required: false
|
|
62
|
+
argument :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDateInput], "list of due dates for the quiz.", required: false
|
|
63
63
|
argument :version_number, Int, "Current version number of the quiz.Example: 3", required: false
|
|
64
64
|
argument :question_types, String, "List of question types in the quiz.Example: multiple_choice, essay", required: false
|
|
65
65
|
argument :anonymous_submissions, Boolean, "Whether survey submissions will be kept anonymous (only applicable to 'graded_survey', 'survey' quiz types).", required: false
|
|
@@ -16,7 +16,7 @@ module LMSGraphQL
|
|
|
16
16
|
argument :correct_comments, String, "The comments to display if the student answers the question correctly..Example: That's correct!", required: false
|
|
17
17
|
argument :incorrect_comments, String, "The comments to display if the student answers incorrectly..Example: Unfortunately, that IS a prime number.", required: false
|
|
18
18
|
argument :neutral_comments, String, "The comments to display regardless of how the student answered..Example: Goldbach's conjecture proposes that every even integer greater than 2 can be expressed as the sum of two prime numbers.", required: false
|
|
19
|
-
argument :answers, [LMSGraphQL::Types::Canvas::
|
|
19
|
+
argument :answers, [LMSGraphQL::Types::Canvas::CanvasAnswerInput], "An array of available answers to display to the student..", required: false
|
|
20
20
|
|
|
21
21
|
end
|
|
22
22
|
end
|
|
@@ -21,9 +21,9 @@ module LMSGraphQL
|
|
|
21
21
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "when the report was created.Example: 2013-05-01T12:34:56-07:00", required: false
|
|
22
22
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "when the report was last updated.Example: 2013-05-01T12:34:56-07:00", required: false
|
|
23
23
|
argument :url, String, "the API endpoint for this report.Example: http://canvas.example.com/api/v1/courses/1/quizzes/1/reports/1", required: false
|
|
24
|
-
argument :file, LMSGraphQL::Types::Canvas::
|
|
24
|
+
argument :file, LMSGraphQL::Types::Canvas::CanvasFileInput, "if the report has finished generating, a File object that represents it. refer to the Files API for more information about the format.", required: false
|
|
25
25
|
argument :progress_url, String, "if the report has not yet finished generating, a URL where information about its progress can be retrieved. refer to the Progress API for more information (Note: not available in JSON-API format).", required: false
|
|
26
|
-
argument :progress, LMSGraphQL::Types::Canvas::
|
|
26
|
+
argument :progress, LMSGraphQL::Types::Canvas::CanvasProgressInput, "if the report is being generated, a Progress object that represents the operation. Refer to the Progress API for more information about the format. (Note: available only in JSON-API format).", required: false
|
|
27
27
|
|
|
28
28
|
end
|
|
29
29
|
end
|
|
@@ -16,9 +16,9 @@ NOTE: AVAILABLE ONLY IN NON-JSON-API REQUESTS..Example: 2", required: false
|
|
|
16
16
|
argument :generated_at, LMSGraphQL::Types::DateTimeType, "The time at which the statistics were generated, which is usually after the occurrence of a quiz event, like a student submitting it..Example: 2013-01-23T23:59:00-07:00", required: false
|
|
17
17
|
argument :url, String, "The API HTTP/HTTPS URL to this quiz statistics..Example: http://canvas.example.edu/api/v1/courses/1/quizzes/2/statistics", required: false
|
|
18
18
|
argument :html_url, String, "The HTTP/HTTPS URL to the page where the statistics can be seen visually..Example: http://canvas.example.edu/courses/1/quizzes/2/statistics", required: false
|
|
19
|
-
argument :question_statistics, LMSGraphQL::Types::Canvas::
|
|
20
|
-
argument :submission_statistics, LMSGraphQL::Types::Canvas::
|
|
21
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
|
19
|
+
argument :question_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsQuestionStatisticInput, "Question-specific statistics for each question and its answers..", required: false
|
|
20
|
+
argument :submission_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsSubmissionStatisticInput, "Question-specific statistics for each question and its answers..", required: false
|
|
21
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsLinkInput, "JSON-API construct that contains links to media related to this quiz statistics object.
|
|
22
22
|
NOTE: AVAILABLE ONLY IN JSON-API REQUESTS..", required: false
|
|
23
23
|
|
|
24
24
|
end
|
|
@@ -7,7 +7,7 @@ module LMSGraphQL
|
|
|
7
7
|
class CanvasQuizStatisticsQuestionStatisticInput < BaseInputObject
|
|
8
8
|
description "Quiz Statistics. API Docs: https://canvas.instructure.com/doc/api/quiz_statistics.html"
|
|
9
9
|
argument :responses, Int, "Number of students who have provided an answer to this question. Blank or empty responses are not counted..Example: 3", required: false
|
|
10
|
-
argument :answers, LMSGraphQL::Types::Canvas::
|
|
10
|
+
argument :answers, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsAnswerStatisticInput, "Statistics related to each individual pre-defined answer..", required: false
|
|
11
11
|
|
|
12
12
|
end
|
|
13
13
|
end
|
|
@@ -10,12 +10,12 @@ module LMSGraphQL
|
|
|
10
10
|
argument :id, ID, "The unique identifier for the report..Example: 1", required: false
|
|
11
11
|
argument :report, String, "The type of report..Example: sis_export_csv", required: false
|
|
12
12
|
argument :file_url, String, "The url to the report download..Example: https://example.com/some/path", required: false
|
|
13
|
-
argument :attachment, LMSGraphQL::Types::Canvas::
|
|
13
|
+
argument :attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "The attachment api object of the report. Only available after the report has completed..", required: false
|
|
14
14
|
argument :status, String, "The status of the report.Example: complete", required: false
|
|
15
15
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "The date and time the report was created..Example: 2013-12-01T23:59:00-06:00", required: false
|
|
16
16
|
argument :started_at, LMSGraphQL::Types::DateTimeType, "The date and time the report started processing..Example: 2013-12-02T00:03:21-06:00", required: false
|
|
17
17
|
argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date and time the report finished processing..Example: 2013-12-02T00:03:21-06:00", required: false
|
|
18
|
-
argument :parameters, LMSGraphQL::Types::Canvas::
|
|
18
|
+
argument :parameters, LMSGraphQL::Types::Canvas::CanvasReportParameterInput, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", required: false
|
|
19
19
|
argument :progress, Int, "The progress of the report.Example: 100", required: false
|
|
20
20
|
argument :current_line, Int, "This is the current line count being written to the report. It updates every 1000 records..Example: 12000", required: false
|
|
21
21
|
|
|
@@ -9,7 +9,7 @@ module LMSGraphQL
|
|
|
9
9
|
argument :id, ID, "A unique identifier for this result.Example: 42", required: false
|
|
10
10
|
argument :passed, Boolean, "Whether the user passed or not.Example: true", required: false
|
|
11
11
|
argument :assessed_at, LMSGraphQL::Types::DateTimeType, "When this result was recorded.Example: 2014-05-13T00:01:57-06:00", required: false
|
|
12
|
-
argument :links, LMSGraphQL::Types::Canvas::
|
|
12
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasResultLinkInput, "Unique identifiers of objects associated with this result.Example: 42, 23, 5", required: false
|
|
13
13
|
|
|
14
14
|
end
|
|
15
15
|
end
|
|
@@ -9,7 +9,7 @@ module LMSGraphQL
|
|
|
9
9
|
argument :label, String, "The label of the role..Example: New Role", required: false
|
|
10
10
|
argument :role, String, "The label of the role. (Deprecated alias for 'label').Example: New Role", required: false
|
|
11
11
|
argument :base_role_type, String, "The role type that is being used as a base for this role. For account-level roles, this is 'AccountMembership'. For course-level roles, it is an enrollment type..Example: AccountMembership", required: false
|
|
12
|
-
argument :account, LMSGraphQL::Types::Canvas::
|
|
12
|
+
argument :account, LMSGraphQL::Types::Canvas::CanvasAccountInput, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", required: false
|
|
13
13
|
argument :workflow_state, String, "The state of the role: 'active', 'inactive', or 'built_in'.Example: active", required: false
|
|
14
14
|
argument :permissions, String, "A dictionary of permissions keyed by name (see permissions input parameter in the 'Create a role' API)..Example: {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>true, 'readonly'=>true, 'explicit'=>false}, {'enabled'=>false, 'locked'=>true, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>false}", required: false
|
|
15
15
|
|
|
@@ -13,7 +13,7 @@ module LMSGraphQL
|
|
|
13
13
|
argument :description, String, "Example: Criterion 1", required: false
|
|
14
14
|
argument :long_description, String, "Example: Criterion 1 more details", required: false
|
|
15
15
|
argument :criterion_use_range, Boolean, "Example: true", required: false
|
|
16
|
-
argument :ratings, [LMSGraphQL::Types::Canvas::
|
|
16
|
+
argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRatingInput], "", required: false
|
|
17
17
|
|
|
18
18
|
end
|
|
19
19
|
end
|
|
@@ -15,7 +15,7 @@ module LMSGraphQL
|
|
|
15
15
|
argument :read_only, Boolean, "Example: true", required: false
|
|
16
16
|
argument :free_form_criterion_comments, Boolean, "whether or not free-form comments are used.Example: true", required: false
|
|
17
17
|
argument :hide_score_total, Boolean, "Example: true", required: false
|
|
18
|
-
argument :assessments, [LMSGraphQL::Types::Canvas::
|
|
18
|
+
argument :assessments, [LMSGraphQL::Types::Canvas::CanvasRubricAssessmentInput], "If an assessment type is included in the 'include' parameter, includes an array of rubric assessment objects for a given rubric, based on the assessment type requested. If the user does not request an assessment type this key will be absent..", required: false
|
|
19
19
|
|
|
20
20
|
end
|
|
21
21
|
end
|
|
@@ -12,9 +12,9 @@ module LMSGraphQL
|
|
|
12
12
|
argument :name, String, "The name of the section..Example: Section A", required: false
|
|
13
13
|
argument :sis_id, ID, "The sis id of the section..Example: s34643", required: false
|
|
14
14
|
argument :integration_id, ID, "Optional: The integration ID of the section..Example: 3452342345", required: false
|
|
15
|
-
argument :origin_course, LMSGraphQL::Types::Canvas::
|
|
16
|
-
argument :xlist_course, LMSGraphQL::Types::Canvas::
|
|
17
|
-
argument :override, LMSGraphQL::Types::Canvas::
|
|
15
|
+
argument :origin_course, LMSGraphQL::Types::Canvas::CanvasCourseAttributeInput, "The course to which the section belongs or the course from which the section was cross-listed.", required: false
|
|
16
|
+
argument :xlist_course, LMSGraphQL::Types::Canvas::CanvasCourseAttributeInput, "Optional: Attributes of the xlist course. Only present when the section has been cross-listed. See Courses API for more details.", required: false
|
|
17
|
+
argument :override, LMSGraphQL::Types::Canvas::CanvasSectionAssignmentOverrideAttributeInput, "Optional: Attributes of the assignment override that apply to the section. See Assignment API for more details.", required: false
|
|
18
18
|
|
|
19
19
|
end
|
|
20
20
|
end
|
|
@@ -32,9 +32,9 @@ module LMSGraphQL
|
|
|
32
32
|
argument :integration_id, ID, "Third Party integration id for assignment.Example: 12341234", required: false
|
|
33
33
|
argument :integration_data, String, "(optional, Third Party integration data for assignment).Example: other_data", required: false
|
|
34
34
|
argument :include_in_final_grade, Boolean, "If false, the assignment will be omitted from the student's final grade.Example: true", required: false
|
|
35
|
-
argument :assignment_group, [LMSGraphQL::Types::Canvas::
|
|
36
|
-
argument :sections, [LMSGraphQL::Types::Canvas::
|
|
37
|
-
argument :user_overrides, [LMSGraphQL::Types::Canvas::
|
|
35
|
+
argument :assignment_group, [LMSGraphQL::Types::Canvas::CanvasAssignmentGroupAttributeInput], "Includes attributes of a assignment_group for convenience. For more details see Assignments API..", required: false
|
|
36
|
+
argument :sections, [LMSGraphQL::Types::Canvas::CanvasSectionAttributeInput], "Includes attributes of a section for convenience. For more details see Sections API..", required: false
|
|
37
|
+
argument :user_overrides, [LMSGraphQL::Types::Canvas::CanvasUserAssignmentOverrideAttributeInput], "Includes attributes of a user assignment overrides. For more details see Assignments API..", required: false
|
|
38
38
|
|
|
39
39
|
end
|
|
40
40
|
end
|
|
@@ -8,7 +8,7 @@ module LMSGraphQL
|
|
|
8
8
|
description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
|
|
9
9
|
argument :import_type, String, "The type of SIS import.Example: instructure_csv", required: false
|
|
10
10
|
argument :supplied_batches, String, "Which files were included in the SIS import.Example: term, course, section, user, enrollment", required: false
|
|
11
|
-
argument :counts, LMSGraphQL::Types::Canvas::
|
|
11
|
+
argument :counts, LMSGraphQL::Types::Canvas::CanvasSisImportCountInput, "The number of rows processed for each type of import.", required: false
|
|
12
12
|
|
|
13
13
|
end
|
|
14
14
|
end
|
|
@@ -31,10 +31,10 @@ module LMSGraphQL
|
|
|
31
31
|
- 'aborted': The SIS import was aborted.
|
|
32
32
|
- 'failed_with_messages': The SIS import failed with errors.
|
|
33
33
|
- 'failed': The SIS import failed..Example: imported", required: false
|
|
34
|
-
argument :data, LMSGraphQL::Types::Canvas::
|
|
34
|
+
argument :data, LMSGraphQL::Types::Canvas::CanvasSisImportDatumInput, "data.", required: false
|
|
35
35
|
argument :progress, String, "The progress of the SIS import. The progress will reset when using batch_mode and have a different progress for the cleanup stage.Example: 100", required: false
|
|
36
|
-
argument :errors_attachment, LMSGraphQL::Types::Canvas::
|
|
37
|
-
argument :user, LMSGraphQL::Types::Canvas::
|
|
36
|
+
argument :errors_attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "The errors_attachment api object of the SIS import. Only available if there are errors or warning and import has completed..", required: false
|
|
37
|
+
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the sis_batch. See the Users API for details..", required: false
|
|
38
38
|
argument :processing_warnings, String, "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", required: false
|
|
39
39
|
argument :processing_errors, String, "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", required: false
|
|
40
40
|
argument :batch_mode, Boolean, "Whether the import was run in batch mode..Example: true", required: false
|
|
@@ -13,7 +13,7 @@ module LMSGraphQL
|
|
|
13
13
|
argument :comment, String, "Example: Well here's the thing.", required: false
|
|
14
14
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "Example: 2012-01-01T01:00:00Z", required: false
|
|
15
15
|
argument :edited_at, LMSGraphQL::Types::DateTimeType, "Example: 2012-01-02T01:00:00Z", required: false
|
|
16
|
-
argument :media_comment, LMSGraphQL::Types::Canvas::
|
|
16
|
+
argument :media_comment, LMSGraphQL::Types::Canvas::CanvasMediaCommentInput, "", required: false
|
|
17
17
|
|
|
18
18
|
end
|
|
19
19
|
end
|
|
@@ -7,7 +7,7 @@ module LMSGraphQL
|
|
|
7
7
|
class CanvasSubmissionHistoryInput < BaseInputObject
|
|
8
8
|
description "Gradebook History. API Docs: https://canvas.instructure.com/doc/api/gradebook_history.html"
|
|
9
9
|
argument :submission_id, ID, "the id of the submission.Example: 4", required: false
|
|
10
|
-
argument :versions, [LMSGraphQL::Types::Canvas::
|
|
10
|
+
argument :versions, [LMSGraphQL::Types::Canvas::CanvasSubmissionVersionInput], "an array of all the versions of this submission.", required: false
|
|
11
11
|
|
|
12
12
|
end
|
|
13
13
|
end
|
|
@@ -29,7 +29,7 @@ module LMSGraphQL
|
|
|
29
29
|
argument :html_url, String, "URL to the submission. This will require the user to log in..Example: http://example.com/courses/255/assignments/543/submissions/134", required: false
|
|
30
30
|
argument :preview_url, String, "URL to the submission preview. This will require the user to log in..Example: http://example.com/courses/255/assignments/543/submissions/134?preview=1", required: false
|
|
31
31
|
argument :score, Float, "The raw score.Example: 13.5", required: false
|
|
32
|
-
argument :submission_comments, [LMSGraphQL::Types::Canvas::
|
|
32
|
+
argument :submission_comments, [LMSGraphQL::Types::Canvas::CanvasSubmissionCommentInput], "Associated comments for a submission (optional).", required: false
|
|
33
33
|
argument :submission_type, SubmissionSubmissionTypeEnum, "The types of submission ex: ('online_text_entry'|'online_url'|'online_upload'|'media_recording').Example: online_text_entry", required: false
|
|
34
34
|
argument :submitted_at, LMSGraphQL::Types::DateTimeType, "The timestamp when the assignment was submitted.Example: 2012-01-01T01:00:00Z", required: false
|
|
35
35
|
argument :url, String, "The URL of the submission (for 'online_url' submissions)..", required: false
|
|
@@ -11,7 +11,7 @@ module LMSGraphQL
|
|
|
11
11
|
argument :due_at, LMSGraphQL::Types::DateTimeType, "The time at which this assignment is due.Example: 2013-01-01T00:00:00-06:00", required: false
|
|
12
12
|
argument :unlock_at, LMSGraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be unlocked..Example: 2013-01-01T00:00:00-06:00", required: false
|
|
13
13
|
argument :lock_at, LMSGraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be locked..Example: 2013-02-01T00:00:00-06:00", required: false
|
|
14
|
-
argument :students, [LMSGraphQL::Types::Canvas::
|
|
14
|
+
argument :students, [LMSGraphQL::Types::Canvas::CanvasStudentAttributeInput], "Includes attributes of a student for convenience. For more details see Users API..", required: false
|
|
15
15
|
|
|
16
16
|
end
|
|
17
17
|
end
|
|
@@ -15,7 +15,7 @@ module LMSGraphQL
|
|
|
15
15
|
argument :integration_id, ID, "The integration_id associated with the user. This field is only included if the user came from a SIS import and has permissions to view SIS information..Example: ABC59802", required: false
|
|
16
16
|
argument :login_id, ID, "The unique login id for the user. This is what the user uses to log in to Canvas..Example: sheldon@caltech.example.com", required: false
|
|
17
17
|
argument :avatar_url, String, "If avatars are enabled, this field will be included and contain a url to retrieve the user's avatar..Example: https://en.gravatar.com/avatar/d8cb8c8cd40ddf0cd05241443a591868?s=80&r=g", required: false
|
|
18
|
-
argument :enrollments, [LMSGraphQL::Types::Canvas::
|
|
18
|
+
argument :enrollments, [LMSGraphQL::Types::Canvas::CanvasEnrollmentInput], "Optional: This field can be requested with certain API calls, and will return a list of the users active enrollments. See the List enrollments API for more details about the format of these records..", required: false
|
|
19
19
|
argument :email, String, "Optional: This field can be requested with certain API calls, and will return the users primary email address..Example: sheldon@caltech.example.com", required: false
|
|
20
20
|
argument :locale, String, "Optional: This field can be requested with certain API calls, and will return the users locale in RFC 5646 format..Example: tlh", required: false
|
|
21
21
|
argument :last_login, String, "Optional: This field is only returned in certain API calls, and will return a timestamp representing the last time the user logged in to canvas..Example: 2012-05-30T17:45:25Z", required: false
|
data/lib/lms_graphql/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lms-graphql-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.5.
|
|
4
|
+
version: 0.5.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Atomic Jolt
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2018-06-
|
|
12
|
+
date: 2018-06-19 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: graphql
|