lms-graphql-api 1.3.0

data/lib/lms_graphql/types/canvas/names_and_role_message.rb

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasNamesAndRoleMessage < BaseType
+        description "Names and Role. API Docs: https://canvas.instructure.com/doc/api/names_and_role.html"
+        field :message_type, String, "The type of LTI message being described. Always set to 'LtiResourceLinkRequest'.Example: LtiResourceLinkRequest", null: true
+        field :locale, String, "The member's preferred locale.Example: en", null: true
+        field :canvas_user_id, ID, "The member's API ID.Example: 1", null: true
+        field :canvas_user_login_id, ID, "The member's primary login username.Example: showell@school.edu", null: true
+        field :custom, String, "Expanded LTI custom parameters that pertain to the member (as opposed to the Context).Example: en, America/Denver", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/names_and_role_message_input.rb

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasNamesAndRoleMessageInput < BaseInputObject
+        description "Names and Role. API Docs: https://canvas.instructure.com/doc/api/names_and_role.html"
+        argument :message_type, String, "The type of LTI message being described. Always set to 'LtiResourceLinkRequest'.Example: LtiResourceLinkRequest", required: false
+        argument :locale, String, "The member's preferred locale.Example: en", required: false
+        argument :canvas_user_id, ID, "The member's API ID.Example: 1", required: false
+        argument :canvas_user_login_id, ID, "The member's primary login username.Example: showell@school.edu", required: false
+        argument :custom, String, "Expanded LTI custom parameters that pertain to the member (as opposed to the Context).Example: en, America/Denver", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/needs_grading_count.rb

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasNeedsGradingCount < BaseType
+        description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+        field :section_id, ID, "The section ID.Example: 123456", null: true
+        field :needs_grading_count, Int, "Number of submissions that need grading.Example: 5", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/needs_grading_count_input.rb

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasNeedsGradingCountInput < BaseInputObject
+        description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+        argument :section_id, ID, "The section ID.Example: 123456", required: false
+        argument :needs_grading_count, Int, "Number of submissions that need grading.Example: 5", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/notification_preference.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class NotificationPreferenceFrequencyEnum < ::GraphQL::Schema::Enum
+          value "immediately"
+          value "daily"
+          value "weekly"
+          value "never"
+        end
+      class CanvasNotificationPreference < BaseType
+        description "Notification Preferences. API Docs: https://canvas.instructure.com/doc/api/notification_preferences.html"
+        field :href, String, "Example: https://canvas.instructure.com/users/1/communication_channels/email/student@example.edu/notification_preferences/new_announcement", null: true
+        field :notification, String, "The notification this preference belongs to.Example: new_announcement", null: true
+        field :category, String, "The category of that notification.Example: announcement", null: true
+        field :frequency, NotificationPreferenceFrequencyEnum, "How often to send notifications to this communication channel for the given notification. Possible values are 'immediately', 'daily', 'weekly', and 'never'.Example: daily", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/notification_preference_input.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class NotificationPreferenceFrequencyEnum < ::GraphQL::Schema::Enum
+          value "immediately"
+          value "daily"
+          value "weekly"
+          value "never"
+        end
+      class CanvasNotificationPreferenceInput < BaseInputObject
+        description "Notification Preferences. API Docs: https://canvas.instructure.com/doc/api/notification_preferences.html"
+        argument :href, String, "Example: https://canvas.instructure.com/users/1/communication_channels/email/student@example.edu/notification_preferences/new_announcement", required: false
+        argument :notification, String, "The notification this preference belongs to.Example: new_announcement", required: false
+        argument :category, String, "The category of that notification.Example: announcement", required: false
+        argument :frequency, NotificationPreferenceFrequencyEnum, "How often to send notifications to this communication channel for the given notification. Possible values are 'immediately', 'daily', 'weekly', and 'never'.Example: daily", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/originality_report.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+require_relative "tool_setting"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOriginalityReport < BaseType
+        description "Originality Reports. API Docs: https://canvas.instructure.com/doc/api/originality_reports.html"
+        field :id, ID, "The id of the OriginalityReport.Example: 4", null: true
+        field :file_id, ID, "The id of the file receiving the originality score.Example: 8", null: true
+        field :originality_score, Float, "A number between 0 and 100 representing the originality score.Example: 0.16", null: true
+        field :originality_report_file_id, ID, "The ID of the file within Canvas containing the originality report document (if provided).Example: 23", null: true
+        field :originality_report_url, String, "A non-LTI launch URL where the originality score of the file may be found..Example: http://www.example.com/report", null: true
+        field :tool_setting, LMSGraphQL::Types::Canvas::CanvasToolSetting, "A ToolSetting object containing optional 'resource_type_code' and 'resource_url'.", null: true
+        field :error_report, String, "A message describing the error. If set, the workflow_state will become 'error.'.", null: true
+        field :submission_time, LMSGraphQL::Types::DateTimeType, "The submitted_at date time of the submission..", null: true
+        field :root_account_id, ID, "The id of the root Account associated with the OriginalityReport.Example: 1", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/originality_report_input.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_input_type"
+require_relative "tool_setting"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOriginalityReportInput < BaseInputObject
+        description "Originality Reports. API Docs: https://canvas.instructure.com/doc/api/originality_reports.html"
+        argument :id, ID, "The id of the OriginalityReport.Example: 4", required: false
+        argument :file_id, ID, "The id of the file receiving the originality score.Example: 8", required: false
+        argument :originality_score, Float, "A number between 0 and 100 representing the originality score.Example: 0.16", required: false
+        argument :originality_report_file_id, ID, "The ID of the file within Canvas containing the originality report document (if provided).Example: 23", required: false
+        argument :originality_report_url, String, "A non-LTI launch URL where the originality score of the file may be found..Example: http://www.example.com/report", required: false
+        argument :tool_setting, LMSGraphQL::Types::Canvas::CanvasToolSettingInput, "A ToolSetting object containing optional 'resource_type_code' and 'resource_url'.", required: false
+        argument :error_report, String, "A message describing the error. If set, the workflow_state will become 'error.'.", required: false
+        argument :submission_time, LMSGraphQL::Types::DateTimeType, "The submitted_at date time of the submission..", required: false
+        argument :root_account_id, ID, "The id of the root Account associated with the OriginalityReport.Example: 1", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome.rb

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_type"
+require_relative "rubric_rating"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class OutcomeCalculationMethodEnum < ::GraphQL::Schema::Enum
+          value "decaying_average"
+          value "n_mastery"
+          value "latest"
+          value "highest"
+        end
+      class CanvasOutcome < BaseType
+        description "Outcomes. API Docs: https://canvas.instructure.com/doc/api/outcomes.html"
+        field :id, ID, "the ID of the outcome.Example: 1", null: true
+        field :url, String, "the URL for fetching/updating the outcome. should be treated as opaque.Example: /api/v1/outcomes/1", null: true
+        field :context_id, ID, "the context owning the outcome. may be null for global outcomes.Example: 1", null: true
+        field :context_type, String, "Example: Account", null: true
+        field :title, String, "title of the outcome.Example: Outcome title", null: true
+        field :display_name, String, "Optional friendly name for reporting.Example: My Favorite Outcome", null: true
+        field :description, String, "description of the outcome. omitted in the abbreviated form..Example: Outcome description", null: true
+        field :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", null: true
+        field :points_possible, Int, "maximum points possible. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 5", null: true
+        field :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", null: true
+        field :calculation_method, OutcomeCalculationMethodEnum, "the method used to calculate a students score.Example: decaying_average", null: true
+        field :calculation_int, Int, "this defines the variable value used by the calculation_method. included only if calculation_method uses it.Example: 65", null: true
+        field :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRating], "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..", null: true
+        field :can_edit, Boolean, "whether the current user can update the outcome.Example: true", null: true
+        field :can_unlink, Boolean, "whether the outcome can be unlinked.Example: true", null: true
+        field :assessed, Boolean, "whether this outcome has been used to assess a student.Example: true", null: true
+        field :has_updateable_rubrics, Boolean, "whether updates to this outcome will propagate to unassessed rubrics that have imported it.Example: true", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_alignment.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeAlignment < BaseType
+        description "Outcomes. API Docs: https://canvas.instructure.com/doc/api/outcomes.html"
+        field :id, ID, "the id of the aligned learning outcome..Example: 1", null: true
+        field :assignment_id, ID, "the id of the aligned assignment (null for live assessments)..Example: 2", null: true
+        field :assessment_id, ID, "the id of the aligned live assessment (null for assignments)..Example: 3", null: true
+        field :submission_types, String, "a string representing the different submission types of an aligned assignment..Example: online_text_entry,online_url", null: true
+        field :url, String, "the URL for the aligned assignment..Example: /courses/1/assignments/5", null: true
+        field :title, String, "the title of the aligned assignment..Example: Unit 1 test", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_alignment_input.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeAlignmentInput < BaseInputObject
+        description "Outcomes. API Docs: https://canvas.instructure.com/doc/api/outcomes.html"
+        argument :id, ID, "the id of the aligned learning outcome..Example: 1", required: false
+        argument :assignment_id, ID, "the id of the aligned assignment (null for live assessments)..Example: 2", required: false
+        argument :assessment_id, ID, "the id of the aligned live assessment (null for assignments)..Example: 3", required: false
+        argument :submission_types, String, "a string representing the different submission types of an aligned assignment..Example: online_text_entry,online_url", required: false
+        argument :url, String, "the URL for the aligned assignment..Example: /courses/1/assignments/5", required: false
+        argument :title, String, "the title of the aligned assignment..Example: Unit 1 test", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_group.rb

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_group"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeGroup < BaseType
+        description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
+        field :id, ID, "the ID of the outcome group.Example: 1", null: true
+        field :url, String, "the URL for fetching/updating the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1", null: true
+        field :parent_outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroup, "an abbreviated OutcomeGroup object representing the parent group of this outcome group, if any. omitted in the abbreviated form..", null: true
+        field :context_id, ID, "the context owning the outcome group. may be null for global outcome groups. omitted in the abbreviated form..Example: 1", null: true
+        field :context_type, String, "Example: Account", null: true
+        field :title, String, "title of the outcome group.Example: Outcome group title", null: true
+        field :description, String, "description of the outcome group. omitted in the abbreviated form..Example: Outcome group description", null: true
+        field :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", null: true
+        field :subgroups_url, String, "the URL for listing/creating subgroups under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/subgroups", null: true
+        field :outcomes_url, String, "the URL for listing/creating outcome links under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes", null: true
+        field :import_url, String, "the URL for importing another group into this outcome group. should be treated as opaque. omitted in the abbreviated form..Example: /api/v1/accounts/1/outcome_groups/1/import", null: true
+        field :can_edit, Boolean, "whether the current user can update the outcome group.Example: true", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_group_input.rb

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_input_type"
+require_relative "outcome_group"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeGroupInput < BaseInputObject
+        description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
+        argument :id, ID, "the ID of the outcome group.Example: 1", required: false
+        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
+        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
+        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
+        argument :context_type, String, "Example: Account", required: false
+        argument :title, String, "title of the outcome group.Example: Outcome group title", required: false
+        argument :description, String, "description of the outcome group. omitted in the abbreviated form..Example: Outcome group description", required: false
+        argument :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", required: false
+        argument :subgroups_url, String, "the URL for listing/creating subgroups under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/subgroups", required: false
+        argument :outcomes_url, String, "the URL for listing/creating outcome links under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes", required: false
+        argument :import_url, String, "the URL for importing another group into this outcome group. should be treated as opaque. omitted in the abbreviated form..Example: /api/v1/accounts/1/outcome_groups/1/import", required: false
+        argument :can_edit, Boolean, "whether the current user can update the outcome group.Example: true", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_import.rb

