docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
index 4b4c722..f74094f 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
@@ -120,17 +120,26 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
+ "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.
+ "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "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.
+ "startTime": "A String", # The time at which the ScanRun started.
"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".
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
@@ -138,11 +147,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "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.
"errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
@@ -158,15 +162,11 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
},
- "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.
}</pre>
</div>
@@ -193,22 +193,29 @@
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
- # more results in the list.
"scanRuns": [ # The list of ScanRuns returned.
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
+ "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.
+ "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "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.
+ "startTime": "A String", # The time at which the ScanRun started.
"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".
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
@@ -216,11 +223,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "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.
"errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
@@ -236,17 +238,15 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
},
- "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.
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -288,17 +288,26 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
+ "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.
+ "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.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "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.
+ "startTime": "A String", # The time at which the ScanRun started.
"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".
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
{ # Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
@@ -306,11 +315,6 @@
"code": "A String", # Indicates the warning code.
},
],
- "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.
"errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
# scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
@@ -326,15 +330,11 @@
# future.
"code": "A String", # Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
},
- "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.
}</pre>
</div>