lms-graphql-api 0.5.3 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/lms_graphql/mutations/canvas/add_observee_with_credentials.rb +3 -1
- data/lib/lms_graphql/mutations/canvas/bulk_select_provisional_grades.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/bulk_update_column_data.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/create_single_rubric.rb +40 -0
- data/lib/lms_graphql/mutations/canvas/create_update_proficiency_ratings.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/get_pandata_events_jwt_token_and_its_expiration_date.rb +20 -0
- data/lib/lms_graphql/mutations/canvas/import_outcome_group_accounts.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/import_outcome_group_courses.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/import_outcome_group_global.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/mutations.rb +7 -1
- data/lib/lms_graphql/mutations/canvas/quiz_extensions_set_extensions_for_student_quiz_submissions.rb +13 -13
- data/lib/lms_graphql/mutations/canvas/restore_workflow_states_of_sis_imported_items.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/update_single_rubric.rb +42 -0
- data/lib/lms_graphql/mutations/canvas/update_student_question_scores_and_comments.rb +7 -7
- data/lib/lms_graphql/resolvers/canvas/courses_permissions.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_aligned_assignments_for_outcome_in_course_for_particular_student.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_current_importing_sis_import.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/get_help_links.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/get_outcome_result_rollups.rb +12 -2
- data/lib/lms_graphql/resolvers/canvas/get_outcome_results.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/get_proficiency_ratings.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/get_terms_of_service.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/groups_permissions.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/list_assignments_assignment_groups.rb +36 -0
- data/lib/lms_graphql/resolvers/canvas/list_assignments_assignments.rb +34 -0
- data/lib/lms_graphql/resolvers/canvas/list_blueprint_subscriptions.rb +20 -0
- data/lib/lms_graphql/resolvers/canvas/list_missing_submissions.rb +4 -2
- data/lib/lms_graphql/resolvers/canvas/list_planner_items.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/moderated_grading_show_provisional_grade_status_for_student.rb +24 -0
- data/lib/lms_graphql/resolvers/canvas/permissions.rb +3 -3
- data/lib/lms_graphql/types/canvas/admin_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/appointment_group_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/assignment_event_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/assignment_group_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/assignment_input.rb +18 -18
- data/lib/lms_graphql/types/canvas/authentication_provider_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/blueprint_subscription.rb +16 -0
- data/lib/lms_graphql/types/canvas/blueprint_subscription_input.rb +16 -0
- data/lib/lms_graphql/types/canvas/blueprint_template_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/conference_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_detail_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_export_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/conversation_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/course.rb +1 -0
- data/lib/lms_graphql/types/canvas/course_epub_export_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/course_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/course_input.rb +9 -8
- data/lib/lms_graphql/types/canvas/discussion_topic_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/enrollment_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/epub_export_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/feature_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/grade_change_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/grading_standard_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/group_category_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/help_link.rb +18 -0
- data/lib/lms_graphql/types/canvas/help_link_input.rb +18 -0
- data/lib/lms_graphql/types/canvas/lti_assignment.rb +2 -0
- data/lib/lms_graphql/types/canvas/lti_assignment_input.rb +2 -0
- data/lib/lms_graphql/types/canvas/module_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/module_item_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_item_sequence_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_item_sequence_node_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/originality_report_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/outcome.rb +1 -1
- data/lib/lms_graphql/types/canvas/outcome_alignment.rb +6 -4
- data/lib/lms_graphql/types/canvas/outcome_alignment_input.rb +6 -4
- data/lib/lms_graphql/types/canvas/outcome_group_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_import_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/outcome_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/outcome_link_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/outcome_path_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_rollup_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/outcome_rollup_score_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/page_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/page_revision_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/page_view_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/planner_note.rb +1 -1
- data/lib/lms_graphql/types/canvas/planner_note_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/planner_override.rb +2 -1
- data/lib/lms_graphql/types/canvas/planner_override_input.rb +2 -1
- data/lib/lms_graphql/types/canvas/poll_session_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/proficiency.rb +14 -0
- data/lib/lms_graphql/types/canvas/proficiency_input.rb +14 -0
- data/lib/lms_graphql/types/canvas/proficiency_rating.rb +17 -0
- data/lib/lms_graphql/types/canvas/proficiency_rating_input.rb +17 -0
- data/lib/lms_graphql/types/canvas/profile_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/query_type.rb +51 -19
- data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_container_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/quiz_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/quiz_question_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/quiz_report_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/quiz_statistic_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/quiz_statistics_question_statistic_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/report_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/result_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/role_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/rubric_criterium.rb +1 -0
- data/lib/lms_graphql/types/canvas/rubric_criterium_input.rb +3 -2
- data/lib/lms_graphql/types/canvas/rubric_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/scope.rb +4 -1
- data/lib/lms_graphql/types/canvas/scope_input.rb +4 -1
- data/lib/lms_graphql/types/canvas/section_attribute_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/sis_assignment_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/sis_import.rb +1 -0
- data/lib/lms_graphql/types/canvas/sis_import_datum_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/sis_import_input.rb +7 -6
- data/lib/lms_graphql/types/canvas/submission_comment_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/submission_history_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/submission_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/terms_of_service.rb +18 -0
- data/lib/lms_graphql/types/canvas/terms_of_service_input.rb +18 -0
- data/lib/lms_graphql/types/canvas/user_assignment_override_attribute_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/user_input.rb +2 -2
- data/lib/lms_graphql/types/canvas_forward_declarations.rb +5 -0
- data/lib/lms_graphql/version.rb +1 -1
- metadata +30 -2
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "quiz_assignment_override_set"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
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::CanvasQuizAssignmentOverrideSet], "The QuizAssignmentOverrideSet.", required: false
|
|
10
10
|
|
|
11
11
|
end
|
|
12
12
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
2
|
+
require_relative "quiz_assignment_override"
|
|
3
|
+
require_relative "quiz_assignment_override"
|
|
4
4
|
|
|
5
5
|
module LMSGraphQL
|
|
6
6
|
module Types
|
|
@@ -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::CanvasQuizAssignmentOverride, "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::CanvasQuizAssignmentOverride, "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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
2
|
+
require_relative "lock_info"
|
|
3
|
+
require_relative "quiz_permission"
|
|
4
|
+
require_relative "assignment_date"
|
|
5
5
|
|
|
6
6
|
module LMSGraphQL
|
|
7
7
|
module Types
|
|
@@ -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::CanvasLockInfo, "(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::CanvasQuizPermission, "Permissions the user has for the quiz.", required: false
|
|
62
|
+
argument :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDate], "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
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "answer"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasAnswer], "An array of available answers to display to the student..", required: false
|
|
20
20
|
|
|
21
21
|
end
|
|
22
22
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
2
|
+
require_relative "file"
|
|
3
|
+
require_relative "progress"
|
|
4
4
|
|
|
5
5
|
module LMSGraphQL
|
|
6
6
|
module Types
|
|
@@ -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::CanvasFile, "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::CanvasProgress, "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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
2
|
+
require_relative "quiz_statistics_question_statistic"
|
|
3
|
+
require_relative "quiz_statistics_submission_statistic"
|
|
4
|
+
require_relative "quiz_statistics_link"
|
|
5
5
|
|
|
6
6
|
module LMSGraphQL
|
|
7
7
|
module Types
|
|
@@ -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::CanvasQuizStatisticsQuestionStatistic, "Question-specific statistics for each question and its answers..", required: false
|
|
20
|
+
argument :submission_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsSubmissionStatistic, "Question-specific statistics for each question and its answers..", required: false
|
|
21
|
+
argument :links, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsLink, "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
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "quiz_statistics_answer_statistic"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasQuizStatisticsAnswerStatistic, "Statistics related to each individual pre-defined answer..", required: false
|
|
11
11
|
|
|
12
12
|
end
|
|
13
13
|
end
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
2
|
+
require_relative "file"
|
|
3
|
+
require_relative "report_parameter"
|
|
4
4
|
|
|
5
5
|
module LMSGraphQL
|
|
6
6
|
module Types
|
|
@@ -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::CanvasFile, "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::CanvasReportParameter, "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
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "result_link"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasResultLink, "Unique identifiers of objects associated with this result.Example: 42, 23, 5", required: false
|
|
13
13
|
|
|
14
14
|
end
|
|
15
15
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "account"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasAccount, "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
|
|
|
@@ -14,6 +14,7 @@ module LMSGraphQL
|
|
|
14
14
|
field :long_description, String, "Example: Criterion 1 more details", null: true
|
|
15
15
|
field :criterion_use_range, Boolean, "Example: true", null: true
|
|
16
16
|
field :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRating], "", null: true
|
|
17
|
+
field :ignore_for_scoring, Boolean, "Example: true", null: true
|
|
17
18
|
|
|
18
19
|
end
|
|
19
20
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "rubric_rating"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -13,7 +13,8 @@ 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::CanvasRubricRating], "", required: false
|
|
17
|
+
argument :ignore_for_scoring, Boolean, "Example: true", required: false
|
|
17
18
|
|
|
18
19
|
end
|
|
19
20
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "rubric_assessment"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasRubricAssessment], "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
|
|
@@ -5,8 +5,11 @@ module LMSGraphQL
|
|
|
5
5
|
module Types
|
|
6
6
|
module Canvas
|
|
7
7
|
class CanvasScope < BaseType
|
|
8
|
-
description "Scopes. API Docs: https://canvas.instructure.com/doc/api/
|
|
8
|
+
description "API Token Scopes. API Docs: https://canvas.instructure.com/doc/api/api_token_scopes.html"
|
|
9
9
|
field :resource, String, "The resource the scope is associated with.Example: courses", null: true
|
|
10
|
+
field :resource_name, String, "The localized resource name.Example: Courses", null: true
|
|
11
|
+
field :controller, String, "The controller the scope is associated to.Example: courses", null: true
|
|
12
|
+
field :action, String, "The controller action the scope is associated to.Example: index", null: true
|
|
10
13
|
field :verb, String, "The HTTP verb for the scope.Example: GET", null: true
|
|
11
14
|
field :scope, String, "The identifier for the scope.Example: url:GET|/api/v1/courses", null: true
|
|
12
15
|
|
|
@@ -5,8 +5,11 @@ module LMSGraphQL
|
|
|
5
5
|
module Types
|
|
6
6
|
module Canvas
|
|
7
7
|
class CanvasScopeInput < BaseInputObject
|
|
8
|
-
description "Scopes. API Docs: https://canvas.instructure.com/doc/api/
|
|
8
|
+
description "API Token Scopes. API Docs: https://canvas.instructure.com/doc/api/api_token_scopes.html"
|
|
9
9
|
argument :resource, String, "The resource the scope is associated with.Example: courses", required: false
|
|
10
|
+
argument :resource_name, String, "The localized resource name.Example: Courses", required: false
|
|
11
|
+
argument :controller, String, "The controller the scope is associated to.Example: courses", required: false
|
|
12
|
+
argument :action, String, "The controller action the scope is associated to.Example: index", required: false
|
|
10
13
|
argument :verb, String, "The HTTP verb for the scope.Example: GET", required: false
|
|
11
14
|
argument :scope, String, "The identifier for the scope.Example: url:GET|/api/v1/courses", required: false
|
|
12
15
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
2
|
+
require_relative "course_attribute"
|
|
3
|
+
require_relative "course_attribute"
|
|
4
|
+
require_relative "section_assignment_override_attribute"
|
|
5
5
|
|
|
6
6
|
module LMSGraphQL
|
|
7
7
|
module Types
|
|
@@ -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::CanvasCourseAttribute, "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::CanvasCourseAttribute, "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::CanvasSectionAssignmentOverrideAttribute, "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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
2
|
+
require_relative "assignment_group_attribute"
|
|
3
|
+
require_relative "section_attribute"
|
|
4
|
+
require_relative "user_assignment_override_attribute"
|
|
5
5
|
|
|
6
6
|
module LMSGraphQL
|
|
7
7
|
module Types
|
|
@@ -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::CanvasAssignmentGroupAttribute], "Includes attributes of a assignment_group for convenience. For more details see Assignments API..", required: false
|
|
36
|
+
argument :sections, [LMSGraphQL::Types::Canvas::CanvasSectionAttribute], "Includes attributes of a section for convenience. For more details see Sections API..", required: false
|
|
37
|
+
argument :user_overrides, [LMSGraphQL::Types::Canvas::CanvasUserAssignmentOverrideAttribute], "Includes attributes of a user assignment overrides. For more details see Assignments API..", required: false
|
|
38
38
|
|
|
39
39
|
end
|
|
40
40
|
end
|
|
@@ -46,6 +46,7 @@ module LMSGraphQL
|
|
|
46
46
|
field :clear_sis_stickiness, Boolean, "Whether stickiness was cleared..Example: false", null: true
|
|
47
47
|
field :diffing_data_set_identifier, String, "The identifier of the data set that this SIS batch diffs against.Example: account-5-enrollments", null: true
|
|
48
48
|
field :diffed_against_import_id, ID, "The ID of the SIS Import that this import was diffed against.Example: 1", null: true
|
|
49
|
+
field :csv_attachments, String, "An array of CSV files for processing.", null: true
|
|
49
50
|
|
|
50
51
|
end
|
|
51
52
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "sis_import_count"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasSisImportCount, "The number of rows processed for each type of import.", required: false
|
|
12
12
|
|
|
13
13
|
end
|
|
14
14
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
2
|
+
require_relative "sis_import_datum"
|
|
3
|
+
require_relative "file"
|
|
4
|
+
require_relative "user"
|
|
5
5
|
|
|
6
6
|
module LMSGraphQL
|
|
7
7
|
module Types
|
|
@@ -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::CanvasSisImportDatum, "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::CanvasFile, "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::CanvasUser, "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
|
|
@@ -46,6 +46,7 @@ module LMSGraphQL
|
|
|
46
46
|
argument :clear_sis_stickiness, Boolean, "Whether stickiness was cleared..Example: false", required: false
|
|
47
47
|
argument :diffing_data_set_identifier, String, "The identifier of the data set that this SIS batch diffs against.Example: account-5-enrollments", required: false
|
|
48
48
|
argument :diffed_against_import_id, ID, "The ID of the SIS Import that this import was diffed against.Example: 1", required: false
|
|
49
|
+
argument :csv_attachments, String, "An array of CSV files for processing.", required: false
|
|
49
50
|
|
|
50
51
|
end
|
|
51
52
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "media_comment"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasMediaComment, "", required: false
|
|
17
17
|
|
|
18
18
|
end
|
|
19
19
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "submission_version"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasSubmissionVersion], "an array of all the versions of this submission.", required: false
|
|
11
11
|
|
|
12
12
|
end
|
|
13
13
|
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require_relative "../canvas_base_input_type"
|
|
2
|
-
require_relative "
|
|
2
|
+
require_relative "submission_comment"
|
|
3
3
|
|
|
4
4
|
module LMSGraphQL
|
|
5
5
|
module Types
|
|
@@ -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::CanvasSubmissionComment], "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
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
require_relative "../canvas_base_type"
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
module LMSGraphQL
|
|
5
|
+
module Types
|
|
6
|
+
module Canvas
|
|
7
|
+
class CanvasTermsOfService < BaseType
|
|
8
|
+
description "Accounts. API Docs: https://canvas.instructure.com/doc/api/accounts.html"
|
|
9
|
+
field :id, ID, "Terms Of Service id.Example: 1", null: true
|
|
10
|
+
field :terms_type, String, "The given type for the Terms of Service.Example: default", null: true
|
|
11
|
+
field :passive, Boolean, "Boolean dictating if the user must accept Terms of Service.", null: true
|
|
12
|
+
field :account_id, ID, "The id of the root account that owns the Terms of Service.Example: 1", null: true
|
|
13
|
+
field :content, String, "Content of the Terms of Service.Example: To be or not to be that is the question", null: true
|
|
14
|
+
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|