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/drive_v3.replies.html b/docs/dyn/drive_v3.replies.html
index 65ecd0c..71756d3 100644
--- a/docs/dyn/drive_v3.replies.html
+++ b/docs/dyn/drive_v3.replies.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(fileId, commentId, replyId, includeDeleted=None)</a></code></p>
<p class="firstline">Gets a reply by ID.</p>
<p class="toc_element">
- <code><a href="#list">list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(fileId, commentId, includeDeleted=None, pageSize=None, pageToken=None)</a></code></p>
<p class="firstline">Lists a comment's replies.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,24 +104,24 @@
The object takes the form of:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
}
@@ -129,24 +129,24 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
}</pre>
</div>
@@ -175,64 +175,64 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)</code>
- <pre>Lists a comment's replies.
+ <code class="details" id="list">list(fileId, commentId, includeDeleted=None, pageSize=None, pageToken=None)</code>
+ <pre>Lists a comment's replies.
Args:
fileId: string, The ID of the file. (required)
commentId: string, The ID of the comment. (required)
includeDeleted: boolean, Whether to include deleted replies. Deleted replies will not include their original content.
- pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
pageSize: integer, The maximum number of replies to return per page.
+ pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
Returns:
An object of the form:
{ # A list of replies to a comment on a file.
- "nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
- "kind": "drive#replyList", # Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
- "replies": [ # The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
+ "kind": "drive#replyList", # Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
+ "nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
+ "replies": [ # The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
},
],
}</pre>
@@ -247,7 +247,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>
@@ -264,24 +264,24 @@
The object takes the form of:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
}
@@ -289,24 +289,24 @@
An object of the form:
{ # A reply to a comment on a file.
- "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
- "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
- "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
- "me": True or False, # Whether this user is the requesting user.
- "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
- "displayName": "A String", # A plain text displayable name for this user.
- "permissionId": "A String", # The user's ID as visible in Permission resources.
- "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
- "photoLink": "A String", # A link to the user's profile photo, if available.
- },
- "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
- "htmlContent": "A String", # The content of the reply with HTML formatting.
- "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
- "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
- "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+ "action": "A String", # The action the reply performed to the parent comment. Valid values are:
# - resolve
# - reopen
- "id": "A String", # The ID of the reply.
+ "author": { # Information about a Drive user. # The author of the reply. The author's email address and permission ID will not be populated.
+ "displayName": "A String", # A plain text displayable name for this user.
+ "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+ "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+ "me": True or False, # Whether this user is the requesting user.
+ "permissionId": "A String", # The user's ID as visible in Permission resources.
+ "photoLink": "A String", # A link to the user's profile photo, if available.
+ },
+ "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+ "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+ "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+ "htmlContent": "A String", # The content of the reply with HTML formatting.
+ "id": "A String", # The ID of the reply.
+ "kind": "drive#reply", # Identifies what kind of resource this is. Value: the fixed string "drive#reply".
+ "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
}</pre>
</div>