Skip to content

Commit 0756292

Browse files
committed
chore(release): update CHANGELOG for v3.2.0
Document v3.2.0 features: - List all 11 new API methods (telemetry, webhooks, alerts, fixes, archives) - Per-endpoint TTL configuration with cacheTtl option - Request/response logging with hooks option - PURL batch processing enhancements (cachedResultsOnly, summary) - UTF-8 filename support in file upload methods - @socketsecurity/lib v5.0.0 update - OpenAPI definition sync
1 parent 0ecdbc1 commit 0756292

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

CHANGELOG.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
88

99
### Added
1010

11-
- Telemetry configuration management endpoints (`getOrgTelemetryConfig`, `updateOrgTelemetryConfig`)
12-
- Webhook management endpoints (`getOrgWebhooksList`, `createOrgWebhook`, `getOrgWebhook`, `updateOrgWebhook`, `deleteOrgWebhook`)
13-
- Vulnerability fixes endpoint for fetching available fixes for vulnerabilities in repositories or scans
14-
- Alerts listing endpoint for retrieving latest alerts
15-
- Archive-based full scan creation supporting .tar, .tar.gz/.tgz, and .zip formats
16-
- Full scan file download as tarball
17-
- Per-endpoint TTL configuration for API response caching
18-
- Request/response logging support for debugging and monitoring
19-
- PURL batch processing enhancements with `cachedResultsOnly` and `summary` options
11+
- New API methods:
12+
- `getOrgTelemetryConfig()` - Get organization telemetry configuration
13+
- `updateOrgTelemetryConfig()` - Update organization telemetry configuration
14+
- `getOrgWebhooksList()` - List organization webhooks
15+
- `createOrgWebhook()` - Create organization webhook
16+
- `getOrgWebhook()` - Get organization webhook details
17+
- `updateOrgWebhook()` - Update organization webhook
18+
- `deleteOrgWebhook()` - Delete organization webhook
19+
- `getOrgAlertsList()` - List organization alerts
20+
- `getOrgFixes()` - Get available vulnerability fixes for repositories or scans
21+
- `createOrgFullScanFromArchive()` - Create full scan from archive file (.tar, .tar.gz/.tgz, or .zip)
22+
- `downloadOrgFullScanFilesAsTar()` - Download full scan files as tarball to local filesystem
23+
- Per-endpoint TTL configuration: `cacheTtl` option accepts object with endpoint-specific TTL values (e.g., `{ default: 300_000, getIssues: 600_000 }`)
24+
- Request/response logging: `hooks` option with `onRequest(info)` and `onResponse(info)` callbacks for debugging and monitoring
25+
- PURL batch processing: `cachedResultsOnly` query parameter (return only cached results, skip new scans) and `summary` query parameter (include summary with counts of malformed, resolved, and not found PURLs) in `batchPackageFetch()` and `batchPackageStream()`
26+
- UTF-8 filename support: `uploadManifestFiles()`, `createFullScan()`, `createDependenciesSnapshot()`, and `createOrgFullScanFromArchive()` automatically handle international filenames (Japanese, Cyrillic, emoji, and other UTF-8 characters)
2027

2128
### Changed
2229

@@ -474,9 +481,9 @@ To migrate from v1.x to v2.0:
474481

475482
### Changed
476483
- Synced with OpenAPI definition
477-
- Added new `/openapi.json` endpoint for retrieving API specification in JSON format
478-
- Updated repo label filter descriptions to document empty string ("") usage for repositories with no labels
479-
- Added 'dual' threat category type
484+
- Added new `/openapi.json` endpoint for retrieving API specification in JSON format
485+
- Updated repo label filter descriptions to document empty string ("") usage for repositories with no labels
486+
- Added 'dual' threat category type
480487

481488
## [1.8.4](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.8.4) - 2025-10-01
482489

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@socketsecurity/sdk",
3-
"version": "3.1.3",
3+
"version": "3.2.0",
44
"packageManager": "[email protected]",
55
"license": "MIT",
66
"description": "SDK for the Socket API client",

0 commit comments

Comments
 (0)