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

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/classroom__v1.json

Issue 2281923002: Api-roll 41: 2016-08-26 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 4 years, 4 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/civicinfo__v2.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 f71a7e3c50b890a8b0609a452bddbb93108309ee..a2888d01dedf7003d4f8d79c6be09dfd96b83ce4 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": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/CqYvNpV2Som-B9o1jdwhrzhRs18\"",
+ "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/YsDe4FXJlhWXueJei0_RXQqm_4I\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -889,7 +889,7 @@
"type": "string"
},
"courseWorkId": {
- "description": "Identifer of the student work to request. If `user_id` is specified, this may be set to the string literal `\"-\"` to request student work for all course work in the specified course.",
+ "description": "Identifer of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.",
"location": "path",
"required": true,
"type": "string"
@@ -1115,6 +1115,268 @@
}
}
},
+ "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.",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.get",
+ "parameterOrder": [
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{userId}",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ]
+ }
+ },
+ "resources": {
+ "guardianInvitations": {
+ "methods": {
+ "list": {
+ "description": "Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, 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`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardianInvitations.list",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "invitedEmailAddress": {
+ "description": "If specified, only results with the specified `invited_email_address` will be returned.",
+ "location": "query",
+ "type": "string"
+ },
+ "states": {
+ "description": "If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.",
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "response": {
+ "$ref": "ListGuardianInvitationsResponse"
+ }
+ },
+ "get": {
+ "description": "Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations 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 `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardianInvitations.get",
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is being requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "response": {
+ "$ref": "GuardianInvitation"
+ }
+ },
+ "create": {
+ "description": "Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.",
+ "httpMethod": "POST",
+ "id": "classroom.userProfiles.guardianInvitations.create",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "ID of the student (in standard format)",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "response": {
+ "$ref": "GuardianInvitation"
+ }
+ },
+ "patch": {
+ "description": "Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom.",
+ "httpMethod": "PATCH",
+ "id": "classroom.userProfiles.guardianInvitations.patch",
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is to be modified.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` to be modified.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...`",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "response": {
+ "$ref": "GuardianInvitation"
+ }
+ }
+ }
+ },
+ "guardians": {
+ "methods": {
+ "list": {
+ "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardians.list",
+ "parameterOrder": [
+ "studentId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "invitedEmailAddress": {
+ "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardians",
+ "response": {
+ "$ref": "ListGuardiansResponse"
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "id": "classroom.userProfiles.guardians.get",
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "response": {
+ "$ref": "Guardian"
+ }
+ },
+ "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.",
+ "httpMethod": "DELETE",
+ "id": "classroom.userProfiles.guardians.delete",
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "parameters": {
+ "studentId": {
+ "description": "The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "guardianId": {
+ "description": "The `id` field from a `Guardian`.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "response": {
+ "$ref": "Empty"
+ }
+ }
+ }
+ }
+ }
+ },
"invitations": {
"methods": {
"create": {
@@ -1239,39 +1501,9 @@
]
}
}
- },
- "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.",
- "httpMethod": "GET",
- "id": "classroom.userProfiles.get",
- "parameterOrder": [
- "userId"
- ],
- "parameters": {
- "userId": {
- "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/userProfiles/{userId}",
- "response": {
- "$ref": "UserProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ]
- }
- }
}
},
- "revision": "20160517",
+ "revision": "20160816",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"Course": {
@@ -1555,42 +1787,64 @@
},
"type": "object"
},
- "Invitation": {
- "description": "An invitation to join a course.",
- "id": "Invitation",
+ "ListGuardianInvitationsResponse": {
+ "description": "Response when listing guardian invitations.",
+ "id": "ListGuardianInvitationsResponse",
"properties": {
- "id": {
- "description": "Identifier assigned by Classroom. Read-only.",
+ "guardianInvitations": {
+ "description": "Guardian invitations that matched the list request.",
+ "items": {
+ "$ref": "GuardianInvitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further results are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GuardianInvitation": {
+ "description": "An invitation to become the guardian of a specified user, sent to a specified email address.",
+ "id": "GuardianInvitation",
+ "properties": {
+ "studentId": {
+ "description": "ID of the student (in standard format)",
"type": "string"
},
- "userId": {
- "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "invitationId": {
+ "description": "Unique identifier for this invitation. Read-only.",
"type": "string"
},
- "courseId": {
- "description": "Identifier of the course to invite the user to.",
+ "invitedEmailAddress": {
+ "description": "Email address that the invitation was sent to. This field is only visible to domain administrators.",
"type": "string"
},
- "role": {
- "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
+ "state": {
+ "description": "The state that this invitation is in.",
"enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER"
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
],
"type": "string"
+ },
+ "creationTime": {
+ "description": "The time that this invitation was created. Read-only.",
+ "type": "string"
}
},
"type": "object"
},
- "ListInvitationsResponse": {
- "description": "Response when listing invitations.",
- "id": "ListInvitationsResponse",
+ "ListGuardiansResponse": {
+ "description": "Response when listing guardians.",
+ "id": "ListGuardiansResponse",
"properties": {
- "invitations": {
- "description": "Invitations that match the list request.",
+ "guardians": {
+ "description": "Guardians on this page of results that met the criteria specified in the request.",
"items": {
- "$ref": "Invitation"
+ "$ref": "Guardian"
},
"type": "array"
},
@@ -1601,6 +1855,29 @@
},
"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",
@@ -1743,6 +2020,52 @@
},
"type": "object"
},
+ "Invitation": {
+ "description": "An invitation to join a course.",
+ "id": "Invitation",
+ "properties": {
+ "id": {
+ "description": "Identifier assigned by Classroom. Read-only.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course to invite the user to.",
+ "type": "string"
+ },
+ "role": {
+ "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListInvitationsResponse": {
+ "description": "Response when listing invitations.",
+ "id": "ListInvitationsResponse",
+ "properties": {
+ "invitations": {
+ "description": "Invitations that match the list request.",
+ "items": {
+ "$ref": "Invitation"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further results are available.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"CourseWork": {
"description": "Course work created by a teacher for students of the course.",
"id": "CourseWork",
@@ -1764,14 +2087,14 @@
"type": "string"
},
"materials": {
- "description": "Additional materials.",
+ "description": "Additional materials. CourseWork must have no more than 20 material items.",
"items": {
"$ref": "Material"
},
"type": "array"
},
"state": {
- "description": "Status of this course work.. If unspecified, the default state is `DRAFT`.",
+ "description": "Status of this course work. If unspecified, the default state is `DRAFT`.",
"enum": [
"COURSE_WORK_STATE_UNSPECIFIED",
"PUBLISHED",
@@ -1801,7 +2124,7 @@
"description": "Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified."
},
"maxPoints": {
- "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be an integer value.",
+ "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.",
"format": "double",
"type": "number"
},
@@ -1996,7 +2319,7 @@
"type": "string"
},
"creationTime": {
- "description": "Creation time of this submission.. This may be unset if the student has not accessed this item. Read-only.",
+ "description": "Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.",
"type": "string"
},
"updateTime": {
@@ -2020,12 +2343,12 @@
"type": "boolean"
},
"draftGrade": {
- "description": "Optional pending grade. If unset, no grade was set. This must be an integer value. This is only visible to and modifiable by course teachers.",
+ "description": "Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.",
"format": "double",
"type": "number"
},
"assignedGrade": {
- "description": "Optional grade. If unset, no grade was set. This must be an integer value. This may be modified only by course teachers.",
+ "description": "Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.",
"format": "double",
"type": "number"
},
@@ -2057,7 +2380,7 @@
},
"multipleChoiceSubmission": {
"$ref": "MultipleChoiceSubmission",
- "description": "Submission content when course_work_type is MUTIPLE_CHOICE_QUESTION."
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
}
},
"type": "object"
@@ -2159,7 +2482,7 @@
"id": "ModifyAttachmentsRequest",
"properties": {
"addAttachments": {
- "description": "Attachments to add. This may only contain link attachments.",
+ "description": "Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.",
"items": {
"$ref": "Attachment"
},
« no previous file with comments | « discovery/googleapis/civicinfo__v2.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698