docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/books_v1.layers.volumeAnnotations.html b/docs/dyn/books_v1.layers.volumeAnnotations.html
index 71bcc70..4dcf6ce 100644
--- a/docs/dyn/books_v1.layers.volumeAnnotations.html
+++ b/docs/dyn/books_v1.layers.volumeAnnotations.html
@@ -75,16 +75,24 @@
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.layers.html">layers</a> . <a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#get">get(volumeId, layerId, annotationId, source=None, locale=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the volume annotation.</p>
<p class="toc_element">
- <code><a href="#list">list(volumeId, layerId, updatedMin=None, showDeleted=None, endOffset=None, contentVersion=None, pageToken=None, updatedMax=None, volumeAnnotationsVersion=None, endPosition=None, maxResults=None, source=None, startOffset=None, startPosition=None, locale=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(volumeId, layerId, startOffset=None, locale=None, endOffset=None, source=None, contentVersion=None, startPosition=None, showDeleted=None, volumeAnnotationsVersion=None, endPosition=None, updatedMin=None, updatedMax=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the volume annotations 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="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(volumeId, layerId, annotationId, source=None, locale=None, x__xgafv=None)</code>
<pre>Gets the volume annotation.
@@ -103,65 +111,65 @@
An object of the form:
{
+ "annotationType": "A String", # The type of annotation this is.
"selfLink": "A String", # URL to this resource.
- "volumeId": "A String", # The Volume this annotation is for.
- "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
- "annotationDataId": "A String", # The annotation data id for this volume annotation.
- "annotationDataLink": "A String", # Link to get data for this annotation.
"pageIds": [ # Pages the annotation spans.
"A String",
],
- "layerId": "A String", # The Layer this annotation is for.
- "id": "A String", # Unique id of this volume annotation.
- "annotationType": "A String", # The type of annotation this is.
- "kind": "A String", # Resource Type
- "selectedText": "A String", # Excerpt from the volume.
- "data": "A String", # Data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
"contentRanges": { # The content ranges to identify the selected text.
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- "endOffset": "A String", # The offset from the ending position.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- "endOffset": "A String", # The offset from the ending position.
- },
"cfiRange": { # Range in CFI format for this annotation for version above.
"endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
"startPosition": "A String", # The starting position for the range.
"endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
+ },
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
},
},
+ "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
+ "annotationDataId": "A String", # The annotation data id for this volume annotation.
+ "kind": "A String", # Resource Type
+ "layerId": "A String", # The Layer this annotation is for.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Unique id of this volume annotation.
+ "volumeId": "A String", # The Volume this annotation is for.
+ "annotationDataLink": "A String", # Link to get data for this annotation.
+ "data": "A String", # Data for this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(volumeId, layerId, updatedMin=None, showDeleted=None, endOffset=None, contentVersion=None, pageToken=None, updatedMax=None, volumeAnnotationsVersion=None, endPosition=None, maxResults=None, source=None, startOffset=None, startPosition=None, locale=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(volumeId, layerId, startOffset=None, locale=None, endOffset=None, source=None, contentVersion=None, startPosition=None, showDeleted=None, volumeAnnotationsVersion=None, endPosition=None, updatedMin=None, updatedMax=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
<pre>Gets the volume annotations for a volume and layer.
Args:
volumeId: string, The volume to retrieve annotations for. (required)
layerId: string, The ID for the layer to get the annotations. (required)
- updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
+ startOffset: string, The start offset to start retrieving data from.
+ locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
endOffset: string, The end offset to end retrieving data from.
+ source: string, String to identify the originator of this request.
contentVersion: string, The content version for the requested volume.
- pageToken: string, The value of the nextToken from the previous page.
- updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
+ startPosition: string, The start position to start retrieving data from.
+ showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.
endPosition: string, The end position to end retrieving data from.
+ updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
+ updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
maxResults: integer, Maximum number of results to return
- source: string, String to identify the originator of this request.
- startOffset: string, The start offset to start retrieving data from.
- startPosition: string, The start position to start retrieving data from.
- locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
+ pageToken: string, The value of the nextToken from the previous page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -173,48 +181,48 @@
{
"items": [ # A list of volume annotations.
{
+ "annotationType": "A String", # The type of annotation this is.
"selfLink": "A String", # URL to this resource.
- "volumeId": "A String", # The Volume this annotation is for.
- "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
- "annotationDataId": "A String", # The annotation data id for this volume annotation.
- "annotationDataLink": "A String", # Link to get data for this annotation.
"pageIds": [ # Pages the annotation spans.
"A String",
],
- "layerId": "A String", # The Layer this annotation is for.
- "id": "A String", # Unique id of this volume annotation.
- "annotationType": "A String", # The type of annotation this is.
- "kind": "A String", # Resource Type
- "selectedText": "A String", # Excerpt from the volume.
- "data": "A String", # Data for this annotation.
- "deleted": True or False, # Indicates that this annotation is deleted.
"contentRanges": { # The content ranges to identify the selected text.
- "gbTextRange": { # Range in GB text format for this annotation for version above.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- "endOffset": "A String", # The offset from the ending position.
- },
- "contentVersion": "A String", # Content version applicable to ranges below.
- "gbImageRange": { # Range in GB image format for this annotation for version above.
- "endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
- "startPosition": "A String", # The starting position for the range.
- "endOffset": "A String", # The offset from the ending position.
- },
"cfiRange": { # Range in CFI format for this annotation for version above.
"endPosition": "A String", # The ending position for the range.
- "startOffset": "A String", # The offset from the starting position.
"startPosition": "A String", # The starting position for the range.
"endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
+ },
+ "gbImageRange": { # Range in GB image format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
+ },
+ "contentVersion": "A String", # Content version applicable to ranges below.
+ "gbTextRange": { # Range in GB text format for this annotation for version above.
+ "endPosition": "A String", # The ending position for the range.
+ "startPosition": "A String", # The starting position for the range.
+ "endOffset": "A String", # The offset from the ending position.
+ "startOffset": "A String", # The offset from the starting position.
},
},
+ "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
+ "annotationDataId": "A String", # The annotation data id for this volume annotation.
+ "kind": "A String", # Resource Type
+ "layerId": "A String", # The Layer this annotation is for.
+ "selectedText": "A String", # Excerpt from the volume.
+ "id": "A String", # Unique id of this volume annotation.
+ "volumeId": "A String", # The Volume this annotation is for.
+ "annotationDataLink": "A String", # Link to get data for this annotation.
+ "data": "A String", # Data for this annotation.
+ "deleted": True or False, # Indicates that this annotation is deleted.
},
],
- "version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
- "kind": "A String", # Resource type
"totalItems": 42, # The total number of volume annotations found.
+ "version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
"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.
+ "kind": "A String", # Resource type
}</pre>
</div>