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.topics.html b/docs/dyn/classroom_v1.courses.topics.html
index 061d16d..7bf206f 100644
--- a/docs/dyn/classroom_v1.courses.topics.html
+++ b/docs/dyn/classroom_v1.courses.topics.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a topic.</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 the list of topics that the requester is permitted to view.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -113,20 +113,20 @@
The object takes the form of:
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}
x__xgafv: string, V1 error format.
@@ -138,20 +138,20 @@
An object of the form:
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}</pre>
</div>
@@ -215,25 +215,25 @@
An object of the form:
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "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 the list of topics that the requester is permitted to view.
This method returns the following error codes:
@@ -247,10 +247,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 or unspecified indicates that the
-server may assign a maximum.
-
-The server may return fewer than the specified number of results.
pageToken: string, nextPageToken
value returned from a previous
list call,
@@ -258,6 +254,10 @@
The list request
must be otherwise identical to the one that resulted in this token.
+ pageSize: integer, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -267,25 +267,25 @@
An object of the form:
{ # Response when listing topics.
- "topic": [ # Topic items that match the request.
+ "topic": [ # Topic items that match the request.
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "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>
@@ -299,7 +299,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>
@@ -324,20 +324,20 @@
The object takes the form of:
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}
updateMask: string, Mask that identifies which fields on the topic to update.
@@ -360,20 +360,20 @@
An object of the form:
{ # Topic created by a teacher for the course
- "courseId": "A String", # Identifier of the course.
+ "updateTime": "A String", # The time the topic was last updated by the system.
#
# Read-only.
- "topicId": "A String", # Unique identifier for the topic.
- #
- # Read-only.
- "updateTime": "A String", # The time the topic was last updated by the system.
- #
- # Read-only.
- "name": "A String", # The name of the topic, generated by the user.
+ "name": "A String", # The name of the topic, generated by the user.
# Leading and trailing whitespaces, if any, are trimmed. Also, multiple
# consecutive whitespaces are collapsed into one inside the name. The
# result must be a non-empty string. Topic names are case sensitive, and must
# be no longer than 100 characters.
+ "topicId": "A String", # Unique identifier for the topic.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
}</pre>
</div>