Skip to content
Permalink
Browse files

docs: update generated docs (#1053)

Updates for both discovery docs and epydoc API Documentation

Fixes: #1049
  • Loading branch information
DFrenkel committed Oct 6, 2020
1 parent a527de2 commit 3e17f8990db54bec16c48c319072799a14f5a53f
Showing 2,591 changed files with 496,713 additions and 1,099,613 deletions.
@@ -84,10 +84,18 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the violatingSites Resource.</p>

<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="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</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="new_batch_http_request">new_batch_http_request()</code>
<pre>Create a BatchHttpRequest object based on the discovery document.
@@ -74,19 +74,24 @@

<h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a> . <a href="abusiveexperiencereport_v1.sites.html">sites</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">Gets a site's Abusive Experience Report summary.</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>Gets a site&#x27;s Abusive Experience Report summary.

Args:
name: string, Required. The name of the site whose summary to get, e.g.
`sites/http%3A%2F%2Fwww.google.com%2F`.

Format: `sites/{site}` (required)
name: string, Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%2Fwww.google.com%2F`. Format: `sites/{site}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -96,27 +101,13 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for GetSiteSummary.
&quot;reportUrl&quot;: &quot;A String&quot;, # A link to the full Abusive Experience Report for the site.
#
# Not set in
# ViolatingSitesResponse.
#
# Note that you must complete the [Search Console verification
# process](https://support.google.com/webmasters/answer/9008080) for the site
# before you can access the full report.
&quot;lastChangeTime&quot;: &quot;A String&quot;, # The time at which the site&#x27;s status last changed.
&quot;filterStatus&quot;: &quot;A String&quot;, # The site&#x27;s [enforcement
# status](https://support.google.com/webtools/answer/7538608).
&quot;enforcementTime&quot;: &quot;A String&quot;, # The time at which
# [enforcement](https://support.google.com/webtools/answer/7538608) against
# the site began or will begin.
#
# Not set when the
# filter_status
# is OFF.
&quot;underReview&quot;: True or False, # Whether the site is currently under review.
&quot;reviewedSite&quot;: &quot;A String&quot;, # The name of the reviewed site, e.g. `google.com`.
&quot;enforcementTime&quot;: &quot;A String&quot;, # The time at which [enforcement](https://support.google.com/webtools/answer/7538608) against the site began or will begin. Not set when the filter_status is OFF.
&quot;filterStatus&quot;: &quot;A String&quot;, # The site&#x27;s [enforcement status](https://support.google.com/webtools/answer/7538608).
&quot;abusiveStatus&quot;: &quot;A String&quot;, # The site&#x27;s Abusive Experience Report status.
&quot;underReview&quot;: True or False, # Whether the site is currently under review.
&quot;reportUrl&quot;: &quot;A String&quot;, # A link to the full Abusive Experience Report for the site. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report.
}</pre>
</div>

@@ -74,10 +74,18 @@

