Skip to content

Commit 4a83b0c

Browse files
committed
API: Qualify its just text files
Signed-off-by: Simon Bennetts <psiinon@gmail.com>
1 parent 1fd1ecb commit 4a83b0c

File tree

2 files changed

+7
-5
lines changed
  • addOns/help/src/main/javahelp/contents

2 files changed

+7
-5
lines changed

addOns/help/src/main/javahelp/contents/start/features/api.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,9 @@ <H2><a name="filexfer">File Transfer</a></H2>
3838
<p>
3939
To enable file transfer you will need to have an API key set and to enable it via the
4040
<a href="../../ui/dialogs/options/api.html#filexferenabled">Options API screen</a>.
41+
You can also enable file transfers via the command line as explained in the help for that screen.
4142
<p>
42-
You can also enable the option via the command line using the parameter: <code>-config api.filexfer=true</code>
43-
<p>
44-
With file transfer enabled you will be able to upload files to the
43+
With file transfer enabled you will be able to upload text files to the
4544
<a href="../../ui/dialogs/options/api.html#xferdir">Transfer Directory</a> using the 'fileUpload' 'other' endpoint
4645
and download them from there using the 'fileDownload' 'other' endpoint.
4746
You can specify subdirectories (e.g. "subdir/myfile") but any attempt to upload or download a file to or from another directory
@@ -63,8 +62,7 @@ <H2><a name="filexfer">File Transfer</a></H2>
6362
<p>
6463
To upload a file to another API endpoint you need to do the reverse - first upload it, e.g. to "plans/myplan.yaml", and
6564
then import it via the path "${XFER}/plans/myplan.yaml".
66-
<p>
67-
You can also set the Transfer Directory via the command line using: <code>-config api.xferdir=/full/path/to/dir</code>
65+
6866

6967
<H2>See also</H2>
7068
<table>

addOns/help/src/main/javahelp/contents/ui/dialogs/options/api.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,16 @@ <H3><a name="filexferenabled">File Transfer Enabled</a></H3>
2929
If enabled then files can be transfered to and from ZAP via the API.
3030
This option is only available if the API key is <i>not</i> disabled.
3131
For more details see <a href="../../../start/features/api.html#filexfer">File Transfer</a>.
32+
<p>
33+
You can also enable this option via the command line using the parameter: <code>-config api.filexfer=true</code>
3234

3335
<H3><a name="xferdir">Transfer Directory</a></H3>
3436

3537
The directory used to transfer files to and from ZAP via the API.
3638
This option is only available if the API key is <i>not</i> disabled.
3739
For more details see <a href="../../../start/features/api.html#filexfer">File Transfer</a>.
40+
<p>
41+
You can also set the Transfer Directory via the command line using: <code>-config api.xferdir=/full/path/to/dir</code>
3842

3943
<H3>API Key</H3>
4044

0 commit comments

Comments
 (0)