docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/poly_v1.assets.html b/docs/dyn/poly_v1.assets.html
index b4df96c..ab5f866 100644
--- a/docs/dyn/poly_v1.assets.html
+++ b/docs/dyn/poly_v1.assets.html
@@ -75,16 +75,24 @@
<h1><a href="poly_v1.html">Poly API</a> . <a href="poly_v1.assets.html">assets</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(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns detailed information about an asset given its name.</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, pageToken=None, category=None, keywords=None, format=None, orderBy=None, maxComplexity=None, curated=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(keywords=None, pageToken=None, format=None, category=None, pageSize=None, maxComplexity=None, curated=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all public, remixable assets. These are assets with an access level</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(name, x__xgafv=None)</code>
<pre>Returns detailed information about an asset given its name.
PRIVATE assets are returned only if
@@ -105,16 +113,6 @@
# or scene created using [Tilt Brush](//www.tiltbrush.com),
# [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file
# that can be upload to Poly.
- "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
- # create this asset).
- "sourceAsset": [ # Resource ids for the sources of this remix, of the form:
- # `assets/{ASSET_ID}`
- "A String",
- ],
- },
- "license": "A String", # The license under which the author has made the asset available
- # for use, if any.
- "displayName": "A String", # The human-readable name, set by the asset's author.
"presentationParams": { # Hints for displaying the asset, based on information available when the asset # Hints for displaying the asset. Note that these parameters are not
# immutable; the author of an asset may change them post-publication.
# was uploaded.
@@ -136,10 +134,10 @@
# Please note: this is applicable only to the gLTF.
# response you see "w: 1" and nothing else this is the default value of
# [0, 0, 0, 1] where x,y, and z are 0.
- "x": 3.14, # The x component.
"z": 3.14, # The z component.
"y": 3.14, # The y component.
"w": 3.14, # The scalar component.
+ "x": 3.14, # The x component.
},
"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a
# 'thumbnail' or 'palette' style view. Authors have the option to set this
@@ -150,33 +148,26 @@
"colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors
# or texture maps.
},
- "visibility": "A String", # The visibility of the asset and who can access it.
- "description": "A String", # The human-readable description, set by the asset's author.
- "updateTime": "A String", # The time when the asset was last modified. For published assets, whose
- # contents are immutable, the update time changes only when metadata
- # properties, such as visibility, are updated.
+ "isCurated": True or False, # Whether this asset has been curated by the Poly team.
"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only
# returned when querying for the signed-in user's own assets, not for public
# assets. This string is limited to 1K chars. It is up to the creator of
# the asset to define the format for this string (for example, JSON).
- "createTime": "A String", # For published assets, the time when the asset was published.
- # For unpublished assets, the time when the asset was created.
- "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the
- # author. For more information, see [Licensing](/poly/discover/licensing).
"name": "A String", # The unique identifier for the asset in the form:
# `assets/{ASSET_ID}`.
- "isCurated": True or False, # Whether this asset has been curated by the Poly team.
- "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
- # resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
- "relativePath": "A String", # The path of the resource file relative to the
- # root file. For root or thumbnail files,
- # this is just the filename.
- "contentType": "A String", # The MIME content-type, such as `image/png`.
- # For more information, see
- # [MIME
- # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
+ # create this asset).
+ "sourceAsset": [ # Resource ids for the sources of this remix, of the form:
+ # `assets/{ASSET_ID}`
+ "A String",
+ ],
},
+ "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the
+ # author. For more information, see [Licensing](/poly/discover/licensing).
+ "license": "A String", # The license under which the author has made the asset available
+ # for use, if any.
+ "createTime": "A String", # For published assets, the time when the asset was published.
+ # For unpublished assets, the time when the asset was created.
"formats": [ # A list of Formats where each
# format describes one representation of the asset.
{ # The same asset can be represented in different formats, for example,
@@ -185,13 +176,18 @@
# with its corresponding .glb binary data. A format refers to a specific
# representation of an asset and contains all information needed to
# retrieve and describe this representation.
- "formatType": "A String", # A short string that identifies the format type of this representation.
- # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
+ "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
+ "triangleCount": "A String", # The estimated number of triangles.
+ "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this
+ # format relative to other formats of the same asset with the same
+ # format_type.
+ # This hint allows you to sort formats from the most-detailed (0) to
+ # least-detailed (integers greater than 0).
+ },
"resources": [ # A list of dependencies of the root element. May include, but is not
# limited to, materials, textures, and shader programs.
{ # Represents a file in Poly, which can be a root,
# resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
"relativePath": "A String", # The path of the resource file relative to the
# root file. For root or thumbnail files,
# this is just the filename.
@@ -199,6 +195,7 @@
# For more information, see
# [MIME
# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
},
],
"root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.
@@ -208,7 +205,6 @@
# Other types - such as `OBJ` - often reference other data elements.
# These are contained in the resources field.
# resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
"relativePath": "A String", # The path of the resource file relative to the
# root file. For root or thumbnail files,
# this is just the filename.
@@ -216,50 +212,62 @@
# For more information, see
# [MIME
# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
},
- "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
- "triangleCount": "A String", # The estimated number of triangles.
- "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this
- # format relative to other formats of the same asset with the same
- # format_type.
- # This hint allows you to sort formats from the most-detailed (0) to
- # least-detailed (integers greater than 0).
- },
+ "formatType": "A String", # A short string that identifies the format type of this representation.
+ # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
},
],
+ "visibility": "A String", # The visibility of the asset and who can access it.
+ "updateTime": "A String", # The time when the asset was last modified. For published assets, whose
+ # contents are immutable, the update time changes only when metadata
+ # properties, such as visibility, are updated.
+ "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
+ # resource, or thumbnail file.
+ "relativePath": "A String", # The path of the resource file relative to the
+ # root file. For root or thumbnail files,
+ # this is just the filename.
+ "contentType": "A String", # The MIME content-type, such as `image/png`.
+ # For more information, see
+ # [MIME
+ # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
+ },
+ "description": "A String", # The human-readable description, set by the asset's author.
+ "displayName": "A String", # The human-readable name, set by the asset's author.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, pageToken=None, category=None, keywords=None, format=None, orderBy=None, maxComplexity=None, curated=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(keywords=None, pageToken=None, format=None, category=None, pageSize=None, maxComplexity=None, curated=None, orderBy=None, x__xgafv=None)</code>
<pre>Lists all public, remixable assets. These are assets with an access level
of PUBLIC and published under the
CC-By license.
Args:
- pageSize: integer, The maximum number of assets to be returned. This value must be between `1`
-and `100`. Defaults to `20`.
- pageToken: string, Specifies a continuation token from a previous search whose results were
-split into multiple pages. To get the next page, submit the same request
-specifying the value from
-next_page_token.
- category: string, Filter assets based on the specified category. Supported values are:
-`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`,
-`scenes`, `technology`, and `transport`.
keywords: string, One or more search terms to be matched against all text that Poly has
indexed for assets, which includes display_name,
description, and tags. Multiple keywords should be
separated by spaces.
+ pageToken: string, Specifies a continuation token from a previous search whose results were
+split into multiple pages. To get the next page, submit the same request
+specifying the value from
+next_page_token.
format: string, Return only assets with the matching format. Acceptable values are:
`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
- orderBy: string, Specifies an ordering for assets. Acceptable values are:
-`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets
-based on a combination of popularity and other features.
+ category: string, Filter assets based on the specified category. Supported values are:
+`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`,
+`scenes`, `technology`, and `transport`.
+ pageSize: integer, The maximum number of assets to be returned. This value must be between `1`
+and `100`. Defaults to `20`.
maxComplexity: string, Returns assets that are of the specified complexity or less. Defaults to
COMPLEX. For example, a request for
MEDIUM assets also includes
SIMPLE assets.
curated: boolean, Return only assets that have been curated by the Poly team.
+ orderBy: string, Specifies an ordering for assets. Acceptable values are:
+`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets
+based on a combination of popularity and other features.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -269,21 +277,15 @@
An object of the form:
{ # A response message from a request to list.
+ "nextPageToken": "A String", # The continuation token for retrieving the next page. If empty,
+ # indicates that there are no more pages. To get the next page, submit the
+ # same request specifying this value as the
+ # page_token.
"assets": [ # A list of assets that match the criteria specified in the request.
{ # Represents and describes an asset in the Poly library. An asset is a 3D model
# or scene created using [Tilt Brush](//www.tiltbrush.com),
# [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file
# that can be upload to Poly.
- "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
- # create this asset).
- "sourceAsset": [ # Resource ids for the sources of this remix, of the form:
- # `assets/{ASSET_ID}`
- "A String",
- ],
- },
- "license": "A String", # The license under which the author has made the asset available
- # for use, if any.
- "displayName": "A String", # The human-readable name, set by the asset's author.
"presentationParams": { # Hints for displaying the asset, based on information available when the asset # Hints for displaying the asset. Note that these parameters are not
# immutable; the author of an asset may change them post-publication.
# was uploaded.
@@ -305,10 +307,10 @@
# Please note: this is applicable only to the gLTF.
# response you see "w: 1" and nothing else this is the default value of
# [0, 0, 0, 1] where x,y, and z are 0.
- "x": 3.14, # The x component.
"z": 3.14, # The z component.
"y": 3.14, # The y component.
"w": 3.14, # The scalar component.
+ "x": 3.14, # The x component.
},
"backgroundColor": "A String", # A background color which could be used for displaying the 3D asset in a
# 'thumbnail' or 'palette' style view. Authors have the option to set this
@@ -319,33 +321,26 @@
"colorSpace": "A String", # The materials' diffuse/albedo color. This does not apply to vertex colors
# or texture maps.
},
- "visibility": "A String", # The visibility of the asset and who can access it.
- "description": "A String", # The human-readable description, set by the asset's author.
- "updateTime": "A String", # The time when the asset was last modified. For published assets, whose
- # contents are immutable, the update time changes only when metadata
- # properties, such as visibility, are updated.
+ "isCurated": True or False, # Whether this asset has been curated by the Poly team.
"metadata": "A String", # Application-defined opaque metadata for this asset. This field is only
# returned when querying for the signed-in user's own assets, not for public
# assets. This string is limited to 1K chars. It is up to the creator of
# the asset to define the format for this string (for example, JSON).
- "createTime": "A String", # For published assets, the time when the asset was published.
- # For unpublished assets, the time when the asset was created.
- "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the
- # author. For more information, see [Licensing](/poly/discover/licensing).
"name": "A String", # The unique identifier for the asset in the form:
# `assets/{ASSET_ID}`.
- "isCurated": True or False, # Whether this asset has been curated by the Poly team.
- "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
- # resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
- "relativePath": "A String", # The path of the resource file relative to the
- # root file. For root or thumbnail files,
- # this is just the filename.
- "contentType": "A String", # The MIME content-type, such as `image/png`.
- # For more information, see
- # [MIME
- # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "remixInfo": { # Info about the sources of this asset (i.e. assets that were remixed to # The remix info for the asset.
+ # create this asset).
+ "sourceAsset": [ # Resource ids for the sources of this remix, of the form:
+ # `assets/{ASSET_ID}`
+ "A String",
+ ],
},
+ "authorName": "A String", # The author's publicly visible name. Use this name when giving credit to the
+ # author. For more information, see [Licensing](/poly/discover/licensing).
+ "license": "A String", # The license under which the author has made the asset available
+ # for use, if any.
+ "createTime": "A String", # For published assets, the time when the asset was published.
+ # For unpublished assets, the time when the asset was created.
"formats": [ # A list of Formats where each
# format describes one representation of the asset.
{ # The same asset can be represented in different formats, for example,
@@ -354,13 +349,18 @@
# with its corresponding .glb binary data. A format refers to a specific
# representation of an asset and contains all information needed to
# retrieve and describe this representation.
- "formatType": "A String", # A short string that identifies the format type of this representation.
- # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
+ "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
+ "triangleCount": "A String", # The estimated number of triangles.
+ "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this
+ # format relative to other formats of the same asset with the same
+ # format_type.
+ # This hint allows you to sort formats from the most-detailed (0) to
+ # least-detailed (integers greater than 0).
+ },
"resources": [ # A list of dependencies of the root element. May include, but is not
# limited to, materials, textures, and shader programs.
{ # Represents a file in Poly, which can be a root,
# resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
"relativePath": "A String", # The path of the resource file relative to the
# root file. For root or thumbnail files,
# this is just the filename.
@@ -368,6 +368,7 @@
# For more information, see
# [MIME
# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
},
],
"root": { # Represents a file in Poly, which can be a root, # The root of the file hierarchy. This will always be populated.
@@ -377,7 +378,6 @@
# Other types - such as `OBJ` - often reference other data elements.
# These are contained in the resources field.
# resource, or thumbnail file.
- "url": "A String", # The URL where the file data can be retrieved.
"relativePath": "A String", # The path of the resource file relative to the
# root file. For root or thumbnail files,
# this is just the filename.
@@ -385,24 +385,32 @@
# For more information, see
# [MIME
# types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
},
- "formatComplexity": { # Information on the complexity of this Format. # Complexity stats about this representation of the asset.
- "triangleCount": "A String", # The estimated number of triangles.
- "lodHint": 42, # A non-negative integer that represents the level of detail (LOD) of this
- # format relative to other formats of the same asset with the same
- # format_type.
- # This hint allows you to sort formats from the most-detailed (0) to
- # least-detailed (integers greater than 0).
- },
+ "formatType": "A String", # A short string that identifies the format type of this representation.
+ # Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
},
],
+ "visibility": "A String", # The visibility of the asset and who can access it.
+ "updateTime": "A String", # The time when the asset was last modified. For published assets, whose
+ # contents are immutable, the update time changes only when metadata
+ # properties, such as visibility, are updated.
+ "thumbnail": { # Represents a file in Poly, which can be a root, # The thumbnail image for the asset.
+ # resource, or thumbnail file.
+ "relativePath": "A String", # The path of the resource file relative to the
+ # root file. For root or thumbnail files,
+ # this is just the filename.
+ "contentType": "A String", # The MIME content-type, such as `image/png`.
+ # For more information, see
+ # [MIME
+ # types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
+ "url": "A String", # The URL where the file data can be retrieved.
+ },
+ "description": "A String", # The human-readable description, set by the asset's author.
+ "displayName": "A String", # The human-readable name, set by the asset's author.
},
],
"totalSize": 42, # The total number of assets in the list, without pagination.
- "nextPageToken": "A String", # The continuation token for retrieving the next page. If empty,
- # indicates that there are no more pages. To get the next page, submit the
- # same request specifying this value as the
- # page_token.
}</pre>
</div>