Skip to content

Commit 556dd82

Browse files
committed
#2086 Reformat reportType argument documentation in zap-client usage to avoid declaring MDX variables e.g "HMTL-plus"
Signed-off-by: Ilyes Ben Dlala <ilyes.bendlala@iteratec.com>
1 parent bfec6fd commit 556dd82

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎scanners/zap-advanced/.helm-docs.gotmpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Listed below are the arguments supported by the `zap-advanced-scan` script.
4040
The command line interface can be used to easily run server scans: `-t www.example.com`
4141

4242
```bash
43-
usage: zap-client [-h] -z ZAP_URL [-a API_KEY] [-c CONFIG_FOLDER] -t TARGET [-o OUTPUT_FOLDER] [-r {XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD}]
43+
usage: zap-client [-h] -z ZAP_URL [-a API_KEY] [-c CONFIG_FOLDER] -t TARGET [-o OUTPUT_FOLDER] [-r XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD]
4444
4545
OWASP secureCodeBox OWASP ZAP Client (can be used to automate OWASP ZAP instances based on YAML configuration files.)
4646
@@ -56,7 +56,7 @@ optional arguments:
5656
The target to scan with OWASP ZAP.
5757
-o OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
5858
The path to a local folder used to store the output files, eg. the ZAP Report or logfiles.
59-
-r {XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD}, --report-type {XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD}
59+
-r XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD, --report-type XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD
6060
The OWASP ZAP Report Type.
6161
```
6262
{{- end }}

‎scanners/zap-advanced/values.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ scanner:
120120
# -- if set to true the scan job will be suspended after creation. You can then resume the job using `kubectl resume <jobname>` or using a job scheduler like kueue
121121
suspend: false
122122

123-
# -- Optional to configure the reportType of the scan ZAP Scan. Must be one of the supported formats: {XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD}
123+
# -- Optional to configure the reportType of the scan ZAP Scan. Must be one of the supported formats: XML,XML-plus,JSON,JSON-plus,HTML,HTML-plus,MD
124124
# @default -- "XML"
125125
reportType: "XML"
126126

0 commit comments

Comments
 (0)