Skip to content

Commit 9a381ce

Browse files
committed
Fixed readme formatting errors
1 parent 07c05ff commit 9a381ce

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

README.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Create a full scan from a set of package manifest files. Returns a full scan inc
192192
+------------------------+------------+-------------------------------------------------------------------------------+
193193
| tmp | False | Boolean temporary flag |
194194
+------------------------+------------+-------------------------------------------------------------------------------+
195-
| integration_type | False | IntegrationType enum value (e.g., "api", "github") |
195+
| integration_type | False | IntegrationType enum value (e.g., "api", "github") |
196196
+------------------------+------------+-------------------------------------------------------------------------------+
197197
| integration_org_slug | False | Organization slug for integration |
198198
+------------------------+------------+-------------------------------------------------------------------------------+
@@ -214,8 +214,8 @@ Delete an existing full scan.
214214
- **org_slug (str)** - The organization name
215215
- **full_scan_id (str)** - The ID of the full scan
216216

217-
fullscans.stream_diff(org_slug, before, after, use_types=True, include_license_details="true", **kwargs)
218-
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
217+
fullscans.stream_diff(org_slug, before, after, use_types=True, include_license_details="true", \*\*kwargs)
218+
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
219219
Stream a diff between two full scans. Returns a scan diff.
220220

221221
**Usage:**
@@ -829,7 +829,7 @@ List all historical snapshots for an organization.
829829
- **query_params (dict, optional)** – Optional query parameters
830830

831831
diffscans.list(org_slug, params=None)
832-
""""""""""""""""""""""""""""""""""""
832+
"""""""""""""""""""""""""""""""""""""
833833
List all diff scans for an organization.
834834

835835
**Usage:**
@@ -846,7 +846,7 @@ List all diff scans for an organization.
846846
- **params (dict, optional)** – Optional query parameters for filtering
847847

848848
diffscans.get(org_slug, diff_scan_id)
849-
""""""""""""""""""""""""""""""""""""
849+
"""""""""""""""""""""""""""""""""""""
850850
Fetch a specific diff scan by ID.
851851

852852
**Usage:**
@@ -885,7 +885,7 @@ Create a diff scan from two full scan IDs.
885885
- **params (dict)** – Parameters including before and after scan IDs
886886

887887
diffscans.create_from_repo(org_slug, repo_slug, files, params=None)
888-
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
888+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
889889
Create a diff scan from repository files.
890890

891891
**Usage:**
@@ -906,7 +906,7 @@ Create a diff scan from repository files.
906906
- **params (dict, optional)** – Optional parameters for the scan
907907

908908
diffscans.gfm(org_slug, diff_scan_id)
909-
""""""""""""""""""""""""""""""""""""
909+
"""""""""""""""""""""""""""""""""""""
910910
Get GitHub Flavored Markdown comments for a diff scan.
911911

912912
**Usage:**
@@ -923,7 +923,7 @@ Get GitHub Flavored Markdown comments for a diff scan.
923923
- **diff_scan_id (str)** – The ID of the diff scan
924924

925925
diffscans.delete(org_slug, diff_scan_id)
926-
"""""""""""""""""""""""""""""""""""""""
926+
""""""""""""""""""""""""""""""""""""""""
927927
Delete a specific diff scan.
928928

929929
**Usage:**
@@ -939,8 +939,8 @@ Delete a specific diff scan.
939939
- **org_slug (str)** – The organization name
940940
- **diff_scan_id (str)** – The ID of the diff scan to delete
941941

942-
threatfeed.get(org_slug=None, **kwargs)
943-
"""""""""""""""""""""""""""""""""""""""
942+
threatfeed.get(org_slug=None, \*\*kwargs)
943+
"""""""""""""""""""""""""""""""""""""""""""
944944
Get threat feed items for an organization or globally.
945945

946946
**Usage:**
@@ -961,8 +961,8 @@ Get threat feed items for an organization or globally.
961961
- **org_slug (str, optional)** – The organization name (recommended for new implementations)
962962
- **kwargs** – Query parameters like per_page, page_cursor, sort, etc.
963963

964-
apitokens.create(org_slug, **kwargs)
965-
"""""""""""""""""""""""""""""""""""
964+
apitokens.create(org_slug, \*\*kwargs)
965+
""""""""""""""""""""""""""""""""""""""
966966
Create a new API token for an organization.
967967

968968
**Usage:**
@@ -983,8 +983,8 @@ Create a new API token for an organization.
983983
- **org_slug (str)** – The organization name
984984
- **kwargs** – Token configuration parameters
985985

986-
apitokens.update(org_slug, **kwargs)
987-
"""""""""""""""""""""""""""""""""""
986+
apitokens.update(org_slug, \*\*kwargs)
987+
""""""""""""""""""""""""""""""""""""""
988988
Update an existing API token.
989989

990990
**Usage:**
@@ -1005,8 +1005,8 @@ Update an existing API token.
10051005
- **org_slug (str)** – The organization name
10061006
- **kwargs** – Token update parameters
10071007

1008-
auditlog.get(org_slug, **kwargs)
1009-
""""""""""""""""""""""""""""""""
1008+
auditlog.get(org_slug, \*\*kwargs)
1009+
""""""""""""""""""""""""""""""""""""
10101010
Get audit log entries for an organization.
10111011

10121012
**Usage:**
@@ -1022,8 +1022,8 @@ Get audit log entries for an organization.
10221022
- **org_slug (str)** – The organization name
10231023
- **kwargs** – Query parameters like limit, cursor, etc.
10241024

1025-
analytics.get_org(filter, **kwargs)
1026-
"""""""""""""""""""""""""""""""""""
1025+
analytics.get_org(filter, \*\*kwargs)
1026+
"""""""""""""""""""""""""""""""""""""""
10271027
Get organization analytics (deprecated - use Historical module instead).
10281028

10291029
**Usage:**
@@ -1040,8 +1040,8 @@ Get organization analytics (deprecated - use Historical module instead).
10401040
- **filter (str)** – Analytics filter type
10411041
- **kwargs** – Additional query parameters
10421042

1043-
analytics.get_repo(name, filter, **kwargs)
1044-
""""""""""""""""""""""""""""""""""""""""""
1043+
analytics.get_repo(name, filter, \*\*kwargs)
1044+
""""""""""""""""""""""""""""""""""""""""""""""
10451045
Get repository analytics (deprecated - use Historical module instead).
10461046

10471047
**Usage:**
@@ -1059,8 +1059,8 @@ Get repository analytics (deprecated - use Historical module instead).
10591059
- **filter (str)** – Analytics filter type
10601060
- **kwargs** – Additional query parameters
10611061

1062-
alerttypes.get(alert_types=None, language="en-US", **kwargs)
1063-
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
1062+
alerttypes.get(alert_types=None, language="en-US", \*\*kwargs)
1063+
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
10641064
Get alert types metadata.
10651065

10661066
**Usage:**
@@ -1084,7 +1084,7 @@ Get alert types metadata.
10841084
- **kwargs** – Additional query parameters
10851085

10861086
triage.list_alert_triage(org_slug, query_params=None)
1087-
""""""""""""""""""""""""""""""""""""""""""""""""""""
1087+
"""""""""""""""""""""""""""""""""""""""""""""""""""""
10881088
Get list of triaged alerts for an organization.
10891089

10901090
**Usage:**

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "socketdev"
7-
version = "3.0.3"
7+
version = "3.0.4"
88
requires-python = ">= 3.9"
99
dependencies = [
1010
'requests',

socketdev/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "3.0.3"
1+
__version__ = "3.0.4"

0 commit comments

Comments
 (0)