@@ -0,0 +1,33 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_import_datum"
+require_relative "user"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class OutcomeImportWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "importing"
+          value "succeeded"
+          value "failed"
+        end
+      class CanvasOutcomeImport < BaseType
+        description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+        field :id, ID, "The unique identifier for the outcome import..Example: 1", null: true
+        field :created_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was created..Example: 2013-12-01T23:59:00-06:00", null: true
+        field :ended_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", null: true
+        field :updated_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was last updated..Example: 2013-12-02T00:03:21-06:00", null: true
+        field :workflow_state, OutcomeImportWorkflowStateEnum, "The current state of the outcome import.
+ - 'created': The outcome import has been created.
+ - 'importing': The outcome import is currently processing.
+ - 'succeeded': The outcome import has completed successfully.
+ - 'failed': The outcome import failed..Example: imported", null: true
+        field :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatum, "See the OutcomeImportData specification above..", null: true
+        field :progress, String, "The progress of the outcome import..Example: 100", null: true
+        field :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user that initiated the outcome_import. See the Users API for details..", null: true
+        field :processing_errors, String, "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_import_datum.rb

@@ -0,0 +1,14 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeImportDatum < BaseType
+        description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+        field :import_type, String, "The type of outcome import.Example: instructure_csv", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_import_datum_input.rb

