Skip to content

chore: regens API reference docs #889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions describe.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
from googleapiclient.discovery import build_from_document
from googleapiclient.discovery import UnknownApiNameOrVersion
from googleapiclient.http import build_http
from googleapiclient.errors import HttpError

import uritemplate

CSS = """<style>
Expand Down Expand Up @@ -389,6 +391,9 @@ def document_api(name, version):
except UnknownApiNameOrVersion as e:
print("Warning: {} {} found but could not be built.".format(name, version))
return
except HttpError as e:
print("Warning: {} {} returned {}.".format(name, version, e))
return

http = build_http()
response, content = http.request(
Expand Down
42 changes: 26 additions & 16 deletions docs/dyn/abusiveexperiencereport_v1.sites.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,21 +76,17 @@ <h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a summary of the abusive experience rating of a site.</p>
<p class="firstline">Gets a site's Abusive Experience Report summary.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a summary of the abusive experience rating of a site.
<pre>Gets a site's Abusive Experience Report summary.

Args:
name: string, The required site name. This is the site property whose abusive
experiences have been reviewed, and it must be URL-encoded. For example,
sites/https%3A%2F%2Fwww.google.com. The server will return an error of
BAD_REQUEST if this field is not filled in. Note that if the site property
is not yet verified in Search Console, the reportUrl field
returned by the API will lead to the verification page, prompting the user
to go through that process before they can gain access to the Abusive
Experience Report. (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
Expand All @@ -100,13 +96,27 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for GetSiteSummary.
"lastChangeTime": "A String", # The last time that the site changed status.
"abusiveStatus": "A String", # The status of the site reviewed for the abusive experiences.
"reportUrl": "A String", # A link that leads to a full abusive experience report.
"lastChangeTime": "A String", # The time at which the site's status last changed.
"reviewedSite": "A String", # The name of the reviewed site, e.g. `google.com`.
"abusiveStatus": "A String", # The site's Abusive Experience Report status.
"reportUrl": "A String", # 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.
"underReview": True or False, # Whether the site is currently under review.
"enforcementTime": "A String", # The date on which enforcement begins.
"filterStatus": "A String", # The abusive experience enforcement status of the site.
"reviewedSite": "A String", # The name of the site reviewed.
"enforcementTime": "A String", # 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.
"filterStatus": "A String", # The site's [enforcement
# status](https://support.google.com/webtools/answer/7538608).
}</pre>
</div>

Expand Down
32 changes: 23 additions & 9 deletions docs/dyn/abusiveexperiencereport_v1.violatingSites.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ <h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(x__xgafv=None)</a></code></p>
<p class="firstline">Lists sites with Abusive Experience Report statuses of "Failing".</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="list">list(x__xgafv=None)</code>
<pre>Lists sites with Abusive Experience Report statuses of "Failing".
<pre>Lists sites that are failing in the Abusive Experience Report.

Args:
x__xgafv: string, V1 error format.
Expand All @@ -92,15 +92,29 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for ListViolatingSites.
"violatingSites": [ # A list of summaries of violating sites.
"violatingSites": [ # The list of violating sites.
{ # Response message for GetSiteSummary.
"lastChangeTime": "A String", # The last time that the site changed status.
"abusiveStatus": "A String", # The status of the site reviewed for the abusive experiences.
"reportUrl": "A String", # A link that leads to a full abusive experience report.
"lastChangeTime": "A String", # The time at which the site's status last changed.
"reviewedSite": "A String", # The name of the reviewed site, e.g. `google.com`.
"abusiveStatus": "A String", # The site's Abusive Experience Report status.
"reportUrl": "A String", # 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.
"underReview": True or False, # Whether the site is currently under review.
"enforcementTime": "A String", # The date on which enforcement begins.
"filterStatus": "A String", # The abusive experience enforcement status of the site.
"reviewedSite": "A String", # The name of the site reviewed.
"enforcementTime": "A String", # 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.
"filterStatus": "A String", # The site's [enforcement
# status](https://support.google.com/webtools/answer/7538608).
},
],
}</pre>
Expand Down
6 changes: 3 additions & 3 deletions docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,16 @@
<h1><a href="acceleratedmobilepageurl_v1.html">Accelerated Mobile Pages (AMP) URL API</a> . <a href="acceleratedmobilepageurl_v1.ampUrls.html">ampUrls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchGet">batchGet(body, x__xgafv=None)</a></code></p>
<code><a href="#batchGet">batchGet(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns AMP URL(s) and equivalent</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGet">batchGet(body, x__xgafv=None)</code>
<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).

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

{ # AMP URL request for a batch of URLs.
Expand Down
Loading