|
6 | 6 | -------
|
7 | 7 |
|
8 | 8 | The Socket.dev Python SDK provides a wrapper around the Socket.dev REST API to simplify making calls to the API from Python.
|
| 9 | + |
9 | 10 | Socket API v0 - https://docs.socket.dev/reference/introduction-to-socket-api
|
10 | 11 |
|
11 | 12 | Initializing the module
|
@@ -308,18 +309,30 @@ Create a full scan from a set of package manifest files. Returns a full scan inc
|
308 | 309 | - **files (list)** - List of file paths of manifest files
|
309 | 310 | - **params (dict)** - List of parameters to create a fullscan
|
310 | 311 |
|
311 |
| -| Parameter | Required | Description | |
312 |
| -|:----------------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------| |
313 |
| -| --org_slug | True | The string name in a git approved name for organization. | |
314 |
| -| --repo | True | The string name in a git approved name for repositories. | |
315 |
| -| --branch | False | The string name in a git approved name for branches. | |
316 |
| -| --committers | False | The string name of the person doing the commit or running the CLI. Can be specified multiple times to have more than one committer | |
317 |
| -| --pull_request | False | The integer for the PR or MR number | |
318 |
| -| --commit_message | False | The string for a commit message if there is one | |
319 |
| -| --make_default_branch | False | If the flag is specified this will signal that this is the default branch. | |
320 |
| -| --commit_hash | False | Optional git commit hash | |
321 |
| -| --set_as_pending_head | False | | |
322 |
| -| --tmp | False | | |
| 312 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 313 | +| Parameter | Required | Description | |
| 314 | ++========================+============+===============================================================================+ |
| 315 | +| org_slug | True | The string name in a git approved name for organization. | |
| 316 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 317 | +| repo | True | The string name in a git approved name for repositories. | |
| 318 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 319 | +| branch | False | The string name in a git approved name for branches. | |
| 320 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 321 | +| committers | False | The string name of the person doing the commit or running the CLI. | |
| 322 | +| | | Can be specified multiple times to have more than one committer. | |
| 323 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 324 | +| pull_request | False | The integer for the PR or MR number. | |
| 325 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 326 | +| commit_message | False | The string for a commit message if there is one. | |
| 327 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 328 | +| make_default_branch | False | If the flag is specified this will signal that this is the default branch. | |
| 329 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 330 | +| commit_hash | False | Optional git commit hash | |
| 331 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 332 | +| set_as_pending_head | False | | |
| 333 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
| 334 | +| tmp | False | | |
| 335 | ++------------------------+------------+-------------------------------------------------------------------------------+ |
323 | 336 |
|
324 | 337 | fullscans.delete(org_slug, full_scan_id)
|
325 | 338 | """"""""""""""""""""""
|
|
0 commit comments