@@ -0,0 +1,14 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeImportDatumInput < BaseInputObject
+        description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+        argument :import_type, String, "The type of outcome import.Example: instructure_csv", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_import_input.rb

@@ -0,0 +1,33 @@
+require_relative "../canvas_base_input_type"
+require_relative "outcome_import_datum"
+require_relative "user"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class OutcomeImportWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "importing"
+          value "succeeded"
+          value "failed"
+        end
+      class CanvasOutcomeImportInput < BaseInputObject
+        description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+        argument :id, ID, "The unique identifier for the outcome import..Example: 1", required: false
+        argument :created_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was created..Example: 2013-12-01T23:59:00-06:00", required: false
+        argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", required: false
+        argument :updated_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was last updated..Example: 2013-12-02T00:03:21-06:00", required: false
+        argument :workflow_state, OutcomeImportWorkflowStateEnum, "The current state of the outcome import.
+ - 'created': The outcome import has been created.
+ - 'importing': The outcome import is currently processing.
+ - 'succeeded': The outcome import has completed successfully.
+ - 'failed': The outcome import failed..Example: imported", required: false
+        argument :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatumInput, "See the OutcomeImportData specification above..", required: false
+        argument :progress, String, "The progress of the outcome import..Example: 100", required: false
+        argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the outcome_import. See the Users API for details..", required: false
+        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
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_input.rb

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_input_type"
+require_relative "rubric_rating"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class OutcomeCalculationMethodEnum < ::GraphQL::Schema::Enum
+          value "decaying_average"
+          value "n_mastery"
+          value "latest"
+          value "highest"
+        end
+      class CanvasOutcomeInput < BaseInputObject
+        description "Outcomes. API Docs: https://canvas.instructure.com/doc/api/outcomes.html"
+        argument :id, ID, "the ID of the outcome.Example: 1", required: false
+        argument :url, String, "the URL for fetching/updating the outcome. should be treated as opaque.Example: /api/v1/outcomes/1", required: false
+        argument :context_id, ID, "the context owning the outcome. may be null for global outcomes.Example: 1", required: false
+        argument :context_type, String, "Example: Account", required: false
+        argument :title, String, "title of the outcome.Example: Outcome title", required: false
+        argument :display_name, String, "Optional friendly name for reporting.Example: My Favorite Outcome", required: false
+        argument :description, String, "description of the outcome. omitted in the abbreviated form..Example: Outcome description", required: false
+        argument :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", required: false
+        argument :points_possible, Int, "maximum points possible. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 5", required: false
+        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
+        argument :calculation_method, OutcomeCalculationMethodEnum, "the method used to calculate a students score.Example: decaying_average", required: false
+        argument :calculation_int, Int, "this defines the variable value used by the calculation_method. included only if calculation_method uses it.Example: 65", required: false
+        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
+        argument :can_edit, Boolean, "whether the current user can update the outcome.Example: true", required: false
+        argument :can_unlink, Boolean, "whether the outcome can be unlinked.Example: true", required: false
+        argument :assessed, Boolean, "whether this outcome has been used to assess a student.Example: true", required: false
+        argument :has_updateable_rubrics, Boolean, "whether updates to this outcome will propagate to unassessed rubrics that have imported it.Example: true", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/outcome_link.rb

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_group"
+require_relative "outcome"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasOutcomeLink < BaseType
+        description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
+        field :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", null: true
+        field :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", null: true
+        field :context_type, String, "Example: Account", null: true
+        field :outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroup, "an abbreviated OutcomeGroup object representing the group containing the outcome link..", null: true
+        field :outcome, LMSGraphQL::Types::Canvas::CanvasOutcome, "an abbreviated Outcome object representing the outcome linked into the containing outcome group..", null: true
+        field :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", null: true
+        field :can_unlink, Boolean, "whether this outcome link is manageable and is not the last link to an aligned outcome.", null: true
+
+      end
+    end
+  end
+end