<h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a> . <a href="abusiveexperiencereport_v1.violatingSites.html">violatingSites</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="#list">list(x__xgafv=None)</a></code></p>
<p class="firstline">Lists sites that are failing in the Abusive Experience Report.</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="list">list(x__xgafv=None)</code>
<pre>Lists sites that are failing in the Abusive Experience Report.
@@ -94,27 +102,13 @@ <h3>Method Details</h3>
{ # Response message for ListViolatingSites.
&quot;violatingSites&quot;: [ # The list of violating sites.
{ # Response message for GetSiteSummary.
&quot;reportUrl&quot;: &quot;A String&quot;, # A link to the full Abusive Experience Report for the site.
#
# Not set in
# ViolatingSitesResponse.
#
# Note that you must complete the [Search Console verification
# process](https://support.google.com/webmasters/answer/9008080) for the site
# before you can access the full report.
&quot;lastChangeTime&quot;: &quot;A String&quot;, # The time at which the site&#x27;s status last changed.
&quot;filterStatus&quot;: &quot;A String&quot;, # The site&#x27;s [enforcement
# status](https://support.google.com/webtools/answer/7538608).
&quot;enforcementTime&quot;: &quot;A String&quot;, # The time at which
# [enforcement](https://support.google.com/webtools/answer/7538608) against
# the site began or will begin.
#
# Not set when the
# filter_status
# is OFF.
&quot;underReview&quot;: True or False, # Whether the site is currently under review.
&quot;reviewedSite&quot;: &quot;A String&quot;, # The name of the reviewed site, e.g. `google.com`.
&quot;enforcementTime&quot;: &quot;A String&quot;, # The time at which [enforcement](https://support.google.com/webtools/answer/7538608) against the site began or will begin. Not set when the filter_status is OFF.
&quot;filterStatus&quot;: &quot;A String&quot;, # The site&#x27;s [enforcement status](https://support.google.com/webtools/answer/7538608).
&quot;abusiveStatus&quot;: &quot;A String&quot;, # The site&#x27;s Abusive Experience Report status.
&quot;underReview&quot;: True or False, # Whether the site is currently under review.
&quot;reportUrl&quot;: &quot;A String&quot;, # A link to the full Abusive Experience Report for the site. Not set in ViolatingSitesResponse. Note that you must complete the [Search Console verification process](https://support.google.com/webmasters/answer/9008080) for the site before you can access the full report.
},
],
}</pre>
@@ -76,22 +76,22 @@ <h1><a href="acceleratedmobilepageurl_v1.html">Accelerated Mobile Pages (AMP) UR
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchGet">batchGet(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns AMP URL(s) and equivalent</p>
<p class="firstline">Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGet">batchGet(body=None, x__xgafv=None)</code>
<pre>Returns AMP URL(s) and equivalent
[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
<pre>Returns AMP URL(s) and equivalent [AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).

Args:
body: object, The request body.
The object takes the form of:

{ # AMP URL request for a batch of URLs.
&quot;lookupStrategy&quot;: &quot;A String&quot;, # The lookup_strategy being requested.
&quot;urls&quot;: [ # List of URLs to look up for the paired AMP URLs.
# The URLs are case-sensitive. Up to 50 URLs per lookup
# (see [Usage Limits](/amp/cache/reference/limits)).
&quot;urls&quot;: [ # List of URLs to look up for the paired AMP URLs. The URLs are case-sensitive. Up to 50 URLs per lookup (see [Usage Limits](/amp/cache/reference/limits)).
&quot;A String&quot;,
],
}
@@ -105,25 +105,26 @@ <h3>Method Details</h3>
An object of the form:

{ # Batch AMP URL response.
&quot;ampUrls&quot;: [ # For each URL in BatchAmpUrlsRequest, the URL response. The response might
# not be in the same order as URLs in the batch request.
# If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated
# only once.
&quot;ampUrls&quot;: [ # For each URL in BatchAmpUrlsRequest, the URL response. The response might not be in the same order as URLs in the batch request. If BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated only once.
{ # AMP URL response for a requested URL.
&quot;cdnAmpUrl&quot;: &quot;A String&quot;, # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to
# the cached document in the Google AMP Cache.
&quot;ampUrl&quot;: &quot;A String&quot;, # The AMP URL pointing to the publisher&#x27;s web server.
&quot;originalUrl&quot;: &quot;A String&quot;, # The original non-AMP URL.
&quot;cdnAmpUrl&quot;: &quot;A String&quot;, # The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to the cached document in the Google AMP Cache.
},
],
&quot;urlErrors&quot;: [ # The errors for requested URLs that have no AMP URL.
{ # AMP URL Error resource for a requested URL that couldn&#x27;t be found.
&quot;originalUrl&quot;: &quot;A String&quot;, # The original non-AMP URL.
&quot;errorMessage&quot;: &quot;A String&quot;, # An optional descriptive error message.
&quot;errorCode&quot;: &quot;A String&quot;, # The error code of an API call.
&quot;errorMessage&quot;: &quot;A String&quot;, # An optional descriptive error message.
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

</body></html>
@@ -79,10 +79,18 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the ampUrls Resource.</p>

<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="#new_batch_http_request">new_batch_http_request()</a></code></p>
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</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="new_batch_http_request">new_batch_http_request()</code>
<pre>Create a BatchHttpRequest object based on the discovery document.

0 comments on commit 3e17f89

Please sign in to comment.
You can’t perform that action at this time.