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_v2.posts.html b/docs/dyn/blogger_v2.posts.html
index 84e8b37..1ae854d 100644
--- a/docs/dyn/blogger_v2.posts.html
+++ b/docs/dyn/blogger_v2.posts.html
@@ -78,7 +78,7 @@
<code><a href="#get">get(blogId, postId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a post by blog id and post id</p>
<p class="toc_element">
- <code><a href="#list">list(blogId, startDate=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None)</a></code></p>
+ <code><a href="#list">list(blogId, fetchBodies=None, startDate=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists posts.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -100,85 +100,86 @@
An object of the form:
{
- "status": "A String", # Status of the post. Only set for admin-level requests.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "titleLink": "A String", # The title link URL, similar to atom's related link.
- "author": { # The author of this Post.
- "url": "A String", # The URL of the creator's Profile page.
- "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.
- },
- "url": "A String", # The URL where this Post is displayed.
- "readerComments": "A String", # Comment control and display setting for readers of this post.
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
+ "url": "A String", # The URL where this Post is displayed.
+ "etag": "A String", # Etag of the resource.
+ "status": "A String", # Status of the post. Only set for admin-level requests.
+ "customMetaData": "A String", # The JSON meta-data for the Post.
+ "replies": { # The container of comments on this Post.
+ "items": [ # The List of Comments for this 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.
+ "id": "A String", # The identifier for this resource.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "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).
+ "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.
- "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.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "author": { # The author of this Comment.
+ "id": "A String", # The identifier of the creator.
+ "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.
},
- "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.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog 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.
+ "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.
},
],
- "selfLink": "A String", # The URL of the comments on this post.
+ "selfLink": "A String", # The URL of the comments on this post.
+ "totalItems": "A String", # The count of comments on this post.
},
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "kind": "A String", # The kind of this entity. Always blogger#post.
- "content": "A String", # The content of the Post. May contain HTML markup.
- "etag": "A String", # Etag of the resource.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
+ "author": { # The author of this Post.
+ "id": "A String", # The identifier of the creator.
+ "url": "A String", # The URL of the creator's Profile page.
+ "displayName": "A String", # The display name.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
+ },
},
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "images": [ # Display image for the Post.
+ "location": { # The location for geotagged posts.
+ "name": "A String", # Location name.
+ "lat": 3.14, # Location's latitude.
+ "lng": 3.14, # Location's longitude.
+ "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
+ },
+ "published": "A String", # RFC 3339 date-time when this Post was published.
+ "titleLink": "A String", # The title link URL, similar to atom's related link.
+ "readerComments": "A String", # Comment control and display setting for readers of this post.
+ "labels": [ # The list of labels this Post was tagged with.
+ "A String",
+ ],
+ "title": "A String", # The title of the Post.
+ "updated": "A String", # RFC 3339 date-time when this Post was last updated.
+ "id": "A String", # The identifier of this Post.
+ "kind": "A String", # The kind of this entity. Always blogger#post.
+ "images": [ # Display image for the Post.
{
- "url": "A String",
+ "url": "A String",
},
],
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "content": "A String", # The content of the Post. May contain HTML markup.
+ "blog": { # Data about the blog containing this Post.
+ "id": "A String", # The identifier of the Blog that contains this Post.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(blogId, startDate=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None)</code>
+ <code class="details" id="list">list(blogId, fetchBodies=None, startDate=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists posts.
Args:
blogId: string, A parameter (required)
+ fetchBodies: boolean, A parameter
startDate: string, A parameter
maxResults: integer, A parameter
pageToken: string, A parameter
@@ -186,90 +187,89 @@
Allowed values
1 - v1 error format
2 - v2 error format
- 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 Posts for this Blog.
+ "kind": "A String", # The kind of this entity. Always blogger#postList.
+ "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ "etag": "A String", # Etag of the response.
+ "items": [ # The list of Posts for this Blog.
{
- "status": "A String", # Status of the post. Only set for admin-level requests.
- "blog": { # Data about the blog containing this Post.
- "id": "A String", # The identifier of the Blog that contains this Post.
- },
- "updated": "A String", # RFC 3339 date-time when this Post was last updated.
- "titleLink": "A String", # The title link URL, similar to atom's related link.
- "author": { # The author of this Post.
- "url": "A String", # The URL of the creator's Profile page.
- "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.
- },
- "url": "A String", # The URL where this Post is displayed.
- "readerComments": "A String", # Comment control and display setting for readers of this post.
- "labels": [ # The list of labels this Post was tagged with.
- "A String",
- ],
- "replies": { # The container of comments on this Post.
- "totalItems": "A String", # The count of comments on this post.
- "items": [ # The List of Comments for this Post.
+ "url": "A String", # The URL where this Post is displayed.
+ "etag": "A String", # Etag of the resource.
+ "status": "A String", # Status of the post. Only set for admin-level requests.
+ "customMetaData": "A String", # The JSON meta-data for the Post.
+ "replies": { # The container of comments on this Post.
+ "items": [ # The List of Comments for this 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.
+ "id": "A String", # The identifier for this resource.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "published": "A String", # RFC 3339 date-time when this comment was published.
+ "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).
+ "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.
- "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.
+ "kind": "A String", # The kind of this entry. Always blogger#comment.
+ "author": { # The author of this Comment.
+ "id": "A String", # The identifier of the creator.
+ "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.
},
- "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.
+ "content": "A String", # The actual content of the comment. May include HTML markup.
+ "blog": { # Data about the blog containing this comment.
+ "id": "A String", # The identifier of the blog 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.
+ "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.
},
],
- "selfLink": "A String", # The URL of the comments on this post.
+ "selfLink": "A String", # The URL of the comments on this post.
+ "totalItems": "A String", # The count of comments on this post.
},
- "customMetaData": "A String", # The JSON meta-data for the Post.
- "kind": "A String", # The kind of this entity. Always blogger#post.
- "content": "A String", # The content of the Post. May contain HTML markup.
- "etag": "A String", # Etag of the resource.
- "location": { # The location for geotagged posts.
- "lat": 3.14, # Location's latitude.
- "lng": 3.14, # Location's longitude.
- "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
- "name": "A String", # Location name.
+ "author": { # The author of this Post.
+ "id": "A String", # The identifier of the creator.
+ "url": "A String", # The URL of the creator's Profile page.
+ "displayName": "A String", # The display name.
+ "image": { # The creator's avatar.
+ "url": "A String", # The creator's avatar URL.
+ },
},
- "published": "A String", # RFC 3339 date-time when this Post was published.
- "images": [ # Display image for the Post.
+ "location": { # The location for geotagged posts.
+ "name": "A String", # Location name.
+ "lat": 3.14, # Location's latitude.
+ "lng": 3.14, # Location's longitude.
+ "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
+ },
+ "published": "A String", # RFC 3339 date-time when this Post was published.
+ "titleLink": "A String", # The title link URL, similar to atom's related link.
+ "readerComments": "A String", # Comment control and display setting for readers of this post.
+ "labels": [ # The list of labels this Post was tagged with.
+ "A String",
+ ],
+ "title": "A String", # The title of the Post.
+ "updated": "A String", # RFC 3339 date-time when this Post was last updated.
+ "id": "A String", # The identifier of this Post.
+ "kind": "A String", # The kind of this entity. Always blogger#post.
+ "images": [ # Display image for the Post.
{
- "url": "A String",
+ "url": "A String",
},
],
- "title": "A String", # The title of the Post.
- "id": "A String", # The identifier of this Post.
- "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "selfLink": "A String", # The API REST URL to fetch this resource from.
+ "content": "A String", # The content of the Post. May contain HTML markup.
+ "blog": { # Data about the blog containing this Post.
+ "id": "A String", # The identifier of the Blog that contains this Post.
+ },
},
],
- "kind": "A String", # The kind of this entity. Always blogger#postList.
- "etag": "A String", # Etag of the response.
- "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
+ "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
}</pre>
</div>
@@ -282,7 +282,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>