Skip to content

Commit 260b843

Browse files
committed
a few more comments on supported parameters
1 parent 0c59a4a commit 260b843

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

src/polyswarm_api/api.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,14 @@ def submit(
229229
:param scan_config: The scan configuration to be used, e.g.: "default", "more-time", "most-time"
230230
:param preprocessing: Preprocessing settings to be applied to the artifact, None means no preprocessing,
231231
otherwise a dict with the following attributes can be passed:
232-
- type (string): either "zip", "base64", or "qrcode". "zip" means the file is a zip that
233-
the server has to decompress to then scan the content (only one file inside allowed).
234-
"base64" means the file content is base64-encoded and the server has to decode it
235-
before scanning. "qrcode" means the file is a QR Code image with a URL as payload,
236-
and you want to scan the URL, not the actual file (artifact_type has to be "URL").
237-
- password (string, optional): will use this password to decompress the zip file.
232+
- type (string): either "zip", "base64", "7zip", or "qrcode". "zip" means the file is a
233+
zip that the server has to decompress to then scan the content (only one file inside
234+
allowed). "base64" means the file content is base64-encoded and the server has to
235+
decode it before scanning. "7zip" means the file is a 7zip archive that the server
236+
has to decompress to then scan the content (only one file inside allowed). "qrcode"
237+
means the file is a QR Code image with a URL as payload, and you want to scan the URL,
238+
not the actual file (artifact_type has to be "URL").
239+
- password (string, optional): will use this password to decompress the zip or 7zip file.
238240
:return: An ArtifactInstance resource
239241
"""
240242
logger.info('Submitting artifact of type %s', artifact_type)

0 commit comments

Comments
 (0)