Validation

Query validation result summaries

get

Retrieve lightweight validation summaries for a repository. Returns only counts and status — no markdown content or raw deployment data.

Use cases:

• Table view: list recent validations with status badges and package counts

• Filter by base branch or PR number

Results are ordered by most recent first.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

Example: flxbl-io/sf-core

pullRequestNumberstringOptional

Filter by PR number

baseBranchstringOptional

Filter by target/base branch

limitnumberOptional

Maximum results (default: 20, max: 100)

Responses

200

Lightweight validation summaries

No content

400

Missing repositoryIdentifier

401

Unauthorized

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/validation/results

HTTPcURLJavaScriptPython

GET /sfp/api/validation/results?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Publish validation results

post

Store validation results from sfp validate. Called by the CLI when --publish-results is used.

Dual write: Stores full results (with markdown and deployment/test data) in the results table and a lightweight summary in the summary table.

Duplicate handling: If results already exist for the same PR + commit + domain, they are overwritten.

Retention: Keeps last 500 results per repository.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

Example: flxbl-io/sf-core

pullRequestNumberstringOptional

Pull request number (if PR context)

Example: 123

commitShastringRequired

Git commit SHA that was validated

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

domainstringOptional

Domain / release config name (e.g., "frameworks", "core"). Used as part of the storage key so each domain is stored separately.

Example: frameworks

branchNamestringOptional

Source branch name

baseBranchstringOptional

Target branch name (for PRs)

statusstring · enumRequired

Validation status

Possible values:

validationModestring · enumRequired

Validation mode

Possible values:

targetOrgstringOptional

Target org used for validation

poolstringOptional

Pool tag(s) used

errorMessagestringOptional

Overall error message if validation failed

validationMarkdownstringOptional

Pre-rendered validation markdown

testResultsMarkdownstringOptional

Pre-rendered test results markdown

executionTimeMsnumberOptional

Total execution time in milliseconds

prUrlstringOptional

Direct URL to the pull request

commitUrlstringOptional

Direct URL to the commit

Responses

201

Results stored successfully

400

Invalid request body

401

Unauthorized

403

Forbidden - Requires role: application

post

/sfp/api/validation/results

HTTPcURLJavaScriptPython

POST /sfp/api/validation/results HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 725

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "pullRequestNumber": "123",
  "commitSha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "domain": "frameworks",
  "branchName": "text",
  "baseBranch": "text",
  "status": "succeeded",
  "validationMode": "individual",
  "targetOrg": "text",
  "pool": "text",
  "deploymentResult": {
    "deployed": [
      {
        "packageName": "text",
        "packageType": "text",
        "versionNumber": "text"
      }
    ],
    "failed": [
      {
        "packageName": "text",
        "packageType": "text",
        "errorMessage": "text"
      }
    ],
    "scheduled": 1,
    "error": "text"
  },
  "testResults": [
    {
      "packageName": "text",
      "passed": true,
      "totalTests": 1,
      "passingTests": 1,
      "failingTests": 1,
      "coverage": 1
    }
  ],
  "errorMessage": "text",
  "validationMarkdown": "text",
  "testResultsMarkdown": "text",
  "executionTimeMs": 1,
  "prUrl": "text",
  "commitUrl": "text"
}

No content

Get full validation results for a pull request

get

Retrieve all validation runs for a specific PR with full data including markdown and deployment/test details.

Use cases:

• PR detail view: show deployment breakdown, test results, and markdown reports

• Compare validation results between commits on the same PR

Each entry represents a separate validation run (one per commit + domain combination).

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

prNumberstringRequired

Pull request number

Example: 617

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

Example: flxbl-io/sf-core

Responses

200

PR validation runs with full data

No content

400

Missing repositoryIdentifier

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/validation/pr/{prNumber}

HTTPcURLJavaScriptPython

GET /sfp/api/validation/pr/{prNumber}?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content