Subscribe to this changelog: add
https://docs.semgrep.dev/api-reference/v1/Changelog/rss.xml to any
feed reader, or run /feed subscribe https://docs.semgrep.dev/api-reference/v1/Changelog/rss.xml in Slack to post new
entries to a channel. Most readers also accept this page’s own URL and
find the feed automatically.Breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the success response with the status 200 | POST /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the success response with the status 202 | POST /api |
| Added | added the new optional request property is_partial_scan | POST /api |
| Added | added the optional property scans[].is_partial_scan to the response with the 200 status | POST /api |
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Deprecated | endpoint deprecated | GET /api |
| Deprecated | endpoint deprecated | GET /api |
| Deprecated | endpoint deprecated | PUT /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new optional request property dependencyFilter.includeArchived | POST /api POST /api POST /api |
Breaking changes
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Changed | the deployments[].id response’s property format changed from uint32 to int64 for status 200 | GET /api |
| Changed | the dependencyFilter.repositoryId[] request property format changed from uint32 to int64 | POST /api |
| Changed | the format of the request properties cursor, deploymentId changed from uint64 to int64 | POST /api |
| Changed | the cursor response’s property format changed from uint64 to int64 for status 200 | POST /api |
| Changed | the deploymentId request property format changed from uint64 to int64 | POST /api POST /api |
| Changed | the format of the request properties cursor, dependencyFilter.repositoryId[], pageSize changed from uint32 to int64 | POST /api |
| Changed | the format of the response properties cursor, repositorySummaries[].id, repositorySummaries[].numDependencies changed from uint32 to int64 for status 200 | POST /api |
| Changed | for the path request parameters deploymentId, repositoryId, the format was changed from uint64 to int64 | POST /api |
| Changed | the format of the request properties dependencyFilter.repositoryId[], pageSize changed from uint32 to int64 | POST /api |
| Changed | the format of the request properties deploymentId, repositoryId changed from uint64 to int64 | POST /api POST /api |
| Changed | the lockfileSummaries[].numDependencies response’s property format changed from uint32 to int64 for status 200 | POST /api |
| Changed | for the path request parameter deploymentId, the format was changed from uint64 to int64 | GET /api GET /api POST /api |
| Changed | the policies[].id response’s property format changed from uint64 to int64 for status 200 | GET /api |
| Changed | for the path request parameters deploymentId, policyId, the format was changed from uint64 to int64 | GET /api PUT /api |
| Changed | for the query request parameter limit, the format was changed from uint32 to int64 | GET /api GET /api |
| Changed | the format of the response properties policy.id, rules[].id changed from uint64 to int64 for status 200 | GET /api |
| Changed | the format of the request properties deploymentId, policyId changed from uint64 to int64 | PUT /api |
| Changed | the format of the response properties policyId, updatedRule.id changed from uint64 to int64 for status 200 | PUT /api |
| Changed | for the path request parameters deploymentId, scanId, the format was changed from uint64 to int64 | GET /api |
| Changed | the format of the response properties deployment_id, exit_code, id, repository_id changed from uint32 to int64 for status 200 | GET /api |
| Changed | the format of the response properties scans[].deployment_id, scans[].findings_counts.code, scans[].findings_counts.secrets, scans[].findings_counts.supply_chain, scans[].findings_counts.total, scans[].id, scans[].repository_id changed from uint64 to int64 for status 200 | POST /api |
| Changed | for the path request parameter externalTicketId, the format was changed from uint32 to int64 | DELETE /api |
| Changed | for the query request parameter repository_ids, the format of property items was narrowed from uint32 to int64 | GET /api |
| Changed | for the query request parameters page, page_size, the format was changed from uint32 to int64 | GET /api GET /api |
| Changed | the projects[].id response’s property format changed from uint32 to int64 for status 200 | GET /api |
| Changed | the project.id response’s property format changed from uint32 to int64 for status 200 | DELETE /api GET /api PATCH /api |
| Changed | the limit request property format changed from uint32 to int64 | POST /api |
| Changed | the format of the response properties failed[].issue_ids[], skipped[].issue_ids[], succeeded[].issue_ids[], succeeded[].ticket_id changed from uint32 to int64 for status 200 | POST /api |
| Changed | the format of the request properties issue_ids[], limit changed from uint32 to int64 | POST /api |
| Changed | the format of the response properties num_triaged, triaged_issues[] changed from uint32 to int64 for status 200 | POST /api |
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the request property formatVersion.version | POST /api |
| Removed | removed the optional property sastFindings from the response with the 200 status | GET /api |
| Removed | removed the optional property scaFindings from the response with the 200 status | GET /api |
| Removed | removed the request property deploymentSlug | POST /api |