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.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
index 694a9c7..352aabc 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
@@ -109,7 +109,7 @@
Args:
name: string, Required. The resource name of the ScanRun to be returned. The name follows the
format of
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -119,26 +119,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
- "executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "startTime": "A String", # The time at which the ScanRun started.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
+ "startTime": "A String", # The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs tested up to now. The number of
+ # URLs tested is usually larger than the number URLS crawled because
+ # typically a crawled URL is tested with multiple test payloads.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
+ # The ScanRun IDs are generated by the system.
}</pre>
</div>
@@ -149,7 +149,7 @@
Args:
parent: string, Required. The parent resource name, which should be a scan resource name in the
-format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
If not specified or not positive, the implementation will select a
reasonable value.
@@ -165,30 +165,30 @@
An object of the form:
{ # Response for the `ListScanRuns` 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.
- "scanRuns": [ # The list of ScanRuns returned.
+ "scanRuns": [ # The list of ScanRuns returned.
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
- "executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "startTime": "A String", # The time at which the ScanRun started.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
+ "startTime": "A String", # The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs tested up to now. The number of
+ # URLs tested is usually larger than the number URLS crawled because
+ # typically a crawled URL is tested with multiple test payloads.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
+ # The ScanRun IDs are generated by the system.
},
],
}</pre>
@@ -203,7 +203,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>
@@ -215,7 +215,7 @@
Args:
name: string, Required. The resource name of the ScanRun to be stopped. The name follows the
format of
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
body: object, The request body.
The object takes the form of:
@@ -231,26 +231,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
- "executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
- "startTime": "A String", # The time at which the ScanRun started.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
# is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
+ "startTime": "A String", # The time at which the ScanRun started.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs crawled up to now.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
+ # the value represents the number of URLs tested up to now. The number of
+ # URLs tested is usually larger than the number URLS crawled because
+ # typically a crawled URL is tested with multiple test payloads.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
+ # The ScanRun IDs are generated by the system.
}</pre>
</div>