Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2452)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/classroom__v1.json

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/calendar__v3.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/classroom__v1.json
diff --git a/discovery/googleapis/classroom__v1.json b/discovery/googleapis/classroom__v1.json
index 97618494a8a520f42793ddd714a04ea7a37b756e..8f6fbe430cdf57664d97b4ed14bd8abd337e23b6 100644
--- a/discovery/googleapis/classroom__v1.json
+++ b/discovery/googleapis/classroom__v1.json
@@ -50,7 +50,7 @@
"description": "Manages classes, rosters, and invitations in Google Classroom.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/classroom/",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/mk_oLjlaBwJ1BcBJ5yykCFb6u3w\"",
+ "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/VPjAdAuQhi94i4H_5Zyjop6mRoc\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -680,7 +680,7 @@
"courseWork": {
"methods": {
"create": {
- "description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
+ "description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.create",
"parameterOrder": [
@@ -705,6 +705,74 @@
"https://www.googleapis.com/auth/classroom.coursework.students"
]
},
+ "patch": {
+ "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "httpMethod": "PATCH",
+ "id": "classroom.courses.courseWork.patch",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the course work.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `submission_modification_mode`",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.",
+ "httpMethod": "DELETE",
+ "id": "classroom.courses.courseWork.delete",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ]
+ },
"get": {
"description": "Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.",
"httpMethod": "GET",
@@ -1002,7 +1070,7 @@
]
},
"reclaim": {
- "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.reclaim",
"parameterOrder": [
@@ -1082,7 +1150,7 @@
]
},
"modifyAttachments": {
- "description": "Modifies attachments of student submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
"parameterOrder": [
@@ -1131,7 +1199,7 @@
"userProfiles": {
"methods": {
"get": {
- "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.",
+ "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.",
"httpMethod": "GET",
"id": "classroom.userProfiles.get",
"parameterOrder": [
@@ -1333,7 +1401,7 @@
}
},
"get": {
- "description": "Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.",
+ "description": "Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.",
"httpMethod": "GET",
"id": "classroom.userProfiles.guardians.get",
"parameterOrder": [
@@ -1360,7 +1428,7 @@
}
},
"delete": {
- "description": "Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any record of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.",
+ "description": "Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.",
"httpMethod": "DELETE",
"id": "classroom.userProfiles.guardians.delete",
"parameterOrder": [
@@ -1516,7 +1584,7 @@
}
}
},
- "revision": "20161006",
+ "revision": "20170110",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"Course": {
@@ -1854,47 +1922,6 @@
},
"type": "object"
},
- "ListGuardiansResponse": {
- "description": "Response when listing guardians.",
- "id": "ListGuardiansResponse",
- "properties": {
- "guardians": {
- "description": "Guardians on this page of results that met the criteria specified in the request.",
- "items": {
- "$ref": "Guardian"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further results are available.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Guardian": {
- "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.",
- "id": "Guardian",
- "properties": {
- "studentId": {
- "description": "Identifier for the student to whom the guardian relationship applies.",
- "type": "string"
- },
- "guardianId": {
- "description": "Identifier for the guardian.",
- "type": "string"
- },
- "guardianProfile": {
- "$ref": "UserProfile",
- "description": "User profile for the guardian."
- },
- "invitedEmailAddress": {
- "description": "The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.",
- "type": "string"
- }
- },
- "type": "object"
- },
"UserProfile": {
"description": "Global information for a user.",
"id": "UserProfile",
@@ -2037,6 +2064,47 @@
},
"type": "object"
},
+ "ListGuardiansResponse": {
+ "description": "Response when listing guardians.",
+ "id": "ListGuardiansResponse",
+ "properties": {
+ "guardians": {
+ "description": "Guardians on this page of results that met the criteria specified in the request.",
+ "items": {
+ "$ref": "Guardian"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further results are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Guardian": {
+ "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.",
+ "id": "Guardian",
+ "properties": {
+ "studentId": {
+ "description": "Identifier for the student to whom the guardian relationship applies.",
+ "type": "string"
+ },
+ "guardianId": {
+ "description": "Identifier for the guardian.",
+ "type": "string"
+ },
+ "guardianProfile": {
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
+ },
+ "invitedEmailAddress": {
+ "description": "The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Invitation": {
"description": "An invitation to join a course.",
"id": "Invitation",
@@ -2146,7 +2214,7 @@
"type": "number"
},
"workType": {
- "description": "Type of this course work. The type is set when the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.",
+ "description": "Type of this course work. The type is set when the course work is created and cannot be changed.",
"enum": [
"COURSE_WORK_TYPE_UNSPECIFIED",
"ASSIGNMENT",
@@ -2170,17 +2238,17 @@
},
"assignment": {
"$ref": "Assignment",
- "description": "Assignment details. This is populated only when `work_type` is `ASSIGNMENT`."
+ "description": "Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only."
},
"multipleChoiceQuestion": {
"$ref": "MultipleChoiceQuestion",
- "description": "Multiple choice question details. This is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`."
+ "description": "Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise."
}
},
"type": "object"
},
"Material": {
- "description": "Material attached to course work. When creating attachments, only the Link field may be specified.",
+ "description": "Material attached to course work. When creating attachments, setting the `form` field is not supported.",
"id": "Material",
"properties": {
"driveFile": {
@@ -2193,7 +2261,7 @@
},
"link": {
"$ref": "Link",
- "description": "Link material."
+ "description": "Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response."
},
"form": {
"$ref": "Form",
@@ -2407,7 +2475,7 @@
"id": "AssignmentSubmission",
"properties": {
"attachments": {
- "description": "Attachments added by the student. Drive files that correspond to materials with a share mode of SUBMISSION_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are available, but others (e.g. title) may not be.",
+ "description": "Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.",
"items": {
"$ref": "Attachment"
},
@@ -2417,7 +2485,7 @@
"type": "object"
},
"Attachment": {
- "description": "Attachment added to student assignment work. When creating attachments, only the Link field may be specified.",
+ "description": "Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.",
"id": "Attachment",
"properties": {
"driveFile": {
@@ -2499,7 +2567,7 @@
"id": "ModifyAttachmentsRequest",
"properties": {
"addAttachments": {
- "description": "Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.",
+ "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.",
"items": {
"$ref": "Attachment"
},
« no previous file with comments | « discovery/googleapis/calendar__v3.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698