release-candidates
sfp server API reference for release-candidates: 2 endpoints.
/sfp/api/release-candidates/diffReturns the package-version delta and git file-level diff between two release candidates. Async, mirroring code-analysis / AI reports: a cached result is served immediately (status: available); otherwise the generate-release-diff flow is dispatched and status: pending is returned with a jobId. Poll this same endpoint (same from/to) until status becomes available — the result is keyed by (repository, from, to), not by jobId. Concurrent polls reuse the in-flight run.
Authorization
access-token In: header
Query Parameters
Repository identifier (owner/repo or org/project/repo).
Baseline release ref as domain:releaseName.
Target release ref as domain:releaseName.
Force a recompute, bypassing the cache (an in-flight run is still reused).
Response Body
application/json
curl -X GET "https://example.com/sfp/api/release-candidates/diff?repositoryIdentifier=flxbl-io%2Fsf-core&from=sales%3Asales-10JUN26-1&to=sales%3Asales-19JUN26-2"{ "status": "available", "data": { "repositoryIdentifier": "string", "fromRelease": "string", "toRelease": "string", "packages": [ { "package": "string", "fromVersion": "string", "toVersion": "string", "change": "added" } ], "summary": {}, "fileDiff": {}, "computedAt": "string", "status": "string", "durationMs": 0 }, "jobId": "string", "message": "string"}/sfp/api/release-candidates/diff/resultsCallback used by the generate-release-diff flow to persist its result into the doc store. Requires an application token.
Authorization
access-token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/sfp/api/release-candidates/diff/results" \ -H "Content-Type: application/json" \ -d '{ "repositoryIdentifier": "string", "fromRelease": "string", "toRelease": "string", "packages": [ { "package": "string", "change": "added" } ], "summary": {} }'