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.revisions.html b/docs/dyn/drive_v3.revisions.html
index 41e4dab..9ba4a62 100644
--- a/docs/dyn/drive_v3.revisions.html
+++ b/docs/dyn/drive_v3.revisions.html
@@ -84,7 +84,7 @@
<code><a href="#get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</a></code></p>
<p class="firstline">Gets a revision's metadata or content by ID.</p>
<p class="toc_element">
- <code><a href="#list">list(fileId, pageToken=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(fileId, pageSize=None, pageToken=None)</a></code></p>
<p class="firstline">Lists a file's revisions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -95,7 +95,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(fileId, revisionId)</code>
- <pre>Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.
+ <pre>Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.
Args:
fileId: string, The ID of the file. (required)
@@ -105,7 +105,7 @@
<div class="method">
<code class="details" id="get">get(fileId, revisionId, acknowledgeAbuse=None)</code>
- <pre>Gets a revision's metadata or content by ID.
+ <pre>Gets a revision's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
@@ -116,35 +116,35 @@
An object of the form:
{ # The metadata for a revision to a file.
- "mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
- "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
- "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
- "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.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
},
- "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+ "id": "A String", # The ID of the revision.
+ "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
- "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+ "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.
},
- "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
- "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+ "mimeType": "A String", # The MIME type of the revision.
+ "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+ "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+ "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+ "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+ "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(fileId, revisionId, acknowledgeAbuse=None)</code>
- <pre>Gets a revision's metadata or content by ID.
+ <pre>Gets a revision's metadata or content by ID.
Args:
fileId: string, The ID of the file. (required)
@@ -158,45 +158,45 @@
</div>
<div class="method">
- <code class="details" id="list">list(fileId, pageToken=None, pageSize=None)</code>
- <pre>Lists a file's revisions.
+ <code class="details" id="list">list(fileId, pageSize=None, pageToken=None)</code>
+ <pre>Lists a file's revisions.
Args:
fileId: string, The ID of the file. (required)
- 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 revisions 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 revisions of a file.
- "nextPageToken": "A String", # The page token for the next page of revisions. This will be absent if the end of the revisions 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#revisionList", # Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
- "revisions": [ # The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
+ "kind": "drive#revisionList", # Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
+ "nextPageToken": "A String", # The page token for the next page of revisions. This will be absent if the end of the revisions 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.
+ "revisions": [ # The list of revisions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # The metadata for a revision to a file.
- "mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
- "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
- "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
- "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.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
},
- "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+ "id": "A String", # The ID of the revision.
+ "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
- "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+ "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.
},
- "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
- "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+ "mimeType": "A String", # The MIME type of the revision.
+ "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+ "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+ "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+ "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+ "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
},
],
}</pre>
@@ -211,7 +211,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>
@@ -227,29 +227,29 @@
The object takes the form of:
{ # The metadata for a revision to a file.
- "mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
- "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
- "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
- "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.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
},
- "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+ "id": "A String", # The ID of the revision.
+ "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
- "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+ "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.
},
- "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
- "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+ "mimeType": "A String", # The MIME type of the revision.
+ "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+ "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+ "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+ "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+ "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}
@@ -257,29 +257,29 @@
An object of the form:
{ # The metadata for a revision to a file.
- "mimeType": "A String", # The MIME type of the revision.
- "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
- "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
- "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
- "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.
+ "exportLinks": { # Links for exporting Google Docs to specific formats.
+ "a_key": "A String", # A mapping from export format to URL
},
- "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+ "id": "A String", # The ID of the revision.
+ "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
# This field is only applicable to files with binary content in Drive.
- "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
- "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
- "exportLinks": { # Links for exporting Google Docs to specific formats.
- "a_key": "A String", # A mapping from export format to URL
+ "kind": "drive#revision", # Identifies what kind of resource this is. Value: the fixed string "drive#revision".
+ "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+ "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.
},
- "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
- "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
- "id": "A String", # The ID of the revision.
- "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
- "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+ "mimeType": "A String", # The MIME type of the revision.
+ "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+ "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+ "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+ "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+ "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+ "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
}</pre>
</div>