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.invitations.html b/docs/dyn/classroom_v1.invitations.html
index 3b6b5f3..ba9cb7c 100644
--- a/docs/dyn/classroom_v1.invitations.html
+++ b/docs/dyn/classroom_v1.invitations.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns an invitation.</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, courseId=None, userId=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(userId=None, pageToken=None, pageSize=None, courseId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of invitations that the requesting user is permitted to</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -142,7 +142,7 @@
* `PERMISSION_DENIED` if the requesting user is not permitted to create
invitations for this course or for access errors.
* `NOT_FOUND` if the course or the user does not exist.
-* `FAILED_PRECONDITION` if the requested user's account is disabled or if
+* `FAILED_PRECONDITION` if the requested user's account is disabled or if
the user already has this role or a role with greater permissions.
* `ALREADY_EXISTS` if an invitation for the specified user and course
already exists.
@@ -152,21 +152,21 @@
The object takes the form of:
{ # An invitation to join a course.
- "courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have.
- # Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # 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
- "id": "A String", # Identifier assigned by Classroom.
- #
- # Read-only.
- }
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "userId": "A String", # 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
+ "courseId": "A String", # Identifier of the course to invite the user to.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -177,21 +177,21 @@
An object of the form:
{ # An invitation to join a course.
- "courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have.
- # Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # 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
- "id": "A String", # Identifier assigned by Classroom.
- #
- # Read-only.
- }</pre>
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "userId": "A String", # 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
+ "courseId": "A String", # Identifier of the course to invite the user to.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
+ }</pre>
</div>
<div class="method">
@@ -247,25 +247,25 @@
An object of the form:
{ # An invitation to join a course.
- "courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have.
- # Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # 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
- "id": "A String", # Identifier assigned by Classroom.
- #
- # Read-only.
- }</pre>
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "userId": "A String", # 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
+ "courseId": "A String", # Identifier of the course to invite the user to.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, courseId=None, userId=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(userId=None, pageToken=None, pageSize=None, courseId=None, x__xgafv=None)</code>
<pre>Returns a list of invitations that the requesting user is permitted to
view, restricted to those that match the list request.
@@ -277,17 +277,12 @@
* `PERMISSION_DENIED` for access errors.
Args:
- pageSize: integer, Maximum number of items to return. Zero means no maximum.
-
-The server may return fewer than the specified number of results.
- courseId: string, Restricts returned invitations to those for a course with the specified
-identifier.
userId: string, Restricts returned invitations to those for a specific user. 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
+* the string literal `"me"`, indicating the requesting user
pageToken: string, nextPageToken
value returned from a previous
list call, indicating
@@ -295,6 +290,11 @@
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.
+ courseId: string, Restricts returned invitations to those for a course with the specified
+identifier.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -304,25 +304,25 @@
An object of the form:
{ # Response when listing invitations.
- "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.
- "invitations": [ # Invitations that match the list request.
+ "invitations": [ # Invitations that match the list request.
{ # An invitation to join a course.
- "courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have.
- # Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # 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
- "id": "A String", # Identifier assigned by Classroom.
- #
- # Read-only.
- },
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "userId": "A String", # 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
+ "courseId": "A String", # Identifier of the course to invite the user to.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
+ },
],
}</pre>
</div>
@@ -336,7 +336,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>