docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html
index e63b4e4..3fa15dd 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html
@@ -75,23 +75,29 @@
<h1><a href="websecurityscanner_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns</a> . <a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html">findings</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 Finding.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List Findings under a given ScanRun.</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>Gets a Finding.
Args:
- name: string, Required. The resource name of the Finding to be returned. The name follows the
-format of
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. (required)
+ name: string, Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -100,53 +106,27 @@
Returns:
An object of the form:
- { # A Finding resource represents a vulnerability instance identified during a
- # ScanRun.
- "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries.
- "libraryName": "A String", # The name of the outdated library.
- "version": "A String", # The version number.
- "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
- "A String",
- ],
- },
- "findingType": "A String", # Output only. The type of the Finding.
- # Detailed and up-to-date information on findings can be found here:
- # https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings
- "name": "A String", # Output only. The resource name of the Finding. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.
- # The finding IDs are generated by the system.
- "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across
- # multiple ScanRuns.
- "body": "A String", # Output only. The body of the request that triggered the vulnerability.
- "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found
- # to be vulnerable.
+ { # A Finding resource represents a vulnerability instance identified during a ScanRun.
+ "name": "A String", # Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.
+ "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found to be vulnerable.
"parameterNames": [ # The vulnerable parameter names.
"A String",
],
},
- "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers.
- "missingHeaders": [ # List of missing headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
+ "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries.
+ "version": "A String", # The version number.
+ "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
+ "A String",
],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
- ],
+ "libraryName": "A String", # The name of the outdated library.
},
- "violatingResource": { # Information regarding any resource causing the vulnerability such # Output only. An addon containing detailed information regarding any resource causing the
- # vulnerability such as JavaScript sources, image, audio files, etc.
- # as JavaScript sources, image, audio files, etc.
- "resourceUrl": "A String", # URL of this violating resource.
+ "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "violatingResource": { # Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. # Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
"contentType": "A String", # The MIME type of this resource.
+ "resourceUrl": "A String", # URL of this violating resource.
},
"severity": "A String", # Output only. The severity level of the reported vulnerability.
- "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that
- # triggered the vulnerability.
+ "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected.
"description": "A String", # Output only. The description of the vulnerability.
"xss": { # Information reported for an XSS. # Output only. An addon containing information reported for an XSS, if any.
"stackTraces": [ # Stack traces leading to the point where the XSS occurred.
@@ -156,41 +136,44 @@
"errorMessage": "A String", # An error message generated by a javascript breakage.
"storedXssSeedingUrl": "A String", # The reproduction url for the seeding POST request of a Stored XSS.
},
- "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML
- # form, if any.
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers.
+ "headers": [ # List of vulnerable headers.
+ { # Describes a HTTP Header.
+ "value": "A String", # Header value.
+ "name": "A String", # Header name.
+ },
+ ],
+ "missingHeaders": [ # List of missing headers.
+ { # Describes a HTTP Header.
+ "value": "A String", # Header value.
+ "name": "A String", # Header name.
+ },
+ ],
+ },
+ "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in uppercase.
+ "findingType": "A String", # Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings
+ "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability.
+ "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
+ "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML form, if any.
"fields": [ # ! The names of form fields related to the vulnerability.
"A String",
],
"actionUri": "A String", # ! The URI where to send the form when it's submitted.
},
- "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in
- # uppercase.
- "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected.
- "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate
- # parent IFrame is reported.
- "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to
- # reproduce the vulnerability.
+ "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
+ "body": "A String", # Output only. The body of the request that triggered the vulnerability.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List Findings under a given ScanRun.
Args:
- parent: string, Required. The parent resource name, which should be a scan run resource name in the
-format
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
- pageToken: string, A token identifying a page of results to be returned. This should be a
-`next_page_token` value returned from a previous List request.
-If unspecified, the first page of results is returned.
- pageSize: integer, The maximum number of Findings to return, can be limited by server.
-If not specified or not positive, the implementation will select a
-reasonable value.
- filter: string, The filter expression. The expression must be in the format: <field>
-<operator> <value>.
-Supported field: 'finding_type'.
-Supported operator: '='.
+ parent: string, Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+ filter: string, The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.
+ pageSize: integer, The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
+ pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -201,53 +184,27 @@
{ # Response for the `ListFindings` method.
"findings": [ # The list of Findings returned.
- { # A Finding resource represents a vulnerability instance identified during a
- # ScanRun.
- "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries.
- "libraryName": "A String", # The name of the outdated library.
- "version": "A String", # The version number.
- "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
- "A String",
- ],
- },
- "findingType": "A String", # Output only. The type of the Finding.
- # Detailed and up-to-date information on findings can be found here:
- # https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings
- "name": "A String", # Output only. The resource name of the Finding. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'.
- # The finding IDs are generated by the system.
- "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across
- # multiple ScanRuns.
- "body": "A String", # Output only. The body of the request that triggered the vulnerability.
- "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found
- # to be vulnerable.
+ { # A Finding resource represents a vulnerability instance identified during a ScanRun.
+ "name": "A String", # Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.
+ "vulnerableParameters": { # Information about vulnerable request parameters. # Output only. An addon containing information about request parameters which were found to be vulnerable.
"parameterNames": [ # The vulnerable parameter names.
"A String",
],
},
- "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers.
- "missingHeaders": [ # List of missing headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
+ "outdatedLibrary": { # Information reported for an outdated library. # Output only. An addon containing information about outdated libraries.
+ "version": "A String", # The version number.
+ "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
+ "A String",
],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
- ],
+ "libraryName": "A String", # The name of the outdated library.
},
- "violatingResource": { # Information regarding any resource causing the vulnerability such # Output only. An addon containing detailed information regarding any resource causing the
- # vulnerability such as JavaScript sources, image, audio files, etc.
- # as JavaScript sources, image, audio files, etc.
- "resourceUrl": "A String", # URL of this violating resource.
+ "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "violatingResource": { # Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. # Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
"contentType": "A String", # The MIME type of this resource.
+ "resourceUrl": "A String", # URL of this violating resource.
},
"severity": "A String", # Output only. The severity level of the reported vulnerability.
- "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that
- # triggered the vulnerability.
+ "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected.
"description": "A String", # Output only. The description of the vulnerability.
"xss": { # Information reported for an XSS. # Output only. An addon containing information reported for an XSS, if any.
"stackTraces": [ # Stack traces leading to the point where the XSS occurred.
@@ -257,24 +214,35 @@
"errorMessage": "A String", # An error message generated by a javascript breakage.
"storedXssSeedingUrl": "A String", # The reproduction url for the seeding POST request of a Stored XSS.
},
- "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML
- # form, if any.
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only. An addon containing information about vulnerable or missing HTTP headers.
+ "headers": [ # List of vulnerable headers.
+ { # Describes a HTTP Header.
+ "value": "A String", # Header value.
+ "name": "A String", # Header name.
+ },
+ ],
+ "missingHeaders": [ # List of missing headers.
+ { # Describes a HTTP Header.
+ "value": "A String", # Header value.
+ "name": "A String", # Header name.
+ },
+ ],
+ },
+ "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in uppercase.
+ "findingType": "A String", # Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings
+ "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability.
+ "fuzzedUrl": "A String", # Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
+ "form": { # ! Information about a vulnerability with an HTML. # Output only. An addon containing information reported for a vulnerability with an HTML form, if any.
"fields": [ # ! The names of form fields related to the vulnerability.
"A String",
],
"actionUri": "A String", # ! The URI where to send the form when it's submitted.
},
- "httpMethod": "A String", # Output only. The http method of the request that triggered the vulnerability, in
- # uppercase.
- "finalUrl": "A String", # Output only. The URL where the browser lands when the vulnerability is detected.
- "frameUrl": "A String", # Output only. If the vulnerability was originated from nested IFrame, the immediate
- # parent IFrame is reported.
- "reproductionUrl": "A String", # Output only. The URL containing human-readable payload that user can leverage to
- # reproduce the vulnerability.
+ "trackingId": "A String", # Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
+ "body": "A String", # Output only. The body of the request that triggered the vulnerability.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>