v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Pipeline Quality Review

Review Pipeline Quality

Reviews pipelines against configured pipeline quality rules

post/v1/projects/{projectId}/reviews

Path parameters

projectIdstring uuid required

The UUID of the project

Headers

Agent-Versionstring required

The agent version (e.g., "9.0.0")

Request body

branchNamestring required

${review.request.body.branchName}

commitIdstring required

The unique commit identifier used to retrieve associated pipelines

dataWarehouseTypestring required

${review.request.body.dataWarehouseType}

filePathsstring[] nullable

${review.request.body.filePaths}

Example request

{
  "branchName": "main",
  "commitId": "7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e",
  "dataWarehouseType": "SNOWFLAKE",
  "filePaths": [
    "file-1.orch.yaml",
    "another/file/with/path/file-2.trans.yaml"
  ]
}

Response

Pipeline quality review completed successfully

excludedFilesstring[]

List of files excluded from review due to unsupported file extensions

resultsobject

Map of pipeline names to their validation results

reviewStatusstring

Overall review status: PASSED or FAILED. FAILED if any rule failed with error enforcement.

Example response

{
  "reviewStatus": "PASSED"
}