docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
index 7c04201..46c45eb 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
@@ -81,7 +81,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, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=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>
@@ -107,42 +107,28 @@
An object of the form:
{ # A Finding resource represents a vulnerability instance identified during a ScanRun.
- "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase.
- "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
- "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
- "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",
- ],
- },
- "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.
- "value": "A String", # Header value.
- "name": "A String", # Header name.
- },
- ],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "value": "A String", # Header value.
- "name": "A String", # Header name.
- },
- ],
- },
- "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.
- "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
- "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to reproduce the vulnerability.
"violatingResource": { # Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. # An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
"resourceUrl": "A String", # URL of this violating resource.
"contentType": "A String", # The MIME type of this resource.
},
- "body": "A String", # The body of the request that triggered the vulnerability.
- "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.
- "findingType": "A String", # The type of the Finding.
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
+ "headers": [ # List of vulnerable headers.
+ { # Describes a HTTP Header.
+ "name": "A String", # Header name.
+ "value": "A String", # Header value.
+ },
+ ],
+ "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. # An addon containing information about outdated libraries.
- "version": "A String", # The version number.
"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",
],
@@ -153,18 +139,32 @@
"A String",
],
},
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "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",
+ ],
+ },
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "findingType": "A String", # The type of the Finding.
+ "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.
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in 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, pageToken=None, pageSize=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)
+ filter: string, Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.
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, Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -177,42 +177,28 @@
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"findings": [ # The list of Findings returned.
{ # A Finding resource represents a vulnerability instance identified during a ScanRun.
- "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase.
- "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
- "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
- "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",
- ],
- },
- "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.
- "value": "A String", # Header value.
- "name": "A String", # Header name.
- },
- ],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "value": "A String", # Header value.
- "name": "A String", # Header name.
- },
- ],
- },
- "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.
- "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
- "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to reproduce the vulnerability.
"violatingResource": { # Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. # An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
"resourceUrl": "A String", # URL of this violating resource.
"contentType": "A String", # The MIME type of this resource.
},
- "body": "A String", # The body of the request that triggered the vulnerability.
- "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.
- "findingType": "A String", # The type of the Finding.
+ "vulnerableHeaders": { # Information about vulnerable or missing HTTP Headers. # An addon containing information about vulnerable or missing HTTP headers.
+ "headers": [ # List of vulnerable headers.
+ { # Describes a HTTP Header.
+ "name": "A String", # Header name.
+ "value": "A String", # Header value.
+ },
+ ],
+ "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. # An addon containing information about outdated libraries.
- "version": "A String", # The version number.
"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",
],
@@ -223,6 +209,20 @@
"A String",
],
},
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "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",
+ ],
+ },
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in uppercase.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
+ "findingType": "A String", # The type of the Finding.
+ "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.
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
},
],
}</pre>