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/blogger_v3.comments.html b/docs/dyn/blogger_v3.comments.html
index 536e5a0..0d8e3d6 100644
--- a/docs/dyn/blogger_v3.comments.html
+++ b/docs/dyn/blogger_v3.comments.html
@@ -81,13 +81,13 @@
<code><a href="#delete">delete(blogId, postId, commentId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a comment by blog id, post id and comment id.</p>
<p class="toc_element">
- <code><a href="#get">get(blogId, postId, commentId, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#get">get(blogId, postId, commentId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a comment by id.</p>
<p class="toc_element">
- <code><a href="#list">list(blogId, postId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
+ <code><a href="#list">list(blogId, postId, view=None, fetchBodies=None, status=None, endDate=None, startDate=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists comments.</p>
<p class="toc_element">
- <code><a href="#listByBlog">listByBlog(blogId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None)</a></code></p>
+ <code><a href="#listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, status=None, startDate=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists comments by blog.</p>
<p class="toc_element">
<code><a href="#listByBlog_next">listByBlog_next(previous_request, previous_response)</a></code></p>
@@ -119,30 +119,30 @@
An object of the form:
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
@@ -162,161 +162,161 @@
</div>
<div class="method">
- <code class="details" id="get">get(blogId, postId, commentId, x__xgafv=None, view=None)</code>
+ <code class="details" id="get">get(blogId, postId, commentId, view=None, x__xgafv=None)</code>
<pre>Gets a comment by id.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
commentId: string, A parameter (required)
+ view: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, A parameter
Returns:
An object of the form:
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(blogId, postId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
+ <code class="details" id="list">list(blogId, postId, view=None, fetchBodies=None, status=None, endDate=None, startDate=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists comments.
Args:
blogId: string, A parameter (required)
postId: string, A parameter (required)
- startDate: string, A parameter
+ view: string, A parameter
+ fetchBodies: boolean, A parameter
+ status: string, A parameter
endDate: string, A parameter
+ startDate: string, A parameter
+ maxResults: integer, A parameter
+ pageToken: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageToken: string, A parameter
- status: string, A parameter
- maxResults: integer, A parameter
- fetchBodies: boolean, A parameter
- view: string, A parameter
Returns:
An object of the form:
{
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # The List of Comments for a Post.
+ "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ "etag": "A String", # Etag of the response.
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+ "kind": "A String", # The kind of this entry. Always blogger#commentList.
+ "items": [ # The List of Comments for a Post.
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
- "kind": "A String", # The kind of this entry. Always blogger#commentList.
- "etag": "A String", # Etag of the response.
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
<div class="method">
- <code class="details" id="listByBlog">listByBlog(blogId, startDate=None, endDate=None, x__xgafv=None, pageToken=None, status=None, maxResults=None, fetchBodies=None)</code>
+ <code class="details" id="listByBlog">listByBlog(blogId, endDate=None, fetchBodies=None, maxResults=None, status=None, startDate=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists comments by blog.
Args:
blogId: string, A parameter (required)
- startDate: string, A parameter
endDate: string, A parameter
+ fetchBodies: boolean, A parameter
+ maxResults: integer, A parameter
+ status: string, A parameter (repeated)
+ startDate: string, A parameter
+ pageToken: string, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageToken: string, A parameter
- status: string, A parameter (repeated)
- maxResults: integer, A parameter
- fetchBodies: boolean, A parameter
Returns:
An object of the form:
{
- "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
- "items": [ # The List of Comments for a Post.
+ "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ "etag": "A String", # Etag of the response.
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
+ "kind": "A String", # The kind of this entry. Always blogger#commentList.
+ "items": [ # The List of Comments for a Post.
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
},
],
- "kind": "A String", # The kind of this entry. Always blogger#commentList.
- "etag": "A String", # Etag of the response.
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
}</pre>
</div>
@@ -329,7 +329,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>
@@ -343,7 +343,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>
@@ -365,30 +365,30 @@
An object of the form:
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>
@@ -409,30 +409,30 @@
An object of the form:
{
- "status": "A String", # The status of the comment (only populated for admin users).
- "inReplyTo": { # Data about the comment this is in reply to.
- "id": "A String", # The identified of the parent of this comment.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "id": "A String", # The identifier for this resource.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog containing this comment.
},
- "kind": "A String", # The kind of this entry. Always blogger#comment.
- "author": { # The author of this Comment.
- "url": "A String", # The URL of the creator's Profile page.
- "image": { # The creator's avatar.
- "url": "A String", # The creator's avatar URL.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "inReplyTo": { # Data about the comment this is in reply to.
+ "id": "A String", # The identified of the parent of this comment.
+ },
+ "updated": "A String", # RFC 3339 date-time when this comment was last updated.
+ "status": "A String", # The status of the comment (only populated for admin users).
+ "author": { # The author of this Comment.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
},
- "displayName": "A String", # The display name.
- "id": "A String", # The identifier of the creator.
+ "displayName": "A String", # The display name.
+ "url": "A String", # The URL of the creator's Profile page.
+ "id": "A String", # The identifier of the creator.
},
- "updated": "A String", # RFC 3339 date-time when this comment was last updated.
- "blog": { # Data about the blog containing this comment.
- "id": "A String", # The identifier of the blog containing this comment.
+ "post": { # Data about the post containing this comment.
+ "id": "A String", # The identifier of the post containing this comment.
},
- "published": "A String", # RFC 3339 date-time when this comment was published.
- "post": { # Data about the post containing this comment.
- "id": "A String", # The identifier of the post containing this comment.
- },
- "content": "A String", # The actual content of the comment. May include HTML markup.
- "id": "A String", # The identifier for this resource.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
}</pre>
</div>