docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.findings.html
index 90fe8fa..69f6424 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, pageToken=None, x__xgafv=None, pageSize=None, filter=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>
@@ -91,7 +91,7 @@
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)
+'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -102,153 +102,153 @@
{ # A Finding resource represents a vulnerability instance identified during a
# ScanRun.
- "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. # 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",
- ],
- },
- "description": "A String", # The description of the vulnerability.
- "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "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
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate
+ # parent IFrame is reported.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that
# triggered the vulnerability.
- "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
+ "description": "A String", # The description of the vulnerability.
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
+ # multiple ScanRuns.
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
# uppercase.
- "vulnerableParameters": { # Information about vulnerable request parameters. # 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",
+ "parameterNames": [ # The vulnerable parameter names.
+ "A String",
],
},
- "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
- # multiple ScanRuns.
- "violatingResource": { # Information regarding any resource causing the vulnerability such # An addon containing detailed information regarding any resource causing the
+ "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.
+ "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.
+ },
+ ],
+ },
+ "findingType": "A String", # The type of the Finding.
+ "outdatedLibrary": { # Information reported for an outdated library. # An addon containing information about outdated libraries.
+ "libraryName": "A String", # The name of the outdated library.
+ "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
+ "A String",
+ ],
+ "version": "A String", # The version number.
+ },
+ "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.
+ "resourceUrl": "A String", # URL of this violating resource.
+ "contentType": "A String", # The MIME type of this 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.
- "value": "A String", # Header value.
- },
- ],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
+ "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
+ "errorMessage": "A String", # An error message generated by a javascript breakage.
+ "stackTraces": [ # Stack traces leading to the point where the XSS occurred.
+ "A String",
],
},
- "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, pageToken=None, x__xgafv=None, pageSize=None, filter=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)
+'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+ filter: string, Required. The filter expression. The expression must be in the format: <field>
+<operator> <value>.
+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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- 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: '='.
Returns:
An object of the form:
{ # Response for the `ListFindings` method.
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ "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.
+ "findings": [ # The list of Findings returned.
{ # A Finding resource represents a vulnerability instance identified during a
# ScanRun.
- "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. # 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",
- ],
- },
- "description": "A String", # The description of the vulnerability.
- "reproductionUrl": "A String", # The URL containing human-readable payload that user can leverage to
+ "finalUrl": "A String", # The URL where the browser lands when the vulnerability is detected.
+ "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
+ "body": "A String", # The body of the request that triggered the vulnerability.
+ "frameUrl": "A String", # If the vulnerability was originated from nested IFrame, the immediate
+ # parent IFrame is reported.
+ "fuzzedUrl": "A String", # The URL produced by the server-side fuzzer and used in the request that
# triggered the vulnerability.
- "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
+ "description": "A String", # The description of the vulnerability.
+ "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
+ # multiple ScanRuns.
+ "httpMethod": "A String", # The http method of the request that triggered the vulnerability, in
# uppercase.
- "vulnerableParameters": { # Information about vulnerable request parameters. # 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",
+ "parameterNames": [ # The vulnerable parameter names.
+ "A String",
],
},
- "trackingId": "A String", # The tracking ID uniquely identifies a vulnerability instance across
- # multiple ScanRuns.
- "violatingResource": { # Information regarding any resource causing the vulnerability such # An addon containing detailed information regarding any resource causing the
+ "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.
+ "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.
+ },
+ ],
+ },
+ "findingType": "A String", # The type of the Finding.
+ "outdatedLibrary": { # Information reported for an outdated library. # An addon containing information about outdated libraries.
+ "libraryName": "A String", # The name of the outdated library.
+ "learnMoreUrls": [ # URLs to learn more information about the vulnerabilities in the library.
+ "A String",
+ ],
+ "version": "A String", # The version number.
+ },
+ "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.
+ "resourceUrl": "A String", # URL of this violating resource.
+ "contentType": "A String", # The MIME type of this 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.
- "value": "A String", # Header value.
- },
- ],
- "headers": [ # List of vulnerable headers.
- { # Describes a HTTP Header.
- "name": "A String", # Header name.
- "value": "A String", # Header value.
- },
+ "xss": { # Information reported for an XSS. # An addon containing information reported for an XSS, if any.
+ "errorMessage": "A String", # An error message generated by a javascript breakage.
+ "stackTraces": [ # Stack traces leading to the point where the XSS occurred.
+ "A String",
],
},
- "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>
@@ -263,7 +263,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>