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/books_v1.layers.annotationData.html b/docs/dyn/books_v1.layers.annotationData.html
index 12163eb..579294e 100644
--- a/docs/dyn/books_v1.layers.annotationData.html
+++ b/docs/dyn/books_v1.layers.annotationData.html
@@ -75,17 +75,17 @@
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.layers.html">layers</a> . <a href="books_v1.layers.annotationData.html">annotationData</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, allowWebDefinitions=None, w=None, source=None, h=None, locale=None)</a></code></p>
+ <code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, allowWebDefinitions=None, h=None, locale=None, scale=None, source=None, w=None)</a></code></p>
<p class="firstline">Gets the annotation data.</p>
<p class="toc_element">
- <code><a href="#list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</a></code></p>
+ <code><a href="#list">list(volumeId, layerId, contentVersion, annotationDataId=None, h=None, locale=None, maxResults=None, pageToken=None, scale=None, source=None, updatedMax=None, updatedMin=None, w=None)</a></code></p>
<p class="firstline">Gets the annotation data for a volume and layer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, allowWebDefinitions=None, w=None, source=None, h=None, locale=None)</code>
+ <code class="details" id="get">get(volumeId, layerId, annotationDataId, contentVersion, allowWebDefinitions=None, h=None, locale=None, scale=None, source=None, w=None)</code>
<pre>Gets the annotation data.
Args:
@@ -93,68 +93,68 @@
layerId: string, The ID for the layer to get the annotations. (required)
annotationDataId: string, The ID of the annotation data to retrieve. (required)
contentVersion: string, The content version for the volume you are trying to retrieve. (required)
- scale: integer, The requested scale for the image.
allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions.
- w: integer, The requested pixel width for any images. If width is provided height must also be provided.
- source: string, String to identify the originator of this request.
h: integer, The requested pixel height for any images. If height is provided width must also be provided.
- locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+ locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+ scale: integer, The requested scale for the image.
+ source: string, String to identify the originator of this request.
+ w: integer, The requested pixel width for any images. If width is provided height must also be provided.
Returns:
An object of the form:
{
- "annotationType": "A String", # The type of annotation this data is for.
- "kind": "books#annotationdata", # Resource Type
- "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- "volumeId": "A String", # The volume id for this data. *
- "encoded_data": "A String", # Base64 encoded data for this annotation data.
- "layerId": "A String", # The Layer id for this data. *
- "data": "",
- "id": "A String", # Unique id for this annotation data.
- "selfLink": "A String", # URL for this resource. *
+ "annotationType": "A String", # The type of annotation this data is for.
+ "data": "",
+ "encoded_data": "A String", # Base64 encoded data for this annotation data.
+ "id": "A String", # Unique id for this annotation data.
+ "kind": "books#annotationdata", # Resource Type
+ "layerId": "A String", # The Layer id for this data. *
+ "selfLink": "A String", # URL for this resource. *
+ "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
+ "volumeId": "A String", # The volume id for this data. *
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</code>
+ <code class="details" id="list">list(volumeId, layerId, contentVersion, annotationDataId=None, h=None, locale=None, maxResults=None, pageToken=None, scale=None, source=None, updatedMax=None, updatedMin=None, w=None)</code>
<pre>Gets the annotation data for a volume and layer.
Args:
volumeId: string, The volume to retrieve annotation data for. (required)
layerId: string, The ID for the layer to get the annotation data. (required)
contentVersion: string, The content version for the requested volume. (required)
- locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- scale: integer, The requested scale for the image.
+ annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
+ h: integer, The requested pixel height for any images. If height is provided width must also be provided.
+ locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+ maxResults: integer, Maximum number of results to return
pageToken: string, The value of the nextToken from the previous page.
- updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+ scale: integer, The requested scale for the image.
source: string, String to identify the originator of this request.
updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- maxResults: integer, Maximum number of results to return
- annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
+ updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
w: integer, The requested pixel width for any images. If width is provided height must also be provided.
- h: integer, The requested pixel height for any images. If height is provided width must also be provided.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
- "items": [ # A list of Annotation Data.
+ "items": [ # A list of Annotation Data.
{
- "annotationType": "A String", # The type of annotation this data is for.
- "kind": "books#annotationdata", # Resource Type
- "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- "volumeId": "A String", # The volume id for this data. *
- "encoded_data": "A String", # Base64 encoded data for this annotation data.
- "layerId": "A String", # The Layer id for this data. *
- "data": "",
- "id": "A String", # Unique id for this annotation data.
- "selfLink": "A String", # URL for this resource. *
+ "annotationType": "A String", # The type of annotation this data is for.
+ "data": "",
+ "encoded_data": "A String", # Base64 encoded data for this annotation data.
+ "id": "A String", # Unique id for this annotation data.
+ "kind": "books#annotationdata", # Resource Type
+ "layerId": "A String", # The Layer id for this data. *
+ "selfLink": "A String", # URL for this resource. *
+ "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
+ "volumeId": "A String", # The volume id for this data. *
},
],
- "kind": "books#annotationsdata", # Resource type
- "totalItems": 42, # The total number of volume annotations found.
+ "kind": "books#annotationsdata", # Resource type
+ "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
+ "totalItems": 42, # The total number of volume annotations found.
}</pre>
</div>
@@ -167,7 +167,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>