44724 lines
1020 KiB
JSON
44724 lines
1020 KiB
JSON
{
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "Canvas LMS API",
|
|
"description": "Auto-generated OpenAPI specification from Canvas LMS routes",
|
|
"version": "1.0.0",
|
|
"contact": {
|
|
"name": "Canvas LMS",
|
|
"url": "https://canvas.instructure.com/doc/api/"
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://canvas.gvmntbw.ddns.net",
|
|
"description": "Local Canvas instance"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"components": {
|
|
"securitySchemes": {
|
|
"bearerAuth": {
|
|
"type": "http",
|
|
"scheme": "bearer",
|
|
"description": "Canvas API access token"
|
|
}
|
|
}
|
|
},
|
|
"paths": {
|
|
"/api/graphql": {
|
|
"post": {
|
|
"tags": [
|
|
"graphql"
|
|
],
|
|
"summary": "POST /api/graphql",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/authorize": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/lti/accounts/{account_id}/authorize",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/data_services": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/data_services",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/lti/accounts/{account_id}/data_services",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/data_services/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/lti/accounts/{account_id}/data_services/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/data_services/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/lti/accounts/{account_id}/data_services/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/developer_keys/{developer_key_id}/tool_configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/developer_keys/{developer_key_id}/tool_configuration",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "developer_key_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/developer_keys/tool_configuration": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/lti/accounts/{account_id}/developer_keys/tool_configuration",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/dr_iframe": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/dr_iframe",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/event_types": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/event_types",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/external_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/lti/accounts/{account_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/external_tools/{external_tool_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/lti/accounts/{account_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/feature_flags/{feature}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/feature_flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/jwt_token": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/jwt_token",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/lti_registrations/uuid/{registration_uuid}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/lti_registrations/uuid/{registration_uuid}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_uuid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/lti_registration_update_request/uuid/{registration_uuid}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/lti_registration_update_request/uuid/{registration_uuid}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_uuid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/registrations/{registration_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/registrations/{registration_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/registrations/{registration_id}/overlay": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/lti/accounts/{account_id}/registrations/{registration_id}/overlay",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/registrations/{registration_id}/view": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/registrations/{registration_id}/view",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/registrations/uuid/{registration_uuid}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/registrations/uuid/{registration_uuid}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_uuid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/registration_token": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/registration_token",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/tool_consumer_profile(/{tool_consumer_profile_id})": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/lti/accounts/{account_id}/tool_consumer_profile(/{tool_consumer_profile_id})",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_consumer_profile_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/accounts/{account_id}/tool_proxy": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/lti/accounts/{account_id}/tool_proxy",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/advantage_token": {
|
|
"get": {
|
|
"tags": [
|
|
"advantage_token"
|
|
],
|
|
"summary": "GET /api/lti/advantage_token",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processor_eulas/{context_external_tool_id}/deployment": {
|
|
"put": {
|
|
"tags": [
|
|
"asset_processor_eulas"
|
|
],
|
|
"summary": "PUT /api/lti/asset_processor_eulas/{context_external_tool_id}/deployment",
|
|
"parameters": [
|
|
{
|
|
"name": "context_external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processor_eulas/{context_external_tool_id}/user": {
|
|
"delete": {
|
|
"tags": [
|
|
"asset_processor_eulas"
|
|
],
|
|
"summary": "DELETE /api/lti/asset_processor_eulas/{context_external_tool_id}/user",
|
|
"parameters": [
|
|
{
|
|
"name": "context_external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"asset_processor_eulas"
|
|
],
|
|
"summary": "POST /api/lti/asset_processor_eulas/{context_external_tool_id}/user",
|
|
"parameters": [
|
|
{
|
|
"name": "context_external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processors/{asset_processor_id}/assets/{asset_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"asset_processors"
|
|
],
|
|
"summary": "GET /api/lti/asset_processors/{asset_processor_id}/assets/{asset_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "asset_processor_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "asset_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processors/{asset_processor_id}/notices/{student_id}/attempts/{attempt}": {
|
|
"post": {
|
|
"tags": [
|
|
"asset_processors"
|
|
],
|
|
"summary": "POST /api/lti/asset_processors/{asset_processor_id}/notices/{student_id}/attempts/{attempt}",
|
|
"parameters": [
|
|
{
|
|
"name": "asset_processor_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "attempt",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processors/{asset_processor_id}/reports": {
|
|
"post": {
|
|
"tags": [
|
|
"asset_processors"
|
|
],
|
|
"summary": "POST /api/lti/asset_processors/{asset_processor_id}/reports",
|
|
"parameters": [
|
|
{
|
|
"name": "asset_processor_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/asset_processors/discussion_notices/{assignment_id}/{student_id}/resubmit_all": {
|
|
"post": {
|
|
"tags": [
|
|
"asset_processors"
|
|
],
|
|
"summary": "POST /api/lti/asset_processors/discussion_notices/{assignment_id}/{student_id}/resubmit_all",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/files/{file_id}/originality_report": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}/files/{file_id}/originality_report",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "file_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "PUT /api/lti/assignments/{assignment_id}/files/{file_id}/originality_report",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "file_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/submissions/{submission_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}/submissions/{submission_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/submissions/{submission_id}/attachment/{attachment_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}/submissions/{submission_id}/attachment/{attachment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/submissions/{submission_id}/history": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}/submissions/{submission_id}/history",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report": {
|
|
"post": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "POST /api/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "GET /api/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"assignments"
|
|
],
|
|
"summary": "PUT /api/lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/authorize": {
|
|
"get": {
|
|
"tags": [
|
|
"authorize"
|
|
],
|
|
"summary": "GET /api/lti/authorize",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/authorize_redirect": {
|
|
"get": {
|
|
"tags": [
|
|
"authorize_redirect"
|
|
],
|
|
"summary": "GET /api/lti/authorize_redirect",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"authorize_redirect"
|
|
],
|
|
"summary": "POST /api/lti/authorize_redirect",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/authorize": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/lti/courses/{course_id}/authorize",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/developer_keys/{developer_key_id}/tool_configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/developer_keys/{developer_key_id}/tool_configuration",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "developer_key_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/feature_flags/{feature}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/feature_flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/jwt_token": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/jwt_token",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/line_items": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/line_items",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/lti/courses/{course_id}/line_items",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/line_items/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/lti/courses/{course_id}/line_items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/line_items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/lti/courses/{course_id}/line_items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/line_items/{line_item_id}/results": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/line_items/{line_item_id}/results",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "line_item_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/line_items/{line_item_id}/results/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/line_items/{line_item_id}/results/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "line_item_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/line_items/{line_item_id}/scores": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/lti/courses/{course_id}/line_items/{line_item_id}/scores",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "line_item_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/membership_service": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/membership_service",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/names_and_roles": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/names_and_roles",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/progress/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/progress/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/tool_consumer_profile(/{tool_consumer_profile_id})": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/lti/courses/{course_id}/tool_consumer_profile(/{tool_consumer_profile_id})",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_consumer_profile_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/courses/{course_id}/tool_proxy": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/lti/courses/{course_id}/tool_proxy",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/developer_keys/{developer_key_id}/tool_configuration": {
|
|
"delete": {
|
|
"tags": [
|
|
"developer_keys"
|
|
],
|
|
"summary": "DELETE /api/lti/developer_keys/{developer_key_id}/tool_configuration",
|
|
"parameters": [
|
|
{
|
|
"name": "developer_key_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"developer_keys"
|
|
],
|
|
"summary": "PUT /api/lti/developer_keys/{developer_key_id}/tool_configuration",
|
|
"parameters": [
|
|
{
|
|
"name": "developer_key_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/developer_key/update_public_jwk": {
|
|
"put": {
|
|
"tags": [
|
|
"developer_key"
|
|
],
|
|
"summary": "PUT /api/lti/developer_key/update_public_jwk",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/groups/{group_id}/membership_service": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/lti/groups/{group_id}/membership_service",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/groups/{group_id}/names_and_roles": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/lti/groups/{group_id}/names_and_roles",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/groups/{group_id}/users": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/lti/groups/{group_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/lti_2_token": {
|
|
"get": {
|
|
"tags": [
|
|
"lti_2_token"
|
|
],
|
|
"summary": "GET /api/lti/lti_2_token",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/notice-handlers/{context_external_tool_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"notice-handlers"
|
|
],
|
|
"summary": "GET /api/lti/notice-handlers/{context_external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "context_external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"notice-handlers"
|
|
],
|
|
"summary": "PUT /api/lti/notice-handlers/{context_external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "context_external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/registrations": {
|
|
"post": {
|
|
"tags": [
|
|
"registrations"
|
|
],
|
|
"summary": "POST /api/lti/registrations",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/registrations/{registration_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"registrations"
|
|
],
|
|
"summary": "GET /api/lti/registrations/{registration_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"registrations"
|
|
],
|
|
"summary": "PUT /api/lti/registrations/{registration_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/security/jwks": {
|
|
"get": {
|
|
"tags": [
|
|
"security"
|
|
],
|
|
"summary": "GET /api/lti/security/jwks",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/security/openid-configuration": {
|
|
"get": {
|
|
"tags": [
|
|
"security"
|
|
],
|
|
"summary": "GET /api/lti/security/openid-configuration",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/subscriptions": {
|
|
"get": {
|
|
"tags": [
|
|
"subscriptions"
|
|
],
|
|
"summary": "GET /api/lti/subscriptions",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"subscriptions"
|
|
],
|
|
"summary": "POST /api/lti/subscriptions",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/subscriptions/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"subscriptions"
|
|
],
|
|
"summary": "DELETE /api/lti/subscriptions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"subscriptions"
|
|
],
|
|
"summary": "GET /api/lti/subscriptions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"subscriptions"
|
|
],
|
|
"summary": "PUT /api/lti/subscriptions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/resource_link_id/{resource_link_id}/tool_setting": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/resource_link_id/{resource_link_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "resource_link_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "PUT /api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/resource_link_id/{resource_link_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "resource_link_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/tool_setting": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "PUT /api/lti/tool_proxy/{tool_proxy_guid}/accounts/{account_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/resource_link_id/{resource_link_id}/tool_setting": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/resource_link_id/{resource_link_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "resource_link_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "PUT /api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/resource_link_id/{resource_link_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "resource_link_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/tool_setting": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "PUT /api/lti/tool_proxy/{tool_proxy_guid}/courses/{course_id}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_proxy/{tool_proxy_guid}/tool_setting": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "GET /api/lti/tool_proxy/{tool_proxy_guid}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_proxy"
|
|
],
|
|
"summary": "PUT /api/lti/tool_proxy/{tool_proxy_guid}/tool_setting",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_proxy_guid",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/tool_settings/{tool_setting_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"tool_settings"
|
|
],
|
|
"summary": "GET /api/lti/tool_settings/{tool_setting_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_setting_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"tool_settings"
|
|
],
|
|
"summary": "PUT /api/lti/tool_settings/{tool_setting_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_setting_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/users/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/lti/users/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/caliper/{token}": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/caliper/{token}",
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/logout_service/{token}": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/logout_service/{token}",
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/tools/{tool_id}/ext_grade_passback": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/tools/{tool_id}/ext_grade_passback",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/tools/{tool_id}/grade_passback": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/tools/{tool_id}/grade_passback",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/turnitin/outcomes_placement/{tool_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/turnitin/outcomes_placement/{tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/lti/v1/xapi/{token}": {
|
|
"post": {
|
|
"tags": [
|
|
"v1"
|
|
],
|
|
"summary": "POST /api/lti/v1/xapi/{token}",
|
|
"parameters": [
|
|
{
|
|
"name": "token",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/sis/accounts/{account_id}/assignments": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/sis/accounts/{account_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/sis/courses/{course_id}/assignments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/sis/courses/{course_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/sis/courses/{course_id}/disable_post_to_sis": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/sis/courses/{course_id}/disable_post_to_sis",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/acceptable_use_policy": {
|
|
"get": {
|
|
"tags": [
|
|
"acceptable_use_policy"
|
|
],
|
|
"summary": "GET /api/v1/acceptable_use_policy",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/account_calendars": {
|
|
"get": {
|
|
"tags": [
|
|
"account_calendars"
|
|
],
|
|
"summary": "GET /api/v1/account_calendars",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/account_calendars/{account_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"account_calendars"
|
|
],
|
|
"summary": "GET /api/v1/account_calendars/{account_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"account_calendars"
|
|
],
|
|
"summary": "PUT /api/v1/account_calendars/{account_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/accessibility_issue_summary": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/accessibility_issue_summary",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/account_calendars": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/account_calendars",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/account_calendars",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/account_notifications": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/account_notifications",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/account_notifications",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/account_notifications/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/account_notifications/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/account_notifications/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/account_notifications/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/admins": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/admins",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/admins",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/admins/self": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/admins/self",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/admins/{user_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/admins/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/app_center/apps": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/app_center/apps",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/app_center/apps/{app_id}/reviews": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/app_center/apps/{app_id}/reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/app_center/apps/{app_id}/reviews/self": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/app_center/apps/{app_id}/reviews/self",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/app_center/apps/{app_id}/reviews/self",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/asset_processors/tii_migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/asset_processors/tii_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/asset_processors/tii_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/asset_processors/tii_migrations/migrate_all": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/asset_processors/tii_migrations/migrate_all",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/authentication_providers": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/authentication_providers",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/authentication_providers",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/authentication_providers/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/authentication_providers/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/authentication_providers/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/authentication_providers/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/authentication_providers/{id}/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/authentication_providers/{id}/restore",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/blackout_dates": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/blackout_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/blackout_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/blackout_dates/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/blackout_dates/new": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/blackout_dates/new",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/bounced_communication_channels": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/bounced_communication_channels",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/bounced_communication_channels.csv": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/bounced_communication_channels.csv",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/bounced_communication_channels/reset": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/bounced_communication_channels/reset",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/brand_variables": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/brand_variables",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/bulk_enrollment": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/bulk_enrollment",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations/{id}/selective_data": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations/{id}/selective_data",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/content_migrations/migrators": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/content_migrations/migrators",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/courses": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/courses",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/courses",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/courses",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/courses/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/create_tool_with_verification": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/create_tool_with_verification",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/csp_settings": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/csp_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/csp_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/csp_settings/domains": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/csp_settings/domains",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/csp_settings/domains",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/csp_settings/domains/batch_create": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/csp_settings/domains/batch_create",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/csp_settings/lock": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/csp_settings/lock",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/developer_keys": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/developer_keys",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/developer_keys",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "developer_key_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/developer_keys/lookup_utids": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/developer_keys/lookup_utids",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/enrollments/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/enrollments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools/{external_tool_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools/{external_tool_id}/migration_info": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/external_tools/{external_tool_id}/migration_info",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools/rce_favorites/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/external_tools/rce_favorites/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/external_tools/rce_favorites/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools/sessionless_launch": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/external_tools/sessionless_launch",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/external_tools/top_nav_favorites/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/external_tools/top_nav_favorites/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/external_tools/top_nav_favorites/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/features": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/features",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/features/early_access_program": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/features/early_access_program",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/features/enabled": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/features/enabled",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/features/flags/{feature}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/folders": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_periods": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/grading_periods",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_period_sets": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/grading_period_sets",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/grading_period_sets",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_period_sets/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/grading_period_sets/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PATCH /api/v1/accounts/{account_id}/grading_period_sets/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_periods/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/grading_periods/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_standards": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/grading_standards",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/grading_standards",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/group_categories": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/group_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/group_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/help_links": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/help_links",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/custom_filters": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/custom_filters",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/filters": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/filters",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/organizations/{organization_salesforce_id}/products": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/organizations/{organization_salesforce_id}/products",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "organization_salesforce_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/products": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/products",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/products_categories": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/products_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/learn_platform/products/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/learn_platform/products/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/logins": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/logins",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/logins",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/logins/{id}": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/logins/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_apps": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_apps",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_apps/launch_definitions": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_apps/launch_definitions",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registration_by_client_id/{client_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registration_by_client_id/{client_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "client_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/lti_registrations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/configuration/validate": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/lti_registrations/configuration/validate",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/lti_registrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/lti_registrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/bind": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/lti_registrations/{id}/bind",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/history": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{id}/history",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/overlay_history": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{id}/overlay_history",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/reset": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/lti_registrations/{id}/reset",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_request_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}/apply": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}/apply",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_request_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/bulk": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/bulk",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{deployment_id}/context_search": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{deployment_id}/context_search",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "deployment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{id}/controls": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{id}/controls",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_group_links": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_group_links",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/account_chain": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups/account_chain",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/available_outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups/{id}/available_outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/batch": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_groups/{id}/batch",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/import": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_groups/{id}/import",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_groups/{id}/subgroups": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_imports(/group/{learning_outcome_group_id})": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_imports(/group/{learning_outcome_group_id})",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "learning_outcome_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_imports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_imports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_imports/{id}/created_group_ids": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_imports/{id}/created_group_ids",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/outcome_proficiency": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/outcome_proficiency",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/outcome_proficiency",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/permissions",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/permissions/{permission}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/permissions/{permission}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "permission",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/quiz_ip_filters": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/quiz_ip_filters",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/reports": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/reports",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/reports/{report}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/reports/{report}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/reports/{report}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/reports/{report}/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/reports/{report}/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/reports/{report}/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/reports/{report}/{id}/abort": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/reports/{report}/{id}/abort",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/roles": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/roles",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/roles",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/roles/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/roles/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/roles/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/roles/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/roles/{id}/activate": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/roles/{id}/activate",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/roles/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/roles/permissions",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/root_outcome_group": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/root_outcome_group",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/download_rubrics": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/rubrics/download_rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/rubrics/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/{id}/used_locations": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/rubrics/{id}/used_locations",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/upload": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/rubrics/upload",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/upload/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/rubrics/upload/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/rubrics/upload/{id}/rubrics": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/rubrics/upload/{id}/rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/scopes": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/scopes",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/self_registration": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/self_registration",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/settings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/shared_brand_configs": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/shared_brand_configs",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/shared_brand_configs/{id}": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/shared_brand_configs/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_import_errors": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sis_import_errors",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sis_imports",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/sis_imports",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/abort_all_pending": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/sis_imports/abort_all_pending",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sis_imports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/{id}/abort": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/sis_imports/{id}/abort",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/{id}/errors": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sis_imports/{id}/errors",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/{id}/restore_states": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/sis_imports/{id}/restore_states",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sis_imports/importing": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sis_imports/importing",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sso_settings": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sso_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/sso_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sub_accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/sub_accounts",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/sub_accounts",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/sub_accounts/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/sub_accounts/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/tabs": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/tabs",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/temporary_enrollment_pairings": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/temporary_enrollment_pairings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/temporary_enrollment_pairings",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/temporary_enrollment_pairings/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/temporary_enrollment_pairings/new": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/temporary_enrollment_pairings/new",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/terms": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/terms",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/terms",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/terms/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/terms/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/terms/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/terms/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/terms_of_service": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/terms_of_service",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}/update": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}/update",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/tool_proxies/{tool_proxy_id}/update",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/unconfirmed_communication_channels": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/unconfirmed_communication_channels",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/unconfirmed_communication_channels/confirm": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/unconfirmed_communication_channels/confirm",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/unconfirmed_communication_channels.csv": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/unconfirmed_communication_channels.csv",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{account_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users/bulk_update": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/users/bulk_update",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users/{user_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/users/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users/{user_id}/account_notifications": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/users/{user_id}/account_notifications",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users/{user_id}/account_notifications/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "DELETE /api/v1/accounts/{account_id}/users/{user_id}/account_notifications/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/users/{user_id}/account_notifications/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/users/{user_id}/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{account_id}/users/{user_id}/restore",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{account_id}/visible_calendars_count": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{account_id}/visible_calendars_count",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{current_account_id}/lti_registrations/{registration_id}/controls": {
|
|
"post": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "POST /api/v1/accounts/{current_account_id}/lti_registrations/{registration_id}/controls",
|
|
"parameters": [
|
|
{
|
|
"name": "current_account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "registration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/accounts/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "GET /api/v1/accounts/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"accounts"
|
|
],
|
|
"summary": "PUT /api/v1/accounts/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/announcements": {
|
|
"get": {
|
|
"tags": [
|
|
"announcements"
|
|
],
|
|
"summary": "GET /api/v1/announcements",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/appointment_groups": {
|
|
"get": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "GET /api/v1/appointment_groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "POST /api/v1/appointment_groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/appointment_groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "DELETE /api/v1/appointment_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "GET /api/v1/appointment_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "PUT /api/v1/appointment_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/appointment_groups/{id}/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "GET /api/v1/appointment_groups/{id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/appointment_groups/{id}/users": {
|
|
"get": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "GET /api/v1/appointment_groups/{id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/appointment_groups/next_appointment": {
|
|
"get": {
|
|
"tags": [
|
|
"appointment_groups"
|
|
],
|
|
"summary": "GET /api/v1/appointment_groups/next_appointment",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/authentication/accounts/{account_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/authentication/accounts/{account_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/authentication/logins/{login_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/authentication/logins/{login_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "login_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/authentication/users/{user_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/authentication/users/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/course/accounts/{account_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/course/accounts/{account_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/course/courses/{course_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/course/courses/{course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/assignments/{assignment_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/assignments/{assignment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/graders/{grader_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/graders/{grader_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/graders/{grader_id}/students/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/graders/{grader_id}/students/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/students/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/assignments/{assignment_id}/students/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/graders/{grader_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/graders/{grader_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/graders/{grader_id}/students/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/graders/{grader_id}/students/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/courses/{course_id}/students/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/courses/{course_id}/students/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/graders/{grader_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/graders/{grader_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/audit/grade_change/students/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"audit"
|
|
],
|
|
"summary": "GET /api/v1/audit/grade_change/students/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/brand_variables": {
|
|
"get": {
|
|
"tags": [
|
|
"brand_variables"
|
|
],
|
|
"summary": "GET /api/v1/brand_variables",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events": {
|
|
"get": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "GET /api/v1/calendar_events",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "POST /api/v1/calendar_events",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "DELETE /api/v1/calendar_events/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "GET /api/v1/calendar_events/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "PUT /api/v1/calendar_events/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/{id}/participants": {
|
|
"get": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "GET /api/v1/calendar_events/{id}/participants",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/{id}/reservations": {
|
|
"post": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "POST /api/v1/calendar_events/{id}/reservations",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/{id}/reservations/{participant_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "POST /api/v1/calendar_events/{id}/reservations/{participant_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "participant_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/save_enabled_account_calendars": {
|
|
"post": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "POST /api/v1/calendar_events/save_enabled_account_calendars",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/save_selected_contexts": {
|
|
"post": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "POST /api/v1/calendar_events/save_selected_contexts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/calendar_events/visible_contexts": {
|
|
"get": {
|
|
"tags": [
|
|
"calendar_events"
|
|
],
|
|
"summary": "GET /api/v1/calendar_events/visible_contexts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/canvadoc_session": {
|
|
"get": {
|
|
"tags": [
|
|
"canvadoc_session"
|
|
],
|
|
"summary": "GET /api/v1/canvadoc_session",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"canvadoc_session"
|
|
],
|
|
"summary": "POST /api/v1/canvadoc_session",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/career/enabled": {
|
|
"get": {
|
|
"tags": [
|
|
"career"
|
|
],
|
|
"summary": "GET /api/v1/career/enabled",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/career/experience_summary": {
|
|
"get": {
|
|
"tags": [
|
|
"career"
|
|
],
|
|
"summary": "GET /api/v1/career/experience_summary",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/career/switch_experience": {
|
|
"post": {
|
|
"tags": [
|
|
"career"
|
|
],
|
|
"summary": "POST /api/v1/career/switch_experience",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/career/switch_role": {
|
|
"post": {
|
|
"tags": [
|
|
"career"
|
|
],
|
|
"summary": "POST /api/v1/career/switch_role",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/collaborations/{id}/members": {
|
|
"get": {
|
|
"tags": [
|
|
"collaborations"
|
|
],
|
|
"summary": "GET /api/v1/collaborations/{id}/members",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/comm_messages": {
|
|
"get": {
|
|
"tags": [
|
|
"comm_messages"
|
|
],
|
|
"summary": "GET /api/v1/comm_messages",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conferences": {
|
|
"get": {
|
|
"tags": [
|
|
"conferences"
|
|
],
|
|
"summary": "GET /api/v1/conferences",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations": {
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "POST /api/v1/conversations",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "PUT /api/v1/conversations",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/batches": {
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations/batches",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/deleted": {
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations/deleted",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/find_recipients": {
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations/find_recipients",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "DELETE /api/v1/conversations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "PUT /api/v1/conversations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/{id}/add_message": {
|
|
"post": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "POST /api/v1/conversations/{id}/add_message",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/{id}/add_recipients": {
|
|
"post": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "POST /api/v1/conversations/{id}/add_recipients",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/{id}/delete_for_all": {
|
|
"delete": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "DELETE /api/v1/conversations/{id}/delete_for_all",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/{id}/remove_messages": {
|
|
"post": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "POST /api/v1/conversations/{id}/remove_messages",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/mark_all_as_read": {
|
|
"post": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "POST /api/v1/conversations/mark_all_as_read",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "PUT /api/v1/conversations/restore",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/conversations/unread_count": {
|
|
"get": {
|
|
"tags": [
|
|
"conversations"
|
|
],
|
|
"summary": "GET /api/v1/conversations/unread_count",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/course_accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"course_accounts"
|
|
],
|
|
"summary": "GET /api/v1/course_accounts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/course_creation_accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"course_creation_accounts"
|
|
],
|
|
"summary": "GET /api/v1/course_creation_accounts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/activity_stream": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/activity_stream",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/activity_stream/summary": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/activity_stream/summary",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/ai_experiences",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "ai_experience_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/ai_experiences/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/ai_experiences/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "conversation_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/{id}/edit": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/{id}/edit",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ai_experiences/new": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/ai_experiences/new",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/all_quizzes": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/all_quizzes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/announcements/{announcement_id}/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/announcements/{announcement_id}/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "announcement_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/announcements/{announcement_id}/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/announcements/{announcement_id}/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "announcement_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/app_center/apps": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/app_center/apps",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/app_center/apps/{app_id}/reviews": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/app_center/apps/{app_id}/reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/app_center/apps/{app_id}/reviews/self": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/app_center/apps/{app_id}/reviews/self",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/app_center/apps/{app_id}/reviews/self",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "app_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/apply_score_to_ungraded_submissions": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/apply_score_to_ungraded_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignment_groups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignment_groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignment_groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}/assignments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignment_groups/{assignment_group_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/allocate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/allocate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_provisional_grades/status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_provisional_grades/status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "anonymous_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "anonymous_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/check_allocation_conversion": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/check_allocation_conversion",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/convert_peer_review_allocations": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/convert_peer_review_allocations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/convert_peer_review_allocations/status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/convert_peer_review_allocations/status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/date_details/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/date_details/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/extensions": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/extensions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/gradeable_students": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/gradeable_students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/moderated_students": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/moderated_students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/moderated_students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/peer_reviews": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/bulk_select": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/bulk_select",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/{provisional_grade_id}/select": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/{provisional_grade_id}/select",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "provisional_grade_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publish": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publish",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/retry_alignment_clone": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/retry_alignment_clone",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submission_summary": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submission_summary",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/update_grades": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/update_grades",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/files": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "item",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{assignment_id}/users/{user_id}/group_members": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{assignment_id}/users/{user_id}/group_members",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/bulk_update": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/bulk_update",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/gradeable_students": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/gradeable_students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/assignments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assignments/overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/assignments/overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assignments/overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/assignments/overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/assign_outcome_order": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/assign_outcome_order",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blackout_dates": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blackout_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/blackout_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/blackout_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blackout_dates/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/blackout_dates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blackout_dates/new": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blackout_dates/new",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/block_editor_templates": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/block_editor_templates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/block_editor_templates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/block_editor_templates/can_edit": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/block_editor_templates/can_edit",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/block_editor_templates/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/block_editor_templates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/block_editor_templates/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/block_editor_templates/{id}/publish": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/block_editor_templates/{id}/publish",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_subscriptions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_subscriptions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "subscription_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "subscription_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}/details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}/details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "subscription_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/associated_courses": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}/associated_courses",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}/details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}/details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/restrict_item": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/blueprint_templates/{template_id}/restrict_item",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/unsynced_changes": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/blueprint_templates/{template_id}/unsynced_changes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/blueprint_templates/{template_id}/update_associations": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/blueprint_templates/{template_id}/update_associations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "template_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/brand_variables": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/brand_variables",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/bulk_student_enrollments/student_bulk_pace_edit_view": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/bulk_student_enrollments/student_bulk_pace_edit_view",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/bulk_user_progress": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/bulk_user_progress",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/bulk_user_tags": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/bulk_user_tags",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/calendar_events/timetable": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/calendar_events/timetable",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/calendar_events/timetable",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/calendar_events/timetable_events": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/calendar_events/timetable_events",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/collaborations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/collaborations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/collaborations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/collaborations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/conferences": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/conferences",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/conferences",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/conferences/{conference_id}/recording_ready": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/conferences/{conference_id}/recording_ready",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "conference_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_exports": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_exports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/content_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_exports/{id}/fail": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/content_exports/{id}/fail",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_licenses": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_licenses",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_list": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_list",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/{id}/asset_id_mapping": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/{id}/asset_id_mapping",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/{id}/selective_data": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/{id}/selective_data",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_migrations/migrators": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_migrations/migrators",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/content_share_users": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/content_share_users",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/convert_tag_overrides/status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/convert_tag_overrides/status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_copy": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/course_copy",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_copy/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/course_copy/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/course_pacing",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing/bulk_create_enrollment_paces": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/course_pacing/bulk_create_enrollment_paces",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing/compress_dates": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/course_pacing/compress_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/course_pacing/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/course_pacing/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/course_pacing/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing/{id}/publish": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/course_pacing/{id}/publish",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/course_pacing/new": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/course_pacing/new",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/create_tool_with_verification": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/create_tool_with_verification",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/csp_settings": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/csp_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/csp_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_column_data": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/custom_gradebook_column_data",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_columns": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/custom_gradebook_columns",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/custom_gradebook_columns",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_columns/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/custom_gradebook_columns/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/custom_gradebook_columns/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_columns/{id}/data": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/custom_gradebook_columns/{id}/data",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_columns/{id}/data/{user_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/custom_gradebook_columns/{id}/data/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/custom_gradebook_columns/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/custom_gradebook_columns/reorder",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "discussion_topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "discussion_topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "discussion_topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/migrate_disallow": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/migrate_disallow",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/read_all": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/reorder",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/entry_list": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/entry_list",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights/entries": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights/entries/{entry_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/insights/entries/{entry_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/messageable_users": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/messageable_users",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/read_all": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/disable": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/disable",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "summary_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/{topic_id}/view": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/discussion_topics/{topic_id}/view",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/discussion_topics/update_discussion_types": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/discussion_topics/update_discussion_types",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/effective_due_dates": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/effective_due_dates",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/enrollments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/enrollments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/enrollments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/enrollments/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/enrollments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/enrollments/{id}/accept": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/enrollments/{id}/accept",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/enrollments/{id}/reactivate": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/enrollments/{id}/reactivate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/enrollments/{id}/reject": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/enrollments/{id}/reject",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/epub_exports": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/epub_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/epub_exports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/epub_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_feeds": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_feeds",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/external_feeds",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_feeds/{external_feed_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/external_feeds/{external_feed_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_feed_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_tools/{external_tool_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/external_tools/{external_tool_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_tools/{external_tool_id}/migration_info": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_tools/{external_tool_id}/migration_info",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_tool_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_tools/sessionless_launch": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_tools/sessionless_launch",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/external_tools/visible_course_nav_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/external_tools/visible_course_nav_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/features": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/features",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/features/enabled": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/features/enabled",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/features/flags/{feature}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/files/{attachment_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/files/{attachment_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/files/{attachment_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/files/file_ref/{migration_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/files/file_ref/{migration_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/files/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/files/quota": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/files/quota",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders_and_files": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders_and_files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders/by_path": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders/by_path",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders/by_path/*full_path": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders/by_path/*full_path",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders/icon_maker": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders/icon_maker",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/folders/media": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/folders/media",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/front_page": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/front_page",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/front_page",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_filters": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_filters",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/gradebook_filters",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_filters/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/gradebook_filters/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_filters/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/gradebook_filters/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_history/{date}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_history/{date}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "date",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "date",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grader_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_history/days": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_history/days",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_history/feed": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/gradebook_history/feed",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/gradebook_settings": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/gradebook_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/grading_periods": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/grading_periods",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/grading_periods/batch_update": {
|
|
"patch": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PATCH /api/v1/courses/{course_id}/grading_periods/batch_update",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/grading_periods/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/grading_periods/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/grading_periods/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/grading_periods/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/grading_standards": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/grading_standards",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/grading_standards",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/grading_standards/{grading_standard_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/grading_standards/{grading_standard_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "grading_standard_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/group_categories": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/group_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/group_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/group_categories/bulk_manage_differentiation_tag": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/group_categories/bulk_manage_differentiation_tag",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/group_categories/export_tags": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/group_categories/export_tags",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/group_categories/import_tags": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/group_categories/import_tags",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/learning_mastery_gradebook_settings": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/learning_mastery_gradebook_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/learning_mastery_gradebook_settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/link_validation": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/link_validation",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/link_validation",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/live_assessments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/live_assessments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/live_assessments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/live_assessments/{assessment_id}/results": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/live_assessments/{assessment_id}/results",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assessment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/live_assessments/{assessment_id}/results",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assessment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/lti_apps": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/lti_apps",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/lti_apps/launch_definitions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/lti_apps/launch_definitions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/lti_resource_links": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/lti_resource_links",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/lti_resource_links",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/lti_resource_links/bulk": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/lti_resource_links/bulk",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/lti_resource_links/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/lti_resource_links/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/lti_resource_links/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/lti_resource_links/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/mastery_paths/rules": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/mastery_paths/rules",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/mastery_paths/rules",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/mastery_paths/rules/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/mastery_paths/rules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/mastery_paths/rules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/mastery_paths/rules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/mastery_paths/stats/student_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/mastery_paths/stats/student_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/mastery_paths/stats/students_per_range": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/mastery_paths/stats/students_per_range",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/media_attachments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/media_attachments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/media_objects": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/media_objects",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/microsoft_sync/group": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/microsoft_sync/group",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/microsoft_sync/group",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/microsoft_sync/group",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/microsoft_sync/schedule_sync": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/microsoft_sync/schedule_sync",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/module_item_redirect/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/module_item_redirect/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/module_item_sequence": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/module_item_sequence",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "context_module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "context_module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "context_module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{context_module_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules/{context_module_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "context_module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/modules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{id}/relock": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{id}/relock",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/items/{id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules/items/{id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules/{module_id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/items": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules/{module_id}/items",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules/{module_id}/items",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/items/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/modules/{module_id}/items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/modules/{module_id}/items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{module_id}/items/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/items/{id}/done": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/modules/{module_id}/items/{id}/done",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/modules/{module_id}/items/{id}/done",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/items/{id}/mark_read": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules/{module_id}/items/{id}/mark_read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/modules/{module_id}/items/{id}/select_mastery_path": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/modules/{module_id}/items/{id}/select_mastery_path",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/new_quizzes/assignment_overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/new_quizzes/assignment_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_alignments": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_alignments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_group_links": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_group_links",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/account_chain": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups/account_chain",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/available_outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups/{id}/available_outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/batch": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_groups/{id}/batch",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/import": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_groups/{id}/import",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_groups/{id}/subgroups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_imports(/group/{learning_outcome_group_id})": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_imports(/group/{learning_outcome_group_id})",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "learning_outcome_group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_imports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_imports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_imports/{id}/created_group_ids": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_imports/{id}/created_group_ids",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_mastery_distribution": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_mastery_distribution",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_proficiency": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_proficiency",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/outcome_proficiency",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_results": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_results",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcome_rollups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcome_rollups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/outcomes/{outcome_id}/contributing_scores": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/outcomes/{outcome_id}/contributing_scores",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pace_contexts": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pace_contexts",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages_ai/alt_text": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages_ai/alt_text",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages/{url_or_id}/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages/{url_or_id}/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages/{url_or_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/pages/{url_or_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/date_details/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/pages/{url_or_id}/date_details/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages/{url_or_id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/revisions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages/{url_or_id}/revisions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/revisions/latest": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages/{url_or_id}/revisions/latest",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "revision_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "revision_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/page_title_availability": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/page_title_availability",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/permissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/ping": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/ping",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/potential_collaborators": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/potential_collaborators",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/preview_html": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/preview_html",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quiz_extensions": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quiz_extensions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/assignment_overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/assignment_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/quizzes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{id}/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{id}/reorder",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{id}/submission_users": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{id}/submission_users",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{id}/submission_users/message": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{id}/submission_users/message",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{id}/validate_access_code": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{id}/validate_access_code",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/date_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{quiz_id}/date_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/date_details/convert_tag_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{quiz_id}/date_details/convert_tag_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/extensions": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/extensions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}/reorder",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/ip_filters": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/ip_filters",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/outstanding_quiz_submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/outstanding_quiz_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/outstanding_quiz_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/questions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/questions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/questions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/reports": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/reports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/reports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/statistics": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/statistics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submission": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/submission",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/complete": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/complete",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/time": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/time",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/self/files": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/quizzes/{quiz_id}/submissions/self/files",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "quiz_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/recent_students": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/recent_students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/reports/{report_type}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/reports/{report_type}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report_type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/reports/{report_type}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report_type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/reports/{report_type}/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/reports/{report_type}/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "report_type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/reset_content": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/reset_content",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/restore/{version_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/restore/{version_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "version_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/root_outcome_group": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/root_outcome_group",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubric_associations": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/rubric_associations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubric_associations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/rubric_associations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/rubric_associations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "rubric_association_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "rubric_association_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "rubric_association_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/download_rubrics": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/rubrics/download_rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/rubrics/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/rubrics/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/rubrics/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/{id}/used_locations": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/rubrics/{id}/used_locations",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/upload": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/rubrics/upload",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/upload/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/rubrics/upload/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/rubrics/upload/{id}/rubrics": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/rubrics/upload/{id}/rubrics",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/search_users": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/search_users",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/sections": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/sections",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/sections",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/sections/{course_section_id}/pace": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/sections/{course_section_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/sections/{course_section_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PATCH /api/v1/courses/{course_id}/sections/{course_section_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/sections/{course_section_id}/paces": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/sections/{course_section_id}/paces",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/sections/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/sections/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/settings",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/smartsearch": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/smartsearch",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/smartsearch/index_status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/smartsearch/index_status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/smartsearch/log": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/smartsearch/log",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/pace": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_enrollment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_enrollment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PATCH /api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/pace",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_enrollment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/paces": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/student_enrollments/{student_enrollment_id}/paces",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_enrollment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/students": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/students",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/students/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/students/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/student_view_student": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/student_view_student",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/submissions/bulk_mark_read": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/submissions/bulk_mark_read",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/submissions/update_grades": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/submissions/update_grades",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/submissions/{user_id}/clear_unread": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/submissions/{user_id}/clear_unread",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/syllabus/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/syllabus/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/syllabus/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/syllabus/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/tabs": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/tabs",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/tabs/{tab_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/tabs/{tab_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tab_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/todo": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/todo",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}/update": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}/update",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/tool_proxies/{tool_proxy_id}/update",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tool_proxy_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/update_final_grade_overrides": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/update_final_grade_overrides",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/usage_rights": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{course_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/users": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/users/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/users/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/users/{id}/lmgb_user_details": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/users/{id}/lmgb_user_details",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/users/{user_id}/last_attended": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/users/{user_id}/last_attended",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/users/{user_id}/progress": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/users/{user_id}/progress",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/web_zip_exports": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/web_zip_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/web_zip_exports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/web_zip_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/what_if_grades/reset": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/what_if_grades/reset",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/youtube_migration/conversion_status": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/youtube_migration/conversion_status",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/youtube_migration/convert": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/youtube_migration/convert",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/youtube_migration/scan": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{course_id}/youtube_migration/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{course_id}/youtube_migration/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{course_id}/youtube_migration/scan/{scan_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{course_id}/youtube_migration/scan/{scan_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "scan_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "DELETE /api/v1/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{id}/dismiss_migration_limitation_message": {
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{id}/dismiss_migration_limitation_message",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{id}/late_policy": {
|
|
"get": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "GET /api/v1/courses/{id}/late_policy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PATCH /api/v1/courses/{id}/late_policy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "POST /api/v1/courses/{id}/late_policy",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/courses/{id}/quizzes": {
|
|
"put": {
|
|
"tags": [
|
|
"courses"
|
|
],
|
|
"summary": "PUT /api/v1/courses/{id}/quizzes",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/dashboard/dashboard_cards": {
|
|
"get": {
|
|
"tags": [
|
|
"dashboard"
|
|
],
|
|
"summary": "GET /api/v1/dashboard/dashboard_cards",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/developer_keys/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"developer_keys"
|
|
],
|
|
"summary": "DELETE /api/v1/developer_keys/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"developer_keys"
|
|
],
|
|
"summary": "PUT /api/v1/developer_keys/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/discovery_pages": {
|
|
"get": {
|
|
"tags": [
|
|
"discovery_pages"
|
|
],
|
|
"summary": "GET /api/v1/discovery_pages",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"discovery_pages"
|
|
],
|
|
"summary": "PUT /api/v1/discovery_pages",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/enqueue_outcome_rollup_calculation": {
|
|
"post": {
|
|
"tags": [
|
|
"enqueue_outcome_rollup_calculation"
|
|
],
|
|
"summary": "POST /api/v1/enqueue_outcome_rollup_calculation",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/eportfolios/{eportfolio_id}/moderate": {
|
|
"put": {
|
|
"tags": [
|
|
"eportfolios"
|
|
],
|
|
"summary": "PUT /api/v1/eportfolios/{eportfolio_id}/moderate",
|
|
"parameters": [
|
|
{
|
|
"name": "eportfolio_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/eportfolios/{eportfolio_id}/pages": {
|
|
"get": {
|
|
"tags": [
|
|
"eportfolios"
|
|
],
|
|
"summary": "GET /api/v1/eportfolios/{eportfolio_id}/pages",
|
|
"parameters": [
|
|
{
|
|
"name": "eportfolio_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/eportfolios/{eportfolio_id}/restore": {
|
|
"put": {
|
|
"tags": [
|
|
"eportfolios"
|
|
],
|
|
"summary": "PUT /api/v1/eportfolios/{eportfolio_id}/restore",
|
|
"parameters": [
|
|
{
|
|
"name": "eportfolio_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/eportfolios/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"eportfolios"
|
|
],
|
|
"summary": "DELETE /api/v1/eportfolios/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"eportfolios"
|
|
],
|
|
"summary": "GET /api/v1/eportfolios/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/epub_exports": {
|
|
"get": {
|
|
"tags": [
|
|
"epub_exports"
|
|
],
|
|
"summary": "GET /api/v1/epub_exports",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/error_reports": {
|
|
"post": {
|
|
"tags": [
|
|
"error_reports"
|
|
],
|
|
"summary": "POST /api/v1/error_reports",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/external_tools/visible_course_nav_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"external_tools"
|
|
],
|
|
"summary": "GET /api/v1/external_tools/visible_course_nav_tools",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/features/environment": {
|
|
"get": {
|
|
"tags": [
|
|
"features"
|
|
],
|
|
"summary": "GET /api/v1/features/environment",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/capture": {
|
|
"post": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "POST /api/v1/files/capture",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "DELETE /api/v1/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "GET /api/v1/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "POST /api/v1/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "PUT /api/v1/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/{id}/create_success": {
|
|
"get": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "GET /api/v1/files/{id}/create_success",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"options": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "OPTIONS /api/v1/files/{id}/create_success",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "POST /api/v1/files/{id}/create_success",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/{id}/icon_metadata": {
|
|
"get": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "GET /api/v1/files/{id}/icon_metadata",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/{id}/public_url": {
|
|
"get": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "GET /api/v1/files/{id}/public_url",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/{id}/reset_verifier": {
|
|
"post": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "POST /api/v1/files/{id}/reset_verifier",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/files/update_word_count": {
|
|
"post": {
|
|
"tags": [
|
|
"files"
|
|
],
|
|
"summary": "POST /api/v1/files/update_word_count",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{dest_folder_id}/copy_file": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "POST /api/v1/folders/{dest_folder_id}/copy_file",
|
|
"parameters": [
|
|
{
|
|
"name": "dest_folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{dest_folder_id}/copy_folder": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "POST /api/v1/folders/{dest_folder_id}/copy_folder",
|
|
"parameters": [
|
|
{
|
|
"name": "dest_folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{folder_id}/files": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "POST /api/v1/folders/{folder_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{folder_id}/folders": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "POST /api/v1/folders/{folder_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "DELETE /api/v1/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "GET /api/v1/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "PUT /api/v1/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{id}/all": {
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "GET /api/v1/folders/{id}/all",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "GET /api/v1/folders/{id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/folders/{id}/folders": {
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"summary": "GET /api/v1/folders/{id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/account_chain": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcome_groups/account_chain",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "DELETE /api/v1/global/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "PUT /api/v1/global/outcome_groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/available_outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcome_groups/{id}/available_outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/batch": {
|
|
"post": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "POST /api/v1/global/outcome_groups/{id}/batch",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/import": {
|
|
"post": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "POST /api/v1/global/outcome_groups/{id}/import",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/outcomes": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "POST /api/v1/global/outcome_groups/{id}/outcomes",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/outcomes/{outcome_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "DELETE /api/v1/global/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "PUT /api/v1/global/outcome_groups/{id}/outcomes/{outcome_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "outcome_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcome_groups/{id}/subgroups": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "POST /api/v1/global/outcome_groups/{id}/subgroups",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcomes_import": {
|
|
"post": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "POST /api/v1/global/outcomes_import",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcomes_import/available": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcomes_import/available",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/outcomes_import/migration_status/{migration_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/outcomes_import/migration_status/{migration_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/global/root_outcome_group": {
|
|
"get": {
|
|
"tags": [
|
|
"global"
|
|
],
|
|
"summary": "GET /api/v1/global/root_outcome_group",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/grading_period_sets/{set_id}/grading_periods/batch_update": {
|
|
"patch": {
|
|
"tags": [
|
|
"grading_period_sets"
|
|
],
|
|
"summary": "PATCH /api/v1/grading_period_sets/{set_id}/grading_periods/batch_update",
|
|
"parameters": [
|
|
{
|
|
"name": "set_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "DELETE /api/v1/group_categories/{group_category_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "GET /api/v1/group_categories/{group_category_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "PUT /api/v1/group_categories/{group_category_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}/assign_unassigned_members": {
|
|
"post": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "POST /api/v1/group_categories/{group_category_id}/assign_unassigned_members",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "GET /api/v1/group_categories/{group_category_id}/export",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "GET /api/v1/group_categories/{group_category_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "POST /api/v1/group_categories/{group_category_id}/groups",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}/import": {
|
|
"post": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "POST /api/v1/group_categories/{group_category_id}/import",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/group_categories/{group_category_id}/users": {
|
|
"get": {
|
|
"tags": [
|
|
"group_categories"
|
|
],
|
|
"summary": "GET /api/v1/group_categories/{group_category_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "group_category_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/activity_stream": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/activity_stream",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/activity_stream/summary": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/activity_stream/summary",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/assignments/{assignment_id}/override": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/assignments/{assignment_id}/override",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/collaborations": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/collaborations",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/collaborations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/collaborations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/conferences": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/conferences",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/conferences",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/conferences/{conference_id}/recording_ready": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/conferences/{conference_id}/recording_ready",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "conference_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_exports": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_exports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_exports/{id}/fail": {
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/content_exports/{id}/fail",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_licenses": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_licenses",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations/{id}/selective_data": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations/{id}/selective_data",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/content_migrations/migrators": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/content_migrations/migrators",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/read_all": {
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/reorder",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/accessibility/queue_scan": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/accessibility/queue_scan",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/accessibility/scan": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/accessibility/scan",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/duplicate": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/duplicate",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/entry_list": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/entry_list",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights/entries": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights/entries",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights/entries/{entry_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/insights/entries/{entry_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "entry_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/messageable_users": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/messageable_users",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/read_all": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/read_all",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/disable": {
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/disable",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "summary_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/discussion_topics/{topic_id}/view": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/discussion_topics/{topic_id}/view",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "topic_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/external_feeds": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/external_feeds",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/external_feeds",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/external_feeds/{external_feed_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/external_feeds/{external_feed_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "external_feed_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/external_tools": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/external_tools",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/files/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/files/quota": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/files/quota",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders_and_files": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders_and_files",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders/by_path": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders/by_path",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders/by_path/*full_path": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders/by_path/*full_path",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/folders/media": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/folders/media",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/followers/self": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/followers/self",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/followers/self",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/front_page": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/front_page",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/front_page",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/invite": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/invite",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/media_attachments": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/media_attachments",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/media_objects": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/media_objects",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/memberships": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/memberships",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/memberships",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/memberships/{membership_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/memberships/{membership_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "membership_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/memberships/{membership_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "membership_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/memberships/{membership_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "membership_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/pages",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/pages",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages_ai/alt_text": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/pages_ai/alt_text",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages/{url_or_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/pages/{url_or_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages/{url_or_id}/revisions": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/pages/{url_or_id}/revisions",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages/{url_or_id}/revisions/latest": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/pages/{url_or_id}/revisions/latest",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "revision_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "url_or_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "revision_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/page_title_availability": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/page_title_availability",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/permissions",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/potential_collaborators": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/potential_collaborators",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/preview_html": {
|
|
"post": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "POST /api/v1/groups/{group_id}/preview_html",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/tabs": {
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/tabs",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/usage_rights": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/users": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/groups/{group_id}/users/{user_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "DELETE /api/v1/groups/{group_id}/users/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "GET /api/v1/groups/{group_id}/users/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"groups"
|
|
],
|
|
"summary": "PUT /api/v1/groups/{group_id}/users/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "group_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/immersive_reader/authenticate": {
|
|
"get": {
|
|
"tags": [
|
|
"immersive_reader"
|
|
],
|
|
"summary": "GET /api/v1/immersive_reader/authenticate",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/inst_access_tokens": {
|
|
"post": {
|
|
"tags": [
|
|
"inst_access_tokens"
|
|
],
|
|
"summary": "POST /api/v1/inst_access_tokens",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs"
|
|
],
|
|
"summary": "GET /api/v1/jobs",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/{bucket}": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/{bucket}",
|
|
"parameters": [
|
|
{
|
|
"name": "bucket",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/{bucket}/by_{group}": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/{bucket}/by_{group}",
|
|
"parameters": [
|
|
{
|
|
"name": "bucket",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "group",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/{bucket}/by_{group}/search": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/{bucket}/by_{group}/search",
|
|
"parameters": [
|
|
{
|
|
"name": "bucket",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "group",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/clusters": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/clusters",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/{id}/requeue": {
|
|
"post": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "POST /api/v1/jobs2/{id}/requeue",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/manage": {
|
|
"put": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "PUT /api/v1/jobs2/manage",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/stuck/singletons": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/stuck/singletons",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/stuck/strands": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/stuck/strands",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/throttle": {
|
|
"put": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "PUT /api/v1/jobs2/throttle",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/throttle/check": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "GET /api/v1/jobs2/throttle/check",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs2/unstuck": {
|
|
"put": {
|
|
"tags": [
|
|
"jobs2"
|
|
],
|
|
"summary": "PUT /api/v1/jobs2/unstuck",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs/batch_update": {
|
|
"post": {
|
|
"tags": [
|
|
"jobs"
|
|
],
|
|
"summary": "POST /api/v1/jobs/batch_update",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jobs/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"jobs"
|
|
],
|
|
"summary": "GET /api/v1/jobs/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jwts": {
|
|
"post": {
|
|
"tags": [
|
|
"jwts"
|
|
],
|
|
"summary": "POST /api/v1/jwts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/jwts/refresh": {
|
|
"post": {
|
|
"tags": [
|
|
"jwts"
|
|
],
|
|
"summary": "POST /api/v1/jwts/refresh",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/login/session_token": {
|
|
"get": {
|
|
"tags": [
|
|
"login"
|
|
],
|
|
"summary": "GET /api/v1/login/session_token",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/manageable_accounts": {
|
|
"get": {
|
|
"tags": [
|
|
"manageable_accounts"
|
|
],
|
|
"summary": "GET /api/v1/manageable_accounts",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/manually_created_courses_account": {
|
|
"get": {
|
|
"tags": [
|
|
"manually_created_courses_account"
|
|
],
|
|
"summary": "GET /api/v1/manually_created_courses_account",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_attachments": {
|
|
"get": {
|
|
"tags": [
|
|
"media_attachments"
|
|
],
|
|
"summary": "GET /api/v1/media_attachments",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"media_attachments"
|
|
],
|
|
"summary": "POST /api/v1/media_attachments",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_attachments/{attachment_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"media_attachments"
|
|
],
|
|
"summary": "PUT /api/v1/media_attachments/{attachment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_attachments/{attachment_id}/media_tracks": {
|
|
"get": {
|
|
"tags": [
|
|
"media_attachments"
|
|
],
|
|
"summary": "GET /api/v1/media_attachments/{attachment_id}/media_tracks",
|
|
"parameters": [
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"media_attachments"
|
|
],
|
|
"summary": "PUT /api/v1/media_attachments/{attachment_id}/media_tracks",
|
|
"parameters": [
|
|
{
|
|
"name": "attachment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_objects": {
|
|
"get": {
|
|
"tags": [
|
|
"media_objects"
|
|
],
|
|
"summary": "GET /api/v1/media_objects",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"media_objects"
|
|
],
|
|
"summary": "POST /api/v1/media_objects",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_objects/{media_object_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"media_objects"
|
|
],
|
|
"summary": "PUT /api/v1/media_objects/{media_object_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "media_object_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/media_objects/{media_object_id}/media_tracks": {
|
|
"get": {
|
|
"tags": [
|
|
"media_objects"
|
|
],
|
|
"summary": "GET /api/v1/media_objects/{media_object_id}/media_tracks",
|
|
"parameters": [
|
|
{
|
|
"name": "media_object_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"media_objects"
|
|
],
|
|
"summary": "PUT /api/v1/media_objects/{media_object_id}/media_tracks",
|
|
"parameters": [
|
|
{
|
|
"name": "media_object_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/microfrontends/release_tag_override": {
|
|
"delete": {
|
|
"tags": [
|
|
"microfrontends"
|
|
],
|
|
"summary": "DELETE /api/v1/microfrontends/release_tag_override",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"microfrontends"
|
|
],
|
|
"summary": "GET /api/v1/microfrontends/release_tag_override",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/outcomes/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"outcomes"
|
|
],
|
|
"summary": "DELETE /api/v1/outcomes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"outcomes"
|
|
],
|
|
"summary": "GET /api/v1/outcomes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"outcomes"
|
|
],
|
|
"summary": "PUT /api/v1/outcomes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/permissions/{context_type}/{permission}/help": {
|
|
"get": {
|
|
"tags": [
|
|
"permissions"
|
|
],
|
|
"summary": "GET /api/v1/permissions/{context_type}/{permission}/help",
|
|
"parameters": [
|
|
{
|
|
"name": "context_type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "permission",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/permissions/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"permissions"
|
|
],
|
|
"summary": "GET /api/v1/permissions/groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/planner/items": {
|
|
"get": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "GET /api/v1/planner/items",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/planner_notes": {
|
|
"get": {
|
|
"tags": [
|
|
"planner_notes"
|
|
],
|
|
"summary": "GET /api/v1/planner_notes",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"planner_notes"
|
|
],
|
|
"summary": "POST /api/v1/planner_notes",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/planner_notes/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"planner_notes"
|
|
],
|
|
"summary": "DELETE /api/v1/planner_notes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"planner_notes"
|
|
],
|
|
"summary": "GET /api/v1/planner_notes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"planner_notes"
|
|
],
|
|
"summary": "PUT /api/v1/planner_notes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/planner/overrides": {
|
|
"get": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "GET /api/v1/planner/overrides",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "POST /api/v1/planner/overrides",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/planner/overrides/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "DELETE /api/v1/planner/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "GET /api/v1/planner/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"planner"
|
|
],
|
|
"summary": "PUT /api/v1/planner/overrides/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"plugins"
|
|
],
|
|
"summary": "GET /api/v1/plugins/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"plugins"
|
|
],
|
|
"summary": "PUT /api/v1/plugins/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "POST /api/v1/polls",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/poll_sessions/closed": {
|
|
"get": {
|
|
"tags": [
|
|
"poll_sessions"
|
|
],
|
|
"summary": "GET /api/v1/poll_sessions/closed",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/poll_sessions/opened": {
|
|
"get": {
|
|
"tags": [
|
|
"poll_sessions"
|
|
],
|
|
"summary": "GET /api/v1/poll_sessions/opened",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "DELETE /api/v1/polls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "PUT /api/v1/polls/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_choices": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_choices",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "POST /api/v1/polls/{poll_id}/poll_choices",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_choices/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "DELETE /api/v1/polls/{poll_id}/poll_choices/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_choices/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "PUT /api/v1/polls/{poll_id}/poll_choices/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_sessions",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "POST /api/v1/polls/{poll_id}/poll_sessions",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "DELETE /api/v1/polls/{poll_id}/poll_sessions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_sessions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "PUT /api/v1/polls/{poll_id}/poll_sessions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions/{id}/close": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_sessions/{id}/close",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions/{id}/open": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_sessions/{id}/open",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions": {
|
|
"post": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "POST /api/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "poll_session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"polls"
|
|
],
|
|
"summary": "GET /api/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "poll_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "poll_session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/progress/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"progress"
|
|
],
|
|
"summary": "GET /api/v1/progress/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/progress/{id}/cancel": {
|
|
"post": {
|
|
"tags": [
|
|
"progress"
|
|
],
|
|
"summary": "POST /api/v1/progress/{id}/cancel",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/question_banks": {
|
|
"get": {
|
|
"tags": [
|
|
"question_banks"
|
|
],
|
|
"summary": "GET /api/v1/question_banks",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/question_banks/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"question_banks"
|
|
],
|
|
"summary": "GET /api/v1/question_banks/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/question_banks/{id}/questions": {
|
|
"get": {
|
|
"tags": [
|
|
"question_banks"
|
|
],
|
|
"summary": "GET /api/v1/question_banks/{id}/questions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/quiz_submissions/{quiz_submission_id}/questions": {
|
|
"get": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "GET /api/v1/quiz_submissions/{quiz_submission_id}/questions",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "POST /api/v1/quiz_submissions/{quiz_submission_id}/questions",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "GET /api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag": {
|
|
"put": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "PUT /api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer": {
|
|
"get": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "GET /api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag": {
|
|
"put": {
|
|
"tags": [
|
|
"quiz_submissions"
|
|
],
|
|
"summary": "PUT /api/v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag",
|
|
"parameters": [
|
|
{
|
|
"name": "quiz_submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/rce_linked_file_instfs_ids": {
|
|
"post": {
|
|
"tags": [
|
|
"rce_linked_file_instfs_ids"
|
|
],
|
|
"summary": "POST /api/v1/rce_linked_file_instfs_ids",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/release_notes": {
|
|
"get": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "GET /api/v1/release_notes",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "POST /api/v1/release_notes",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/release_notes/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "DELETE /api/v1/release_notes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "PUT /api/v1/release_notes/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/release_notes/{id}/published": {
|
|
"delete": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "DELETE /api/v1/release_notes/{id}/published",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "PUT /api/v1/release_notes/{id}/published",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/release_notes/latest": {
|
|
"get": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "GET /api/v1/release_notes/latest",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/release_notes/unread_count": {
|
|
"get": {
|
|
"tags": [
|
|
"release_notes"
|
|
],
|
|
"summary": "GET /api/v1/release_notes/unread_count",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/rich_content/generate": {
|
|
"post": {
|
|
"tags": [
|
|
"rich_content"
|
|
],
|
|
"summary": "POST /api/v1/rich_content/generate",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/rubrics/upload_template": {
|
|
"get": {
|
|
"tags": [
|
|
"rubrics"
|
|
],
|
|
"summary": "GET /api/v1/rubrics/upload_template",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/search/all_courses": {
|
|
"get": {
|
|
"tags": [
|
|
"search"
|
|
],
|
|
"summary": "GET /api/v1/search/all_courses",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/search/recipients": {
|
|
"get": {
|
|
"tags": [
|
|
"search"
|
|
],
|
|
"summary": "GET /api/v1/search/recipients",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/search/rubrics": {
|
|
"get": {
|
|
"tags": [
|
|
"search"
|
|
],
|
|
"summary": "GET /api/v1/search/rubrics",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{course_section_id}/assignments/{assignment_id}/override": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{course_section_id}/assignments/{assignment_id}/override",
|
|
"parameters": [
|
|
{
|
|
"name": "course_section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "DELETE /api/v1/sections/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{id}/crosslist": {
|
|
"delete": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "DELETE /api/v1/sections/{id}/crosslist",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{id}/crosslist/{new_course_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{id}/crosslist/{new_course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "new_course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{id}/users": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{id}/users",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "anonymous_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "anonymous_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/peer_reviews": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews": {
|
|
"delete": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "DELETE /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "submission_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submission_summary": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submission_summary",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/update_grades": {
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/update_grades",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/files": {
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read": {
|
|
"delete": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "DELETE /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}": {
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item}",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "item",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/enrollments": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/enrollments",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/enrollments",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/students/submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "GET /api/v1/sections/{section_id}/students/submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/submissions/bulk_mark_read": {
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/submissions/bulk_mark_read",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/submissions/update_grades": {
|
|
"post": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "POST /api/v1/sections/{section_id}/submissions/update_grades",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/sections/{section_id}/submissions/{user_id}/clear_unread": {
|
|
"put": {
|
|
"tags": [
|
|
"sections"
|
|
],
|
|
"summary": "PUT /api/v1/sections/{section_id}/submissions/{user_id}/clear_unread",
|
|
"parameters": [
|
|
{
|
|
"name": "section_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/services/kaltura": {
|
|
"get": {
|
|
"tags": [
|
|
"services"
|
|
],
|
|
"summary": "GET /api/v1/services/kaltura",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/services/kaltura_session": {
|
|
"post": {
|
|
"tags": [
|
|
"services"
|
|
],
|
|
"summary": "POST /api/v1/services/kaltura_session",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/services/rce_config": {
|
|
"get": {
|
|
"tags": [
|
|
"services"
|
|
],
|
|
"summary": "GET /api/v1/services/rce_config",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/settings/environment": {
|
|
"get": {
|
|
"tags": [
|
|
"settings"
|
|
],
|
|
"summary": "GET /api/v1/settings/environment",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/shared_brand_configs/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"shared_brand_configs"
|
|
],
|
|
"summary": "DELETE /api/v1/shared_brand_configs/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/show_k5_dashboard": {
|
|
"get": {
|
|
"tags": [
|
|
"show_k5_dashboard"
|
|
],
|
|
"summary": "GET /api/v1/show_k5_dashboard",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/submissions/{id}/what_if_grades": {
|
|
"put": {
|
|
"tags": [
|
|
"submissions"
|
|
],
|
|
"summary": "PUT /api/v1/submissions/{id}/what_if_grades",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/asset_processor/bulk_resubmit": {
|
|
"post": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "POST /api/v1/support_helpers/asset_processor/bulk_resubmit",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/asset_processor_discussion/bulk_resubmit": {
|
|
"post": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "POST /api/v1/support_helpers/asset_processor_discussion/bulk_resubmit",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/asset_processor/submission_details": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/asset_processor/submission_details",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/plagiarism_platform/add_service": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/plagiarism_platform/add_service",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/plagiarism_platform/resubmit_for_assignment/{assignment_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/plagiarism_platform/resubmit_for_assignment/{assignment_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "assignment_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/submission_lifecycle_manage/course": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/submission_lifecycle_manage/course",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/assignment": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/assignment",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/error2305": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/error2305",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/expired": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/expired",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/md5": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/md5",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/pending": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/pending",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/refresh_lti_attachment": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/refresh_lti_attachment",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/support_helpers/turnitin/shard": {
|
|
"get": {
|
|
"tags": [
|
|
"support_helpers"
|
|
],
|
|
"summary": "GET /api/v1/support_helpers/turnitin/shard",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/activity_stream": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/activity_stream",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/clear_cache": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{id}/clear_cache",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/colors": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/colors",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/colors/{asset_string}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/colors/{asset_string}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "asset_string",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/colors/{asset_string}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "asset_string",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/dashboard_positions": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/dashboard_positions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/dashboard_positions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/files_ui_version_preference": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/files_ui_version_preference",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/graded_submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/graded_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/merge_into/accounts/{destination_account_id}/users/{destination_user_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/merge_into/accounts/{destination_account_id}/users/{destination_user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "destination_account_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "destination_user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/merge_into/{destination_user_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/merge_into/{destination_user_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "destination_user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/mobile_sessions": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{id}/mobile_sessions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/new_user_tutorial_statuses": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/new_user_tutorial_statuses",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/new_user_tutorial_statuses/{page_name}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/new_user_tutorial_statuses/{page_name}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/sessions": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{id}/sessions",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{id}/settings",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/settings",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/split": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{id}/split",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{id}/text_editor_preference": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{id}/text_editor_preference",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/mobile_sessions": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/mobile_sessions",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/page_views/query": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/page_views/query",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/page_views/query/{query_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/page_views/query/{query_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "query_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/page_views/query/{query_id}/results": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/page_views/query/{query_id}/results",
|
|
"parameters": [
|
|
{
|
|
"name": "query_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/reset_password": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/reset_password",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/activity_stream": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/activity_stream",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/activity_stream",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/activity_stream/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/activity_stream/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/activity_stream/summary": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/activity_stream/summary",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/bookmarks": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/bookmarks",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/self/bookmarks",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/bookmarks/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/bookmarks/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/bookmarks/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/bookmarks/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/{communication_channel_id}/notification_preference_categories/{category}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/communication_channels/{communication_channel_id}/notification_preference_categories/{category}",
|
|
"parameters": [
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "category",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences",
|
|
"parameters": [
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences/{notification}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/communication_channels/{communication_channel_id}/notification_preferences/{notification}",
|
|
"parameters": [
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "notification",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/push": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/communication_channels/push",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/{type}/{address}/notification_preferences": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/communication_channels/{type}/{address}/notification_preferences",
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/communication_channels/{type}/{address}/notification_preferences/{notification}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/communication_channels/{type}/{address}/notification_preferences/{notification}",
|
|
"parameters": [
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "notification",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/course_nicknames": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/course_nicknames",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/course_nicknames",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/course_nicknames/{course_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/course_nicknames/{course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/course_nicknames/{course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/self/course_nicknames/{course_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/favorites/courses": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/favorites/courses",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/favorites/courses",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/favorites/courses/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/favorites/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/self/favorites/courses/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/favorites/groups": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/favorites/groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/favorites/groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/favorites/groups/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/favorites/groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/self/favorites/groups/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/groups": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/groups",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/pandata_events_token": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/self/pandata_events_token",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/todo": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/todo",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/todo/{asset_string}/{purpose}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/self/todo/{asset_string}/{purpose}",
|
|
"parameters": [
|
|
{
|
|
"name": "asset_string",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "purpose",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/todo_item_count": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/todo_item_count",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/self/upcoming_events": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/self/upcoming_events",
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/avatars": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/avatars",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/calendar_events": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/calendar_events",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/communication_channels",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preference_categories": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preference_categories",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences/{notification}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences/{notification}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "communication_channel_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "notification",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/communication_channels/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/communication_channels/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{type}/{address}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/communication_channels/{type}/{address}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences/{notification}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences/{notification}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "notification",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_exports": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/content_exports",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_exports/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_exports/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_exports/{id}/fail": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/content_exports/{id}/fail",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_licenses": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_licenses",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/content_migrations",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "content_migration_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/content_migrations/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations/{id}/selective_data": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations/{id}/selective_data",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_migrations/migrators": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_migrations/migrators",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/content_shares",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/content_shares/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_shares/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/content_shares/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares/{id}/add_users": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/content_shares/{id}/add_users",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares/received": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_shares/received",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares/sent": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_shares/sent",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/content_shares/unread_count": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/content_shares/unread_count",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/courses": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/courses",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/courses/{course_id}/assignments": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/courses/{course_id}/assignments",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "course_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/custom_data(/*scope)": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/custom_data(/*scope)",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/custom_data(/*scope)",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/custom_data(/*scope)",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/enrollments": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/enrollments",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/eportfolios": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/eportfolios",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/eportfolios",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/features": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/features",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/features/enabled": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/features/enabled",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/features/flags/{feature}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/features/flags/{feature}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "feature",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/files",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/files/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/files/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/files/quota": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/files/quota",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/folders": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/folders",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/folders_and_files": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/folders_and_files",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/folders/by_path": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/folders/by_path",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/folders/by_path/*full_path": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/folders/by_path/*full_path",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/folders/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/folders/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/followers/self": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/followers/self",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/followers/self",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/history": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/history",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/logins": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/logins",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/logins/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/logins/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/missing_submissions": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/missing_submissions",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observees": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observees",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/observees",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observees/{observee_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/observees/{observee_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observee_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observees/{observee_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observee_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/observees/{observee_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observee_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_alerts/{observer_alert_id}/{workflow_state}": {
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/observer_alerts/{observer_alert_id}/{workflow_state}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observer_alert_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "workflow_state",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_alerts/{student_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observer_alerts/{student_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "student_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_alerts/unread_count": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observer_alerts/unread_count",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_alert_thresholds": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observer_alert_thresholds",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/observer_alert_thresholds",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_alert_thresholds/{observer_alert_threshold_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/observer_alert_thresholds/{observer_alert_threshold_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observer_alert_threshold_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observer_alert_thresholds/{observer_alert_threshold_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observer_alert_threshold_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/observer_alert_thresholds/{observer_alert_threshold_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observer_alert_threshold_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observer_pairing_codes": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/observer_pairing_codes",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observers": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observers",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/observers/{observer_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/observers/{observer_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "observer_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/page_views": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/page_views",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/page_views/query": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/page_views/query",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/page_views/query/{query_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/page_views/query/{query_id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "query_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/page_views/query/{query_id}/results": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/page_views/query/{query_id}/results",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "query_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/planner/items": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/planner/items",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/profile": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/profile",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/tabs": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/tabs",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/temporary_enrollment_status": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/temporary_enrollment_status",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/tokens": {
|
|
"post": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "POST /api/v1/users/{user_id}/tokens",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/tokens/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/tokens/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/tokens/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/tokens/{id}",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/usage_rights": {
|
|
"delete": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "DELETE /api/v1/users/{user_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "PUT /api/v1/users/{user_id}/usage_rights",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/users/{user_id}/user_generated_tokens": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"summary": "GET /api/v1/users/{user_id}/user_generated_tokens",
|
|
"parameters": [
|
|
{
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"description": "Not found"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |