Skip to content

Commit

Permalink
fix(classroom): update the API
Browse files Browse the repository at this point in the history
#### classroom:v1

The following keys were changed:
- resources.courses.methods.create.description
- schemas.UserProfile.properties.emailAddress.description
- schemas.UserProfile.properties.photoUrl.description
- schemas.UserProfile.properties.verifiedTeacher.description
  • Loading branch information
yoshi-automation authored and sofisl committed Feb 2, 2023
1 parent 4b307dc commit 55e7f4b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions discovery/classroom-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@
"courses": {
"methods": {
"create": {
"description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
"description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
"flatPath": "v1/courses",
"httpMethod": "POST",
"id": "classroom.courses.create",
Expand Down Expand Up @@ -2400,7 +2400,7 @@
}
}
},
"revision": "20221220",
"revision": "20230129",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"Announcement": {
Expand Down Expand Up @@ -4054,7 +4054,7 @@
"id": "UserProfile",
"properties": {
"emailAddress": {
"description": "Email address of the user. Read-only.",
"description": "Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.",
"type": "string"
},
"id": {
Expand All @@ -4073,11 +4073,11 @@
"type": "array"
},
"photoUrl": {
"description": "URL of user's profile photo. Read-only.",
"description": "URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.",
"type": "string"
},
"verifiedTeacher": {
"description": "Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only",
"description": "Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only",
"type": "boolean"
}
},
Expand Down
8 changes: 4 additions & 4 deletions src/apis/classroom/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1296,7 +1296,7 @@ export namespace classroom_v1 {
*/
export interface Schema$UserProfile {
/**
* Email address of the user. Read-only.
* Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
*/
emailAddress?: string | null;
/**
Expand All @@ -1312,11 +1312,11 @@ export namespace classroom_v1 {
*/
permissions?: Schema$GlobalPermission[];
/**
* URL of user's profile photo. Read-only.
* URL of user's profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
*/
photoUrl?: string | null;
/**
* Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only
* Represents whether a Google Workspace for Education user's domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
*/
verifiedTeacher?: boolean | null;
}
Expand Down Expand Up @@ -1365,7 +1365,7 @@ export namespace classroom_v1 {
}

/**
* Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
* Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserCannotOwnCourse * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
* @example
* ```js
* // Before running the sample:
Expand Down

0 comments on commit 55e7f4b

Please sign in to comment.