chore: regens API reference docs (#889)
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
index 45304e0..90fe8fa 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
@@ -78,7 +78,7 @@
<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, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=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>
@@ -89,8 +89,7 @@
<pre>Gets a Finding.
Args:
- name: string, Required.
-The resource name of the Finding to be returned. The name follows the
+ 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.
@@ -103,59 +102,44 @@
{ # A Finding resource represents a vulnerability instance identified during a
# ScanRun.
- "body": "A String", # Output only.
- # The body of the request that triggered the vulnerability.
- "xss": { # Information reported for an XSS. # Output only.
- # An addon containing information reported for an XSS, if any.
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
"stackTraces": [ # Stack traces leading to the point where the XSS occurred.
"A String",
],
"errorMessage": "A String", # An error message generated by a javascript breakage.
},
- "outdatedLibrary": { # Information reported for an outdated library. # Output only.
- # An addon containing information about outdated libraries.
+ "outdatedLibrary": { # Information reported for an outdated library. # 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",
],
},
- "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.
- "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.
- "contentType": "A String", # The MIME type of this resource.
- "resourceUrl": "A String", # URL of this violating resource.
- },
- "finalUrl": "A String", # Output only.
- # The URL where the browser lands when the vulnerability is detected.
- "findingType": "A String", # Output only.
- # The type of the Finding.
- "fuzzedUrl": "A String", # Output only.
- # The URL produced by the server-side fuzzer and used in the request that
+ "description": "A String", # The description of the vulnerability.
+ "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to
+ # reproduce the vulnerability.
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "findingType": "A String", # The type of the Finding.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that
# triggered the vulnerability.
- "httpMethod": "A String", # Output only.
- # The http method of the request that triggered the vulnerability, in
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
# uppercase.
- "vulnerableParameters": { # Information about vulnerable request parameters. # Output only.
- # An addon containing information about request parameters which were found
+ "vulnerableParameters": { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found
# to be vulnerable.
"parameterNames": [ # The vulnerable parameter names.
"A String",
],
},
- "trackingId": "A String", # Output only.
- # The tracking ID uniquely identifies a vulnerability instance across
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
# multiple ScanRuns.
- "frameUrl": "A String", # Output only.
- # If the vulnerability was originated from nested IFrame, the immediate
- # parent IFrame is reported.
- "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only.
- # An addon containing information about vulnerable or missing HTTP headers.
+ "violatingResource": { # Information regarding any resource causing the vulnerability such # 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.
+ "contentType": "A String", # The MIME type of this resource.
+ "resourceUrl": "A String", # URL of this violating resource.
+ },
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
"missingHeaders": [ # List of missing headers.
{ # Describes a HTTP Header.
"name": "A String", # Header name.
@@ -169,26 +153,22 @@
},
],
},
- "reproductionUrl": "A String", # Output only.
- # The URL containing human-readable payload that user can leverage to
- # reproduce the vulnerability.
- "description": "A String", # Output only.
- # The description of the vulnerability.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate
+ # parent IFrame is reported.
+ "name": "A String", # 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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=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
+ 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)
- 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.
@@ -196,8 +176,11 @@
Allowed values
1 - v1 error format
2 - v2 error format
- filter: string, The filter expression. The expression must be in the format: <field>
-<operator> <value>.
+ 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, Required. The filter expression. The expression must be in the format: <field>
+<operator> <value>.
Supported field: 'finding_type'.
Supported operator: '='.
@@ -210,59 +193,44 @@
"findings": [ # The list of Findings returned.
{ # A Finding resource represents a vulnerability instance identified during a
# ScanRun.
- "body": "A String", # Output only.
- # The body of the request that triggered the vulnerability.
- "xss": { # Information reported for an XSS. # Output only.
- # An addon containing information reported for an XSS, if any.
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
"stackTraces": [ # Stack traces leading to the point where the XSS occurred.
"A String",
],
"errorMessage": "A String", # An error message generated by a javascript breakage.
},
- "outdatedLibrary": { # Information reported for an outdated library. # Output only.
- # An addon containing information about outdated libraries.
+ "outdatedLibrary": { # Information reported for an outdated library. # 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",
],
},
- "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.
- "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.
- "contentType": "A String", # The MIME type of this resource.
- "resourceUrl": "A String", # URL of this violating resource.
- },
- "finalUrl": "A String", # Output only.
- # The URL where the browser lands when the vulnerability is detected.
- "findingType": "A String", # Output only.
- # The type of the Finding.
- "fuzzedUrl": "A String", # Output only.
- # The URL produced by the server-side fuzzer and used in the request that
+ "description": "A String", # The description of the vulnerability.
+ "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to
+ # reproduce the vulnerability.
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "findingType": "A String", # The type of the Finding.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that
# triggered the vulnerability.
- "httpMethod": "A String", # Output only.
- # The http method of the request that triggered the vulnerability, in
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
# uppercase.
- "vulnerableParameters": { # Information about vulnerable request parameters. # Output only.
- # An addon containing information about request parameters which were found
+ "vulnerableParameters": { # Information about vulnerable request parameters. # An addon containing information about request parameters which were found
# to be vulnerable.
"parameterNames": [ # The vulnerable parameter names.
"A String",
],
},
- "trackingId": "A String", # Output only.
- # The tracking ID uniquely identifies a vulnerability instance across
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
# multiple ScanRuns.
- "frameUrl": "A String", # Output only.
- # If the vulnerability was originated from nested IFrame, the immediate
- # parent IFrame is reported.
- "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # Output only.
- # An addon containing information about vulnerable or missing HTTP headers.
+ "violatingResource": { # Information regarding any resource causing the vulnerability such # 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.
+ "contentType": "A String", # The MIME type of this resource.
+ "resourceUrl": "A String", # URL of this violating resource.
+ },
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
"missingHeaders": [ # List of missing headers.
{ # Describes a HTTP Header.
"name": "A String", # Header name.
@@ -276,11 +244,11 @@
},
],
},
- "reproductionUrl": "A String", # Output only.
- # The URL containing human-readable payload that user can leverage to
- # reproduce the vulnerability.
- "description": "A String", # Output only.
- # The description of the vulnerability.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate
+ # parent IFrame is reported.
+ "name": "A String", # 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.
},
],
}</pre>