docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html
index 33ed336..b5707a9 100644
--- a/docs/dyn/classroom_v1.courses.students.html
+++ b/docs/dyn/classroom_v1.courses.students.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student of a course.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of students of this course that the requester</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -99,7 +99,7 @@
* `PERMISSION_DENIED` if the requesting user is not permitted to create
students in this course or for access errors.
* `NOT_FOUND` if the requested course ID does not exist.
-* `FAILED_PRECONDITION` if the requested user's account is disabled,
+* `FAILED_PRECONDITION` if the requested user's account is disabled,
for the following request errors:
* CourseMemberLimitReached
* CourseNotModifiable
@@ -115,68 +115,68 @@
The object takes the form of:
{ # Student in a course.
- "profile": { # Global information for a user. # Global user information for the student.
+ "profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
- "name": { # Details of the user's name. # Name of the user.
+ "emailAddress": "A String", # Email address of the user.
#
# Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name
+ "photoUrl": "A String", # URL of user's profile photo.
+ #
+ # Read-only.
+ "permissions": [ # Global permissions of the user.
+ #
+ # Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "name": { # Details of the user's name. # Name of the user.
+ #
+ # Read-only.
+ "givenName": "A String", # The user's first name.
+ #
+ # Read-only.
+ "familyName": "A String", # The user's last name.
+ #
+ # Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
- "givenName": "A String", # The user's first name.
- #
- # Read-only.
- "familyName": "A String", # The user's last name.
- #
- # Read-only.
},
- "photoUrl": "A String", # URL of user's profile photo.
+ "id": "A String", # Identifier of the user.
#
# Read-only.
- "emailAddress": "A String", # Email address of the user.
- #
- # Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
+ "verifiedTeacher": True or False, # 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
- "id": "A String", # Identifier of the user.
- #
- # Read-only.
- "permissions": [ # Global permissions of the user.
- #
- # Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
},
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "title": "A String", # Title of the Drive folder.
#
# Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
+ "id": "A String", # Drive API resource ID.
},
- "userId": "A String", # Identifier of the user.
+ "userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this 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
+ # * the string literal `"me"`, indicating the requesting user
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}
enrollmentCode: string, Enrollment code of the course to create the student in.
@@ -192,68 +192,68 @@
An object of the form:
{ # Student in a course.
- "profile": { # Global information for a user. # Global user information for the student.
+ "profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
- "name": { # Details of the user's name. # Name of the user.
+ "emailAddress": "A String", # Email address of the user.
#
# Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name
+ "photoUrl": "A String", # URL of user's profile photo.
+ #
+ # Read-only.
+ "permissions": [ # Global permissions of the user.
+ #
+ # Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "name": { # Details of the user's name. # Name of the user.
+ #
+ # Read-only.
+ "givenName": "A String", # The user's first name.
+ #
+ # Read-only.
+ "familyName": "A String", # The user's last name.
+ #
+ # Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
- "givenName": "A String", # The user's first name.
- #
- # Read-only.
- "familyName": "A String", # The user's last name.
- #
- # Read-only.
},
- "photoUrl": "A String", # URL of user's profile photo.
+ "id": "A String", # Identifier of the user.
#
# Read-only.
- "emailAddress": "A String", # Email address of the user.
- #
- # Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
+ "verifiedTeacher": True or False, # 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
- "id": "A String", # Identifier of the user.
- #
- # Read-only.
- "permissions": [ # Global permissions of the user.
- #
- # Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
},
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "title": "A String", # Title of the Drive folder.
#
# Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
+ "id": "A String", # Drive API resource ID.
},
- "userId": "A String", # Identifier of the user.
+ "userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this 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
+ # * the string literal `"me"`, indicating the requesting user
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}</pre>
</div>
@@ -277,7 +277,7 @@
* the numeric identifier for the user
* the email address of the user
-* the string literal `"me"`, indicating the requesting user (required)
+* the string literal `"me"`, indicating the requesting user (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -318,7 +318,7 @@
* the numeric identifier for the user
* the email address of the user
-* the string literal `"me"`, indicating the requesting user (required)
+* the string literal `"me"`, indicating the requesting user (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -328,73 +328,73 @@
An object of the form:
{ # Student in a course.
- "profile": { # Global information for a user. # Global user information for the student.
+ "profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
- "name": { # Details of the user's name. # Name of the user.
+ "emailAddress": "A String", # Email address of the user.
#
# Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name
+ "photoUrl": "A String", # URL of user's profile photo.
+ #
+ # Read-only.
+ "permissions": [ # Global permissions of the user.
+ #
+ # Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "name": { # Details of the user's name. # Name of the user.
+ #
+ # Read-only.
+ "givenName": "A String", # The user's first name.
+ #
+ # Read-only.
+ "familyName": "A String", # The user's last name.
+ #
+ # Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
- "givenName": "A String", # The user's first name.
- #
- # Read-only.
- "familyName": "A String", # The user's last name.
- #
- # Read-only.
},
- "photoUrl": "A String", # URL of user's profile photo.
+ "id": "A String", # Identifier of the user.
#
# Read-only.
- "emailAddress": "A String", # Email address of the user.
- #
- # Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
+ "verifiedTeacher": True or False, # 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
- "id": "A String", # Identifier of the user.
- #
- # Read-only.
- "permissions": [ # Global permissions of the user.
- #
- # Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
},
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "title": "A String", # Title of the Drive folder.
#
# Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
+ "id": "A String", # Drive API resource ID.
},
- "userId": "A String", # Identifier of the user.
+ "userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this 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
+ # * the string literal `"me"`, indicating the requesting user
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Returns a list of students of this course that the requester
is permitted to view.
@@ -407,9 +407,6 @@
courseId: string, Identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
- pageSize: integer, Maximum number of items to return. Zero means no maximum.
-
-The server may return fewer than the specified number of results.
pageToken: string, nextPageToken
value returned from a previous
list call, indicating that
@@ -417,6 +414,9 @@
The list request must be
otherwise identical to the one that resulted in this token.
+ pageSize: integer, Maximum number of items to return. Zero means no maximum.
+
+The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -426,73 +426,73 @@
An object of the form:
{ # Response when listing students.
- "students": [ # Students who match the list request.
+ "students": [ # Students who match the list request.
{ # Student in a course.
- "profile": { # Global information for a user. # Global user information for the student.
+ "profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
- "name": { # Details of the user's name. # Name of the user.
+ "emailAddress": "A String", # Email address of the user.
#
# Read-only.
- "fullName": "A String", # The user's full name formed by concatenating the first and last name
+ "photoUrl": "A String", # URL of user's profile photo.
+ #
+ # Read-only.
+ "permissions": [ # Global permissions of the user.
+ #
+ # Read-only.
+ { # Global user permission description.
+ "permission": "A String", # Permission value.
+ },
+ ],
+ "name": { # Details of the user's name. # Name of the user.
+ #
+ # Read-only.
+ "givenName": "A String", # The user's first name.
+ #
+ # Read-only.
+ "familyName": "A String", # The user's last name.
+ #
+ # Read-only.
+ "fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
- "givenName": "A String", # The user's first name.
- #
- # Read-only.
- "familyName": "A String", # The user's last name.
- #
- # Read-only.
},
- "photoUrl": "A String", # URL of user's profile photo.
+ "id": "A String", # Identifier of the user.
#
# Read-only.
- "emailAddress": "A String", # Email address of the user.
- #
- # Read-only.
- "verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
+ "verifiedTeacher": True or False, # 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
- "id": "A String", # Identifier of the user.
- #
- # Read-only.
- "permissions": [ # Global permissions of the user.
- #
- # Read-only.
- { # Global user permission description.
- "permission": "A String", # Permission value.
- },
- ],
},
- "courseId": "A String", # Identifier of the course.
- #
- # Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ "title": "A String", # Title of the Drive folder.
#
# Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
+ "id": "A String", # Drive API resource ID.
},
- "userId": "A String", # Identifier of the user.
+ "userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this 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
+ # * the string literal `"me"`, indicating the requesting user
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
},
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
# results are available.
}</pre>
</div>
@@ -506,7 +506,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>