lms-api 1.16.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/canvas_api/builder.rb +29 -3
- data/lib/canvas_api/rb_graphql_helpers.rb +75 -33
- data/lib/canvas_api/templates/rb_graphql_input_type.erb +1 -1
- data/lib/canvas_api/templates/rb_graphql_mutation.erb +9 -1
- data/lib/canvas_api/templates/rb_graphql_type.erb +2 -2
- data/lib/lms/canvas_urls.rb +41 -22
- data/lib/lms/course_ids_required.rb +9 -0
- data/lib/lms/version.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5f5ede3eeafffbcd50df307c3e91c267ff651bce51a79837d1bbb385f4964d00
|
4
|
+
data.tar.gz: 4b0b189c2d7f5755bdea8fb7e77ed227353f0a4207115c8d1aaa45867d78b0fb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9b1f4da55b941bf5c474c4d9b3a0e26997c331a383803fcaeec686b1dd07280e64b63ec6fa8d4bdd430dec016c9488b541a39264d872b38f0f3bf3fa3f7d7279
|
7
|
+
data.tar.gz: df0db832c3fe428126e8afed7e51834a219ba821e31e2bf30eba1a51bc133ed604e8b3a4d6f45dc232dedb548dbd4a8f5bfe0b762f778e5b726a5894abf9ab77
|
data/lib/canvas_api/builder.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
require "canvas_api/render"
|
2
2
|
require "byebug"
|
3
|
+
require "set"
|
4
|
+
|
3
5
|
module CanvasApi
|
4
6
|
|
5
7
|
class Builder
|
@@ -35,8 +37,17 @@ module CanvasApi
|
|
35
37
|
directory["apis"].each do |api|
|
36
38
|
puts "Generating #{api['description']}"
|
37
39
|
resource = HTTParty.get("#{endpoint}#{api['path']}")
|
40
|
+
|
41
|
+
# HACK The canvas docs are missing one of the allowable value in modules
|
42
|
+
# TODO we might want to create a hacks class at some point to contain all these
|
43
|
+
if api['path'] == "/modules.json"
|
44
|
+
if !resource["models"]["CompletionRequirement"]["properties"]["type"]["allowableValues"]["values"].include?("must_mark_done")
|
45
|
+
resource["models"]["CompletionRequirement"]["properties"]["type"]["allowableValues"]["values"].push("must_mark_done")
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
38
49
|
constants = []
|
39
|
-
resource["apis"]
|
50
|
+
resource["apis"]&.each do |resource_api|
|
40
51
|
resource_api["operations"].each do |operation|
|
41
52
|
|
42
53
|
# Prevent duplicates
|
@@ -47,7 +58,7 @@ module CanvasApi
|
|
47
58
|
nicknames << nickname
|
48
59
|
operation["nickname"] = nickname
|
49
60
|
|
50
|
-
parameters = operation["parameters"]
|
61
|
+
parameters = filter_duplicate_parameters(operation["parameters"])
|
51
62
|
constants << CanvasApi::Render.new("./templates/constant.erb", api, resource, resource_api, operation, parameters, nil, nil).render
|
52
63
|
lms_urls_rb << CanvasApi::Render.new("./templates/rb_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
|
53
64
|
lms_urls_js << CanvasApi::Render.new("./templates/js_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
|
@@ -116,6 +127,21 @@ module CanvasApi
|
|
116
127
|
CanvasApi::Render.new("./templates/rb_graphql_mutations.erb", nil, nil, nil, nil, nil, rb_graphql_mutations, nil).save("#{rb_graphql_app_path}/lib/lms_graphql/mutations/canvas/mutations.rb")
|
117
128
|
end
|
118
129
|
|
130
|
+
def self.filter_duplicate_parameters(parameters)
|
131
|
+
# Canvas placed a deprecation warning
|
132
|
+
# at the bottom of their documentation
|
133
|
+
# for editing an assignment. This caused
|
134
|
+
# us to create two instances of that specific field
|
135
|
+
# this will filter that out (and ony other instances where they might do that)
|
136
|
+
names = Set.new
|
137
|
+
parameters.select do |param|
|
138
|
+
included = names.include? param["name"]
|
139
|
+
names.add(param["name"]) if !included
|
140
|
+
!included
|
141
|
+
end
|
142
|
+
end
|
119
143
|
end
|
120
|
-
|
121
144
|
end
|
145
|
+
|
146
|
+
|
147
|
+
|
@@ -1,5 +1,9 @@
|
|
1
1
|
module CanvasApi
|
2
2
|
module GraphQLHelpers
|
3
|
+
# list of names that conflict with built in methods,
|
4
|
+
# Instead of generating a regular field for these ones,
|
5
|
+
# generate a resolver method
|
6
|
+
CONFLICTING_NAMES = ["end", "context", "next", "module"]
|
3
7
|
|
4
8
|
def graphql_type(name, property, return_type = false, model = nil, input_type = false)
|
5
9
|
if property["$ref"]
|
@@ -8,7 +12,6 @@ module CanvasApi
|
|
8
12
|
enum_class_name(model, name)
|
9
13
|
else
|
10
14
|
type = property["type"].downcase
|
11
|
-
|
12
15
|
case type
|
13
16
|
when "{success: true}"
|
14
17
|
"String"
|
@@ -19,25 +22,27 @@ module CanvasApi
|
|
19
22
|
when "array"
|
20
23
|
begin
|
21
24
|
type = if property["items"]["$ref"] == "[Integer]"
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
25
|
+
"[Int]"
|
26
|
+
elsif property["items"]["$ref"] == "Array"
|
27
|
+
"[String]"
|
28
|
+
elsif property["items"]["$ref"] == "[String]"
|
29
|
+
"[String]"
|
27
30
|
elsif property["items"]["$ref"] == "DateTime" || property["items"]["$ref"] == "Date"
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
31
|
+
"[LMSGraphQL::Types::DateTimeType]"
|
32
|
+
elsif property["items"]["$ref"]
|
33
|
+
# HACK on https://canvas.instructure.com/doc/api/submissions.json
|
34
|
+
# the ref value is set to a full sentence rather than a
|
35
|
+
# simple type, so we look for that specific value
|
36
|
+
if property["items"]["$ref"].include?("UserDisplay if anonymous grading is not enabled")
|
37
|
+
"[LMSGraphQL::Types::Canvas::CanvasUserDisplay]"
|
38
|
+
elsif property["items"]["$ref"].include?("Url String The url to the result that was created")
|
39
|
+
"String"
|
40
|
+
else
|
41
|
+
"[#{canvas_name(property["items"]["$ref"], input_type)}]"
|
42
|
+
end
|
43
|
+
else
|
44
|
+
graphql_primitive(name, property["items"]["type"].downcase, property["items"]["format"])
|
45
|
+
end
|
41
46
|
rescue
|
42
47
|
puts "Unable to discover list type for '#{name}' ('#{property}'). Defaulting to String"
|
43
48
|
type = "String"
|
@@ -50,6 +55,12 @@ module CanvasApi
|
|
50
55
|
if property["type"] == "TermsOfService"
|
51
56
|
# HACK There's no TermsOfService object so we return a string
|
52
57
|
"String"
|
58
|
+
elsif property["type"] == "list of content items"
|
59
|
+
# HACK There's no list of content items object so we return an array of string
|
60
|
+
"[String]"
|
61
|
+
elsif property["type"].include?('{ "unread_count": "integer" }')
|
62
|
+
# HACK TODO this should probably be a different type.
|
63
|
+
"Int"
|
53
64
|
elsif return_type
|
54
65
|
canvas_name(property["type"], input_type)
|
55
66
|
else
|
@@ -61,7 +72,8 @@ module CanvasApi
|
|
61
72
|
end
|
62
73
|
|
63
74
|
def canvas_name(type, input_type = false)
|
64
|
-
|
75
|
+
# Remove chars and fix spelling errors
|
76
|
+
name = type.split('|').first.strip.gsub(" ", "_").singularize.gsub("MediaTrackk", "MediaTrack")
|
65
77
|
"LMSGraphQL::Types::Canvas::Canvas#{name}#{input_type ? 'Input' : ''}"
|
66
78
|
end
|
67
79
|
|
@@ -127,15 +139,18 @@ module CanvasApi
|
|
127
139
|
description << "#{safe_rb(property['description'])}." if property["description"].present?
|
128
140
|
description << "Example: #{safe_rb(property['example'])}".gsub("..", "").gsub("\n", " ") if property["example"].present?
|
129
141
|
|
142
|
+
# clean up name
|
143
|
+
name = nested_arg(name)
|
144
|
+
|
130
145
|
if type = graphql_type(name, property, false, model, input_type)
|
131
146
|
if argument
|
132
|
-
|
133
|
-
argument :#{name.underscore}, #{type}, "#{description}", required: false
|
134
|
-
CODE
|
147
|
+
argument_format(name, type, description)
|
135
148
|
else
|
136
|
-
|
137
|
-
|
138
|
-
|
149
|
+
if CONFLICTING_NAMES.include?(name.underscore)
|
150
|
+
field_resolver_format(name, type, description)
|
151
|
+
else
|
152
|
+
field_format(name, type, description)
|
153
|
+
end
|
139
154
|
end
|
140
155
|
else
|
141
156
|
puts "Unable to determine type for #{name}"
|
@@ -143,12 +158,30 @@ module CanvasApi
|
|
143
158
|
end.compact
|
144
159
|
end
|
145
160
|
|
161
|
+
def argument_format(name, type, description="")
|
162
|
+
"argument :#{name.underscore}, #{type}, \"#{description}\", required: false\n"
|
163
|
+
end
|
164
|
+
|
165
|
+
def field_format(name, type, description="")
|
166
|
+
"field :#{name.underscore}, #{type}, \"#{description}\", null: true\n"
|
167
|
+
end
|
168
|
+
|
169
|
+
def field_resolver_format(name, type, description)
|
170
|
+
<<-CODE
|
171
|
+
field :#{name.underscore}, #{type}, "#{description}", resolver_method: :resolve_#{name.underscore}, null: true
|
172
|
+
def resolve_#{name.underscore}
|
173
|
+
object[:#{name.underscore}]
|
174
|
+
end
|
175
|
+
CODE
|
176
|
+
end
|
177
|
+
|
178
|
+
|
146
179
|
def type_from_operation(operation)
|
147
180
|
type = graphql_type("operation", operation, true)
|
148
181
|
end
|
149
182
|
|
150
183
|
def name_from_operation(operation)
|
151
|
-
type =
|
184
|
+
type = no_brackets_period(type_from_operation(@operation))
|
152
185
|
if !is_basic_type(type)
|
153
186
|
make_file_name(type)
|
154
187
|
else
|
@@ -160,16 +193,16 @@ module CanvasApi
|
|
160
193
|
["Int", "String", "Boolean", "LMSGraphQL::Types::DateTimeType", "Float", "ID"].include?(type)
|
161
194
|
end
|
162
195
|
|
163
|
-
def
|
164
|
-
str.gsub("[", "").gsub("]", "")
|
196
|
+
def no_brackets_period(str)
|
197
|
+
str.gsub("[", "").gsub("]", "").gsub(".", "")
|
165
198
|
end
|
166
199
|
|
167
200
|
def make_file_name(str)
|
168
|
-
str.underscore.split("/").last.split("|").first.gsub("canvas_", "").strip.singularize
|
201
|
+
str.underscore.split("/").last.split("|").first.gsub("canvas_", "").gsub(" ", "_").strip.singularize
|
169
202
|
end
|
170
203
|
|
171
204
|
def require_from_operation(operation)
|
172
|
-
type =
|
205
|
+
type = no_brackets_period(type_from_operation(@operation))
|
173
206
|
if !is_basic_type(type)
|
174
207
|
"require_relative \"../../types/canvas/#{make_file_name(type)}\""
|
175
208
|
end
|
@@ -178,7 +211,7 @@ module CanvasApi
|
|
178
211
|
def require_from_properties(model)
|
179
212
|
return unless model["properties"]
|
180
213
|
requires = model["properties"].map do |name, property|
|
181
|
-
type =
|
214
|
+
type = no_brackets_period(graphql_type(name, property, true, model))
|
182
215
|
if !is_basic_type(type) && !property["allowableValues"]
|
183
216
|
"require_relative \"#{make_file_name(type)}\""
|
184
217
|
end
|
@@ -201,7 +234,16 @@ module CanvasApi
|
|
201
234
|
# TODO/HACK we are replacing values from the string here to get things to work for now.
|
202
235
|
# However, removing these symbols means that the methods that use the arguments
|
203
236
|
# generated herein will have bugs and be unusable.
|
204
|
-
str.gsub("[", "_").
|
237
|
+
str.gsub("[", "_").
|
238
|
+
gsub("]", "").
|
239
|
+
gsub("*", "star").
|
240
|
+
gsub("<", "_").
|
241
|
+
gsub(">", "_").
|
242
|
+
gsub("`", "").
|
243
|
+
gsub("https://canvas.instructure.com/lti/", "").
|
244
|
+
gsub("https://www.instructure.com/", "").
|
245
|
+
gsub("https://purl.imsglobal.org/spec/lti/claim/", "").
|
246
|
+
gsub(".", "")
|
205
247
|
end
|
206
248
|
|
207
249
|
def params_as_string(parameters, paramTypes)
|
@@ -4,8 +4,8 @@ require_relative "../canvas_base_input_type"
|
|
4
4
|
module LMSGraphQL
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
|
-
<%=graphql_field_enums(@model)-%>
|
8
7
|
class Canvas<%=@model['id'].singularize%>Input < BaseInputObject
|
8
|
+
<%=graphql_field_enums(@model)-%>
|
9
9
|
description "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html"
|
10
10
|
<%=graphql_fields(@model, @resource_name, true, true).join(" ")%>
|
11
11
|
end
|
@@ -6,7 +6,15 @@ module LMSGraphQL
|
|
6
6
|
module Canvas
|
7
7
|
class <%= @nickname.classify %> < BaseMutation
|
8
8
|
<%= @parameters.map{|p| " argument :#{nested_arg(p["name"])}, #{graphql_type(p["name"], p, false, nil, true)}, required: #{p["required"]}"}.join("\n") %>
|
9
|
-
|
9
|
+
<% name = name_from_operation(operation)%>
|
10
|
+
<% if CONFLICTING_NAMES.include?(name)%>
|
11
|
+
field :<%= name %>, <%= type_from_operation(operation) %>, null: false, resolver_method: :resolve_<%= name %>
|
12
|
+
def resolve_<%= name %>
|
13
|
+
object[:<%= name %>]
|
14
|
+
end
|
15
|
+
<% else %>
|
16
|
+
field :<%= name %>, <%= type_from_operation(operation) %>, null: false
|
17
|
+
<% end %>
|
10
18
|
def resolve(<%= @parameters.map{|p| "#{nested_arg(p['name'])}#{p['required'] ? ':' : ': nil'}"}.join(", ") %>)
|
11
19
|
context[:canvas_api].call("<%= @nickname.upcase %>").proxy(
|
12
20
|
"<%= @nickname.upcase %>",
|
@@ -4,10 +4,10 @@ require_relative "../canvas_base_type"
|
|
4
4
|
module LMSGraphQL
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
|
-
<%=graphql_field_enums(@model)-%>
|
8
7
|
class Canvas<%=@model['id'].singularize%> < BaseType
|
8
|
+
<%=graphql_field_enums(@model)-%>
|
9
9
|
description "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html"
|
10
|
-
|
10
|
+
<%=graphql_fields(@model, @resource_name).join(" ")%>
|
11
11
|
end
|
12
12
|
end
|
13
13
|
end
|
data/lib/lms/canvas_urls.rb
CHANGED
@@ -20,7 +20,7 @@ module LMS
|
|
20
20
|
"GET_TERMS_OF_SERVICE" => { uri: ->(account_id:) { "accounts/#{account_id}/terms_of_service" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
21
21
|
"GET_HELP_LINKS" => { uri: ->(account_id:) { "accounts/#{account_id}/help_links" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
22
22
|
"LIST_ACTIVE_COURSES_IN_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"with_enrollments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"published", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"completed", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"blueprint", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"blueprint_associated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"by_teachers", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"by_subaccounts", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"hide_enrollmentless_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["created", "claimed", "available", "completed", "deleted", "all"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["syllabus_body", "term", "course_progress", "storage_quota_used_mb", "total_students", "teachers", "account_name", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_name", "sis_course_id", "teacher", "account_name"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"search_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course", "teacher"]}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
23
|
-
"UPDATE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[services]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
23
|
+
"UPDATE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[course_template_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_outcome_proficiency][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[lock_outcome_proficiency][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_proficiency_calculation][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[lock_proficiency_calculation][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[services]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
24
24
|
"DELETE_USER_FROM_ROOT_ACCOUNT" => { uri: ->(account_id:, user_id:) { "accounts/#{account_id}/users/#{user_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
25
25
|
"CREATE_NEW_SUB_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/sub_accounts" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
26
26
|
"DELETE_SUB_ACCOUNT" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sub_accounts/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -59,18 +59,19 @@ module LMS
|
|
59
59
|
"LIST_STUDENT_GROUP_PARTICIPANTS" => { uri: ->(id:) { "appointment_groups/#{id}/groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"registration_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["all", "registered", "registered"]}] },
|
60
60
|
"GET_NEXT_APPOINTMENT" => { uri: ->() { "appointment_groups/next_appointment" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"appointment_group_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
61
61
|
"SET_EXTENSIONS_FOR_STUDENT_ASSIGNMENT_SUBMISSIONS" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/extensions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment_extensions[user_id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"assignment_extensions[extra_attempts]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
62
|
-
"LIST_ASSIGNMENT_GROUPS" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "all_dates", "assignment_visibility", "overrides", "submission", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_assignment_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "discussion_topic", "wiki_page", "external_tool"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"scope_assignments_to_student", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
63
|
-
"GET_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "assignment_visibility", "submission"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
62
|
+
"LIST_ASSIGNMENT_GROUPS" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "all_dates", "assignment_visibility", "overrides", "submission", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_assignment_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "discussion_topic", "wiki_page", "external_tool"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"scope_assignments_to_student", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
63
|
+
"GET_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "assignment_visibility", "submission", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
64
64
|
"CREATE_ASSIGNMENT_GROUP" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"group_weight", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sis_source_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"integration_data", "type"=>"Object", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rules", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
65
65
|
"EDIT_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
66
66
|
"DESTROY_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"move_assignments_to", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
67
67
|
"DELETE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
68
|
-
"LIST_ASSIGNMENTS_ASSIGNMENTS" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
69
|
-
"LIST_ASSIGNMENTS_ASSIGNMENT_GROUPS" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
68
|
+
"LIST_ASSIGNMENTS_ASSIGNMENTS" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
69
|
+
"LIST_ASSIGNMENTS_ASSIGNMENT_GROUPS" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
70
70
|
"LIST_ASSIGNMENTS_FOR_USER" => { uri: ->(user_id:, course_id:) { "users/#{user_id}/courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
71
|
-
"
|
72
|
-
"
|
73
|
-
"
|
71
|
+
"DUPLICATE_ASSIGNNMENT" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"result_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["Quiz"]}] },
|
72
|
+
"GET_SINGLE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
73
|
+
"CREATE_ASSIGNMENT" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording", "student_annotation"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[quiz_lti]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
74
|
+
"EDIT_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording", "student_annotation"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[sis_assignment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
74
75
|
"BULK_UPDATE_ASSIGNMENT_DATES" => { uri: ->(course_id:) { "courses/#{course_id}/assignments/bulk_update" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
75
76
|
"LIST_ASSIGNMENT_OVERRIDES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
76
77
|
"GET_SINGLE_ASSIGNMENT_OVERRIDE" => { uri: ->(course_id:, assignment_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/overrides/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -121,7 +122,7 @@ module LMS
|
|
121
122
|
"DELETE_CALENDAR_EVENT" => { uri: ->(id:) { "calendar_events/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"cancel_reason", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
122
123
|
"SET_COURSE_TIMETABLE" => { uri: ->(course_id:) { "courses/#{course_id}/calendar_events/timetable" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"timetables[course_section_id]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"form", "name"=>"timetables[course_section_id][weekdays]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"timetables[course_section_id][start_time]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"timetables[course_section_id][end_time]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"timetables[course_section_id][location_name]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
123
124
|
"GET_COURSE_TIMETABLE" => { uri: ->(course_id:) { "courses/#{course_id}/calendar_events/timetable" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
124
|
-
"CREATE_OR_UPDATE_EVENTS_DIRECTLY_FOR_COURSE_TIMETABLE" => { uri: ->(course_id:) { "courses/#{course_id}/calendar_events/timetable_events" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_section_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"events", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"form", "name"=>"events[start_at]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"DateTime"}}, {"paramType"=>"form", "name"=>"events[end_at]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"DateTime"}}, {"paramType"=>"form", "name"=>"events[location_name]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"events[code]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
125
|
+
"CREATE_OR_UPDATE_EVENTS_DIRECTLY_FOR_COURSE_TIMETABLE" => { uri: ->(course_id:) { "courses/#{course_id}/calendar_events/timetable_events" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_section_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"events", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"form", "name"=>"events[start_at]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"DateTime"}}, {"paramType"=>"form", "name"=>"events[end_at]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"DateTime"}}, {"paramType"=>"form", "name"=>"events[location_name]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"events[code]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"events[title]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
125
126
|
"LIST_COLLABORATIONS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/collaborations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
126
127
|
"LIST_COLLABORATIONS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/collaborations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
127
128
|
"LIST_MEMBERS_OF_COLLABORATION" => { uri: ->(id:) { "collaborations/#{id}/members" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["collaborator_lti_id", "avatar_image_url"], "items"=>{"type"=>"string"}}] },
|
@@ -214,8 +215,9 @@ module LMS
|
|
214
215
|
"COURSE_AUDIT_LOG_QUERY_BY_COURSE" => { uri: ->(course_id:) { "audit/course/courses/#{course_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
215
216
|
"COURSE_AUDIT_LOG_QUERY_BY_ACCOUNT" => { uri: ->(account_id:) { "audit/course/accounts/#{account_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
216
217
|
"COURSE_QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS" => { uri: ->(course_id:) { "courses/#{course_id}/quiz_extensions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extra_attempts", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extra_time", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"manually_unlocked", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extend_from_now", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extend_from_end_at", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
217
|
-
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
218
|
-
"LIST_COURSES_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
218
|
+
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "grading_periods", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
219
|
+
"LIST_COURSES_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "grading_periods", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
220
|
+
"GET_USER_PROGRESS" => { uri: ->(course_id:, user_id:) { "courses/#{course_id}/users/#{user_id}/progress" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
219
221
|
"CREATE_NEW_COURSE" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enroll_me", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
220
222
|
"COURSES_UPLOAD_FILE" => { uri: ->(course_id:) { "courses/#{course_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
221
223
|
"LIST_STUDENTS" => { uri: ->(course_id:) { "courses/#{course_id}/students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -234,7 +236,7 @@ module LMS
|
|
234
236
|
"RETURN_TEST_STUDENT_FOR_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/student_view_student" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
235
237
|
"GET_SINGLE_COURSE_COURSES" => { uri: ->(id:) { "courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
236
238
|
"GET_SINGLE_COURSE_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
237
|
-
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_course_summary]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions]", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[use_blueprint_restrictions_by_object_type]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions_by_object_type]", "type"=>"multiple BlueprintRestrictions", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
239
|
+
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_course_summary]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions]", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[use_blueprint_restrictions_by_object_type]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions_by_object_type]", "type"=>"multiple BlueprintRestrictions", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[homeroom_course]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[template]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_color]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
238
240
|
"UPDATE_COURSES" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"event", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["offer", "conclude", "delete", "undelete"]}] },
|
239
241
|
"RESET_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/reset_content" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
240
242
|
"GET_EFFECTIVE_DUE_DATES" => { uri: ->(course_id:) { "courses/#{course_id}/effective_due_dates" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
@@ -269,6 +271,8 @@ module LMS
|
|
269
271
|
"GET_FULL_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/view" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
270
272
|
"POST_ENTRY_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
271
273
|
"POST_ENTRY_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/entries" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
274
|
+
"DUPLICATE_DISCUSSION_TOPIC_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
275
|
+
"DUPLICATE_DISCUSSION_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
272
276
|
"LIST_TOPIC_ENTRIES_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
273
277
|
"LIST_TOPIC_ENTRIES_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/entries" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
274
278
|
"POST_REPLY_COURSES" => { uri: ->(course_id:, topic_id:, entry_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries/#{entry_id}/replies" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"entry_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -325,6 +329,9 @@ module LMS
|
|
325
329
|
"EDIT_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:, external_tool_id:) { "accounts/#{account_id}/external_tools/#{external_tool_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
326
330
|
"DELETE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:, external_tool_id:) { "courses/#{course_id}/external_tools/#{external_tool_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
327
331
|
"DELETE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:, external_tool_id:) { "accounts/#{account_id}/external_tools/#{external_tool_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
332
|
+
"ADD_TOOL_TO_RCE_FAVORITES" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/external_tools/rce_favorites/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
333
|
+
"REMOVE_TOOL_FROM_RCE_FAVORITES" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/external_tools/rce_favorites/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
334
|
+
"GET_VISIBLE_COURSE_NAVIGATION_TOOLS" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools/visible_course_nav_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
328
335
|
"LIST_FAVORITE_COURSES" => { uri: ->() { "users/self/favorites/courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
329
336
|
"LIST_FAVORITE_GROUPS" => { uri: ->() { "users/self/favorites/groups" }, method: "GET", parameters: [] },
|
330
337
|
"ADD_COURSE_TO_FAVORITES" => { uri: ->(id:) { "users/self/favorites/courses/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -339,6 +346,7 @@ module LMS
|
|
339
346
|
"LIST_ENABLED_FEATURES_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
340
347
|
"LIST_ENABLED_FEATURES_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
341
348
|
"LIST_ENABLED_FEATURES_USERS" => { uri: ->(user_id:) { "users/#{user_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
349
|
+
"LIST_ENVIRONMENT_FEATURES" => { uri: ->() { "features/environment" }, method: "GET", parameters: [] },
|
342
350
|
"GET_FEATURE_FLAG_COURSES" => { uri: ->(course_id:, feature:) { "courses/#{course_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
343
351
|
"GET_FEATURE_FLAG_ACCOUNTS" => { uri: ->(account_id:, feature:) { "accounts/#{account_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
344
352
|
"GET_FEATURE_FLAG_USERS" => { uri: ->(user_id:, feature:) { "users/#{user_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -401,6 +409,7 @@ module LMS
|
|
401
409
|
"GRADE_CHANGE_LOG_QUERY_BY_COURSE" => { uri: ->(course_id:) { "audit/grade_change/courses/#{course_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
402
410
|
"QUERY_BY_STUDENT" => { uri: ->(student_id:) { "audit/grade_change/students/#{student_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"student_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
403
411
|
"QUERY_BY_GRADER" => { uri: ->(grader_id:) { "audit/grade_change/graders/#{grader_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"grader_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
412
|
+
"ADVANCED_QUERY" => { uri: ->() { "audit/grade_change" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"assignment_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"student_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grader_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
404
413
|
"DAYS_IN_GRADEBOOK_HISTORY_FOR_THIS_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/gradebook_history/days" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}] },
|
405
414
|
"DETAILS_FOR_GIVEN_DATE_IN_GRADEBOOK_HISTORY_FOR_THIS_COURSE" => { uri: ->(course_id:, date:) { "courses/#{course_id}/gradebook_history/#{date}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"date", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
406
415
|
"LISTS_SUBMISSIONS" => { uri: ->(course_id:, date:, grader_id:, assignment_id:) { "courses/#{course_id}/gradebook_history/#{date}/graders/#{grader_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"date", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"grader_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}] },
|
@@ -422,9 +431,11 @@ module LMS
|
|
422
431
|
"GET_SINGLE_GROUP_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
423
432
|
"CREATE_GROUP_CATEGORY_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/group_categories" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"self_signup", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["enabled", "restricted"]}, {"paramType"=>"form", "name"=>"auto_leader", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["first", "random"]}, {"paramType"=>"form", "name"=>"group_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sis_group_category_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"create_group_count", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"split_group_count", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
424
433
|
"CREATE_GROUP_CATEGORY_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/group_categories" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"self_signup", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["enabled", "restricted"]}, {"paramType"=>"form", "name"=>"auto_leader", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["first", "random"]}, {"paramType"=>"form", "name"=>"group_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sis_group_category_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"create_group_count", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"split_group_count", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
434
|
+
"IMPORT_CATEGORY_GROUPS" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}/import" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
425
435
|
"UPDATE_GROUP_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"self_signup", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["enabled", "restricted"]}, {"paramType"=>"form", "name"=>"auto_leader", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["first", "random"]}, {"paramType"=>"form", "name"=>"group_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sis_group_category_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"create_group_count", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"split_group_count", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
426
436
|
"DELETE_GROUP_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
427
437
|
"LIST_GROUPS_IN_GROUP_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}/groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
438
|
+
"EXPORT_GROUPS_IN_AND_USERS_IN_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}/export" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
428
439
|
"LIST_USERS_IN_GROUP_CATEGORY" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"unassigned", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
429
440
|
"ASSIGN_UNASSIGNED_MEMBERS" => { uri: ->(group_category_id:) { "group_categories/#{group_category_id}/assign_unassigned_members" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_category_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sync", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
430
441
|
"LIST_YOUR_GROUPS" => { uri: ->() { "users/self/groups" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["Account", "Course"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["tabs"], "items"=>{"type"=>"string"}}] },
|
@@ -450,6 +461,7 @@ module LMS
|
|
450
461
|
"UPDATE_MEMBERSHIP_USERS" => { uri: ->(group_id:, user_id:) { "groups/#{group_id}/users/#{user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"workflow_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["accepted"]}, {"paramType"=>"form", "name"=>"moderator", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
451
462
|
"LEAVE_GROUP_MEMBERSHIPS" => { uri: ->(group_id:, membership_id:) { "groups/#{group_id}/memberships/#{membership_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"membership_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
452
463
|
"LEAVE_GROUP_USERS" => { uri: ->(group_id:, user_id:) { "groups/#{group_id}/users/#{user_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
464
|
+
"LIST_RECENT_HISTORY_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/history" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
453
465
|
"FIND_IMAGES" => { uri: ->() { "image_search" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"query", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
454
466
|
"CONFIRM_IMAGE_SELECTION" => { uri: ->(id:) { "image_selection/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
455
467
|
"CREATE_JWT" => { uri: ->() { "jwts" }, method: "POST", parameters: [] },
|
@@ -475,6 +487,7 @@ module LMS
|
|
475
487
|
"UPDATE_MEDIA_TRACKS" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}/media_tracks" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
476
488
|
"LIST_MEDIA_OBJECTS_MEDIA_OBJECTS" => { uri: ->() { "media_objects" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["title", "created_at"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sources", "tracks"], "items"=>{"type"=>"string"}}] },
|
477
489
|
"LIST_MEDIA_OBJECTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/media_objects" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["title", "created_at"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sources", "tracks"], "items"=>{"type"=>"string"}}] },
|
490
|
+
"LIST_MEDIA_OBJECTS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/media_objects" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["title", "created_at"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sources", "tracks"], "items"=>{"type"=>"string"}}] },
|
478
491
|
"UPDATE_MEDIA_OBJECT" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_entered_title", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
479
492
|
"LIST_STUDENTS_SELECTED_FOR_MODERATION" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/moderated_students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
480
493
|
"SELECT_STUDENTS_FOR_MODERATION" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/moderated_students" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"student_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"number"}}] },
|
@@ -491,8 +504,8 @@ module LMS
|
|
491
504
|
"RE_LOCK_MODULE_PROGRESSIONS" => { uri: ->(course_id:, id:) { "courses/#{course_id}/modules/#{id}/relock" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
492
505
|
"LIST_MODULE_ITEMS" => { uri: ->(course_id:, module_id:) { "courses/#{course_id}/modules/#{module_id}/items" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["content_details"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"student_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
493
506
|
"SHOW_MODULE_ITEM" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["content_details"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"student_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
494
|
-
"CREATE_MODULE_ITEM" => { uri: ->(course_id:, module_id:) { "courses/#{course_id}/modules/#{module_id}/items" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["File", "Page", "Discussion", "Assignment", "Quiz", "SubHeader", "ExternalUrl", "ExternalTool"]}, {"paramType"=>"form", "name"=>"module_item[content_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[indent]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[page_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[external_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[new_tab]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["must_view", "must_contribute", "must_submit"]}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][min_score]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
495
|
-
"UPDATE_MODULE_ITEM" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[indent]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[external_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[new_tab]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["must_view", "must_contribute", "must_submit"]}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][min_score]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[module_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
507
|
+
"CREATE_MODULE_ITEM" => { uri: ->(course_id:, module_id:) { "courses/#{course_id}/modules/#{module_id}/items" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["File", "Page", "Discussion", "Assignment", "Quiz", "SubHeader", "ExternalUrl", "ExternalTool"]}, {"paramType"=>"form", "name"=>"module_item[content_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[indent]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[page_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[external_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[new_tab]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["must_view", "must_contribute", "must_submit", "must_mark_done"]}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][min_score]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
508
|
+
"UPDATE_MODULE_ITEM" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[indent]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[external_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[new_tab]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["must_view", "must_contribute", "must_submit", "must_mark_done"]}, {"paramType"=>"form", "name"=>"module_item[completion_requirement][min_score]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"module_item[module_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
496
509
|
"SELECT_MASTERY_PATH" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}/select_mastery_path" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment_set_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"student_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
497
510
|
"DELETE_MODULE_ITEM" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
498
511
|
"MARK_MODULE_ITEM_AS_DONE_NOT_DONE" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}/done" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -630,9 +643,12 @@ module LMS
|
|
630
643
|
"CREATE_SINGLE_POLL" => { uri: ->() { "polls" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"polls[question]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"polls[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
631
644
|
"UPDATE_SINGLE_POLL" => { uri: ->(id:) { "polls/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"polls[question]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"polls[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
632
645
|
"DELETE_POLL" => { uri: ->(id:) { "polls/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
633
|
-
"
|
634
|
-
"
|
646
|
+
"CREATE_UPDATE_PROFICIENCY_RATINGS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/outcome_proficiency" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"ratings[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"ratings[points]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[mastery]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[color]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
647
|
+
"CREATE_UPDATE_PROFICIENCY_RATINGS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/outcome_proficiency" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"ratings[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"ratings[points]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[mastery]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[color]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
648
|
+
"GET_PROFICIENCY_RATINGS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/outcome_proficiency" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
649
|
+
"GET_PROFICIENCY_RATINGS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/outcome_proficiency" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
635
650
|
"QUERY_PROGRESS" => { uri: ->(id:) { "progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
651
|
+
"PROGRESS_QUERY_PROGRESS" => { uri: ->(course_id:, id:) { "/lti/courses/#{course_id}/progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
636
652
|
"UPDATE_PUBLIC_JWK" => { uri: ->() { "/lti/developer_key/update_public_jwk" }, method: "PUT", parameters: [{"paramType"=>"form", "name"=>"public_jwk", "type"=>"json", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
637
653
|
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_CLASSIC_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
638
654
|
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_NEW_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/new_quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
@@ -658,6 +674,7 @@ module LMS
|
|
658
674
|
"QUIZ_SUBMISSION_FILES_UPLOAD_FILE" => { uri: ->(course_id:, quiz_id:) { "courses/#{course_id}/quizzes/#{quiz_id}/submissions/self/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"quiz_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"on_duplicate", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
659
675
|
"GET_ALL_QUIZ_SUBMISSION_QUESTIONS" => { uri: ->(quiz_submission_id:) { "quiz_submissions/#{quiz_submission_id}/questions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["quiz_question"], "items"=>{"type"=>"string"}}] },
|
660
676
|
"ANSWERING_QUESTIONS" => { uri: ->(quiz_submission_id:) { "quiz_submissions/#{quiz_submission_id}/questions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"quiz_questions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"QuizSubmissionQuestion"}}] },
|
677
|
+
"GET_FORMATTED_STUDENT_NUMERICAL_ANSWER" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/formatted_answer" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"answer", "type"=>"Numeric", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
661
678
|
"FLAGGING_QUESTION" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/flag" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
662
679
|
"UNFLAGGING_QUESTION" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/unflag" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
663
680
|
"SEND_MESSAGE_TO_UNSUBMITTED_OR_SUBMITTED_USERS_FOR_QUIZ" => { uri: ->(course_id:, id:) { "courses/#{course_id}/quizzes/#{id}/submission_users/message" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"conversations", "type"=>"QuizUserConversation", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -725,9 +742,11 @@ module LMS
|
|
725
742
|
"SHARE_BRANDCONFIG_THEME" => { uri: ->(account_id:) { "accounts/#{account_id}/shared_brand_configs" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_brand_config[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_brand_config[brand_config_md5]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
726
743
|
"UPDATE_SHARED_THEME" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/shared_brand_configs/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
727
744
|
"UN_SHARE_BRANDCONFIG_THEME" => { uri: ->(id:) { "shared_brand_configs/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
745
|
+
"EDIT_SUBMISSION_COMMENT" => { uri: ->(course_id:, assignment_id:, user_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
746
|
+
"DELETE_SUBMISSION_COMMENT" => { uri: ->(course_id:, assignment_id:, user_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
728
747
|
"SUBMISSION_COMMENTS_UPLOAD_FILE" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
729
|
-
"SUBMIT_ASSIGNMENT_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
730
|
-
"SUBMIT_ASSIGNMENT_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
748
|
+
"SUBMIT_ASSIGNMENT_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch", "student_annotation"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
749
|
+
"SUBMIT_ASSIGNMENT_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch", "student_annotation"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
731
750
|
"LIST_ASSIGNMENT_SUBMISSIONS_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
732
751
|
"LIST_ASSIGNMENT_SUBMISSIONS_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
733
752
|
"LIST_SUBMISSIONS_FOR_MULTIPLE_ASSIGNMENTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/students/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"student_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"submitted_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"graded_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submitted", "unsubmitted", "graded", "pending_review"]}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "concluded"]}, {"paramType"=>"query", "name"=>"state_based_on_date", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["id", "graded_at"]}, {"paramType"=>"query", "name"=>"order_direction", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ascending", "descending"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "total_scores", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
@@ -770,20 +789,20 @@ module LMS
|
|
770
789
|
"LIST_TODO_ITEMS" => { uri: ->() { "users/self/todo" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ungraded_quizzes"], "items"=>{"type"=>"string"}}] },
|
771
790
|
"LIST_COUNTS_FOR_TODO_ITEMS" => { uri: ->() { "users/self/todo_item_count" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ungraded_quizzes"], "items"=>{"type"=>"string"}}] },
|
772
791
|
"LIST_UPCOMING_ASSIGNMENTS_CALENDAR_EVENTS" => { uri: ->() { "users/self/upcoming_events" }, method: "GET", parameters: [] },
|
773
|
-
"LIST_MISSING_SUBMISSIONS" => { uri: ->(user_id:) { "users/#{user_id}/missing_submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["planner_overrides", "course"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submittable"], "items"=>{"type"=>"string"}}] },
|
792
|
+
"LIST_MISSING_SUBMISSIONS" => { uri: ->(user_id:) { "users/#{user_id}/missing_submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["planner_overrides", "course"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submittable"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"course_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
774
793
|
"HIDE_STREAM_ITEM" => { uri: ->(id:) { "users/self/activity_stream/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
775
794
|
"HIDE_ALL_STREAM_ITEMS" => { uri: ->() { "users/self/activity_stream" }, method: "DELETE", parameters: [] },
|
776
795
|
"USERS_UPLOAD_FILE" => { uri: ->(user_id:) { "users/#{user_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
777
796
|
"SHOW_USER_DETAILS" => { uri: ->(id:) { "users/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["uuid", "last_login"], "items"=>{"type"=>"string"}}] },
|
778
|
-
"CREATE_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/users" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[
|
779
|
-
"DEPRECATED_SELF_REGISTER_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/self_registration" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[
|
797
|
+
"CREATE_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/users" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[terms_of_use]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[skip_registration]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[send_confirmation]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[force_self_registration]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[confirmation_url]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[skip_confirmation]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"force_validations", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"destination", "type"=>"URL", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"initial_enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pairing_code[code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
798
|
+
"DEPRECATED_SELF_REGISTER_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/self_registration" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[terms_of_use]", "type"=>"boolean", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
780
799
|
"UPDATE_USER_SETTINGS" => { uri: ->(id:) { "users/#{id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"manual_mark_as_read", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"collapse_global_nav", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"hide_dashcard_color_overlays", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
781
800
|
"GET_CUSTOM_COLORS" => { uri: ->(id:) { "users/#{id}/colors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
782
801
|
"GET_CUSTOM_COLOR" => { uri: ->(id:, asset_string:) { "users/#{id}/colors/#{asset_string}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
783
802
|
"UPDATE_CUSTOM_COLOR" => { uri: ->(id:, asset_string:) { "users/#{id}/colors/#{asset_string}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hexcode", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
784
803
|
"GET_DASHBOARD_POSITIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
785
804
|
"UPDATE_DASHBOARD_POSITIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
786
|
-
"EDIT_USER" => { uri: ->(id:) { "users/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[email]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][token]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[bio]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
805
|
+
"EDIT_USER" => { uri: ->(id:) { "users/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[email]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][token]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[bio]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[pronouns]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
787
806
|
"MERGE_USER_INTO_ANOTHER_USER_DESTINATION_USER_ID" => { uri: ->(id:, destination_user_id:) { "users/#{id}/merge_into/#{destination_user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
788
807
|
"MERGE_USER_INTO_ANOTHER_USER_ACCOUNTS" => { uri: ->(id:, destination_account_id:, destination_user_id:) { "users/#{id}/merge_into/accounts/#{destination_account_id}/users/#{destination_user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
789
808
|
"SPLIT_MERGED_USERS_INTO_SEPARATE_USERS" => { uri: ->(id:) { "users/#{id}/split" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|