Release Calculator

Analyze impact of including/excluding work items

post

Calculate the impact of toggling work items on packages and linked releases

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

releaseCandidateIdstringRequired

Release candidate ID

excludedWorkItemsstring[]Optional

Work items to exclude

includedWorkItemsstring[]Optional

Work items to include

modestring · enumOptional

Calculator mode

Default: excludePossible values:

Responses

200

Analysis results

application/json

candidateIdstringRequired

Release candidate ID

releaseNamestringRequired

Release name

suggestionsstring[]Required

Suggestions

403

Forbidden - Requires role: viewer, member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/calculator/analyze

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/calculator/analyze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "releaseCandidateId": "text",
  "excludedWorkItems": [
    "text"
  ],
  "includedWorkItems": [
    "text"
  ],
  "mode": "exclude"
}

{
  "candidateId": "text",
  "releaseName": "text",
  "original": {
    "packages": [
      {
        "package": "core-crm",
        "path": "src/core-crm",
        "versionNumber": "1.0.0.NEXT",
        "type": "Unlocked",
        "default": true,
        "dependencies": [
          {
            "package": "core-framework",
            "versionNumber": "1.0.0.1"
          }
        ],
        "domains": [
          "sales",
          "frameworks"
        ]
      }
    ],
    "workItems": [
      {
        "id": "text",
        "type": "jira",
        "packageCount": 1,
        "commitCount": 1
      }
    ],
    "totalCommits": 1
  },
  "calculated": {
    "packages": [
      {
        "package": "core-crm",
        "path": "src/core-crm",
        "versionNumber": "1.0.0.NEXT",
        "type": "Unlocked",
        "default": true,
        "dependencies": [
          {
            "package": "core-framework",
            "versionNumber": "1.0.0.1"
          }
        ],
        "domains": [
          "sales",
          "frameworks"
        ]
      }
    ],
    "workItems": [
      {
        "id": "text",
        "type": "jira",
        "packageCount": 1,
        "commitCount": 1
      }
    ],
    "excludedPackages": [
      {
        "packageName": "text",
        "version": "text",
        "reason": "no-remaining-commits",
        "excludedWorkItems": [
          "text"
        ],
        "excludedCommits": 1
      }
    ],
    "totalCommits": 1
  },
  "impact": {
    "packagesRemoved": 1,
    "workItemsRemoved": 1,
    "commitsRemoved": 1,
    "linkedReleasesAffected": [
      {
        "release": {},
        "impactType": "full",
        "affectedPackages": [
          "text"
        ],
        "severity": "low",
        "warning": "text"
      }
    ]
  },
  "warnings": [
    {
      "type": "shared-commit",
      "severity": "info",
      "message": "text",
      "affectedPackages": [
        "text"
      ],
      "affectedReleases": [
        "text"
      ],
      "suggestion": "text"
    }
  ],
  "suggestions": [
    "text"
  ]
}

Optimize release for specific work items

post

Find optimal package configuration for given work items and constraints

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

releaseCandidateIdstringRequired

Release candidate ID

targetWorkItemsstring[]Required

Target work items to include

Responses

200

Optimization results

application/json

includedPackagesstring[]Required

Included packages

excludedPackagesstring[]Required

Excluded packages

includedWorkItemsstring[]Required

Included work items

excludedWorkItemsstring[]Required

Excluded work items

totalCommitsnumberRequired

Total commits

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/calculator/optimize

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/calculator/optimize HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "releaseCandidateId": "text",
  "targetWorkItems": [
    "text"
  ],
  "constraints": {
    "mustIncludePackages": [
      "text"
    ],
    "mustExcludePackages": [
      "text"
    ],
    "mustIncludeWorkItems": [
      "text"
    ],
    "mustExcludeWorkItems": [
      "text"
    ],
    "maxPackages": 1,
    "preferExcludePackages": [
      "text"
    ],
    "optimizationGoal": "balanced"
  }
}

{
  "includedPackages": [
    "text"
  ],
  "excludedPackages": [
    "text"
  ],
  "includedWorkItems": [
    "text"
  ],
  "excludedWorkItems": [
    "text"
  ],
  "totalCommits": 1,
  "metrics": {
    "packageCount": 1,
    "workItemCount": 1,
    "commitCount": 1,
    "sharedCommitRatio": 1,
    "exclusionSafety": 1
  },
  "suggestions": [
    {
      "type": "exclude-package",
      "target": "text",
      "reason": "text",
      "impact": {},
      "confidence": "high"
    }
  ]
}

Get exclusion strategies

get

Find safe exclusion strategies for reducing release size

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

candidateIdstringRequired

Release candidate ID

Query parameters

targetReductionnumberOptional

Target reduction percentage (0-1, default: 0.2)

Responses

200

List of exclusion strategies

application/json

namestringRequired

Strategy name

descriptionstringRequired

Strategy description

excludablePackagesstring[]Required

Packages that can be excluded

requiredExclusionsstring[]Required

Work items that must be excluded

safetyScorenumber · max: 1Required

Safety score

403

Forbidden - Requires role: viewer, member, owner, application

404

Release candidate not found

get

/sfp/api/release-candidates/calculator/strategies/{candidateId}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/calculator/strategies/{candidateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "description": "text",
    "excludablePackages": [
      "text"
    ],
    "requiredExclusions": [
      "text"
    ],
    "safetyScore": 1,
    "savings": {
      "packages": 1,
      "commits": 1,
      "percentage": 1
    }
  }
]

Get dependency visualization data

get

Get dependency graph data for visualization

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

candidateIdstringRequired

Release candidate ID

Responses

200

Dependency visualization data

application/json

nodesobjectRequired

Graph nodes

403

Forbidden - Requires role: viewer, member, owner, application

404

Release candidate not found

get

/sfp/api/release-candidates/calculator/dependencies/{candidateId}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/calculator/dependencies/{candidateId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nodes": {},
  "edges": [
    {
      "from": "text",
      "to": "text",
      "type": "contains"
    }
  ],
  "statistics": {
    "totalWorkItems": 1,
    "totalCommits": 1,
    "totalPackages": 1,
    "sharedCommitRatio": 1
  }
}

Calculate minimal package set

post

Find the minimal set of packages needed for specific work items

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Minimal package set

application/json

packagesstring[]Required

Required packages

additionalWorkItemsstring[]Required

Additional work items included

403

Forbidden - Requires role: viewer, member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/calculator/minimal-package-set

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/calculator/minimal-package-set HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "packages": [
    "text"
  ],
  "additionalWorkItems": [
    "text"
  ],
  "rationale": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Batch analyze multiple scenarios

post

Analyze multiple work item combinations in a single request

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Batch analysis results

application/json

candidateIdstringRequired

Release candidate ID

releaseNamestringRequired

Release name

suggestionsstring[]Required

Suggestions

403

Forbidden - Requires role: member, owner, application

post

/sfp/api/release-candidates/calculator/batch-analyze

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/calculator/batch-analyze HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "candidateId": "text",
    "releaseName": "text",
    "original": {
      "packages": [
        {
          "package": "core-crm",
          "path": "src/core-crm",
          "versionNumber": "1.0.0.NEXT",
          "type": "Unlocked",
          "default": true,
          "dependencies": [
            {
              "package": "core-framework",
              "versionNumber": "1.0.0.1"
            }
          ],
          "domains": [
            "sales",
            "frameworks"
          ]
        }
      ],
      "workItems": [
        {
          "id": "text",
          "type": "jira",
          "packageCount": 1,
          "commitCount": 1
        }
      ],
      "totalCommits": 1
    },
    "calculated": {
      "packages": [
        {
          "package": "core-crm",
          "path": "src/core-crm",
          "versionNumber": "1.0.0.NEXT",
          "type": "Unlocked",
          "default": true,
          "dependencies": [
            {
              "package": "core-framework",
              "versionNumber": "1.0.0.1"
            }
          ],
          "domains": [
            "sales",
            "frameworks"
          ]
        }
      ],
      "workItems": [
        {
          "id": "text",
          "type": "jira",
          "packageCount": 1,
          "commitCount": 1
        }
      ],
      "excludedPackages": [
        {
          "packageName": "text",
          "version": "text",
          "reason": "no-remaining-commits",
          "excludedWorkItems": [
            "text"
          ],
          "excludedCommits": 1
        }
      ],
      "totalCommits": 1
    },
    "impact": {
      "packagesRemoved": 1,
      "workItemsRemoved": 1,
      "commitsRemoved": 1,
      "linkedReleasesAffected": [
        {
          "release": {},
          "impactType": "full",
          "affectedPackages": [
            "text"
          ],
          "severity": "low",
          "warning": "text"
        }
      ]
    },
    "warnings": [
      {
        "type": "shared-commit",
        "severity": "info",
        "message": "text",
        "affectedPackages": [
          "text"
        ],
        "affectedReleases": [
          "text"
        ],
        "suggestion": "text"
      }
    ],
    "suggestions": [
      "text"
    ]
  }
]

Get preset exclusion scenarios

get

Get common preset scenarios for quick analysis

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of preset scenarios

No content

403

Forbidden - Requires role: viewer, member, owner, application

get

/sfp/api/release-candidates/calculator/presets

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/calculator/presets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content