Download OpenAPI specification:
FlawFerret 2 orchestration API for jobs, repositories, Cucumber features, and framework creation.
| jobType | string Default: "ADD_PLAYWRIGHT_TEST" Value: "ADD_PLAYWRIGHT_TEST" |
| priority | string Default: "NORMAL" Enum: "LOW" "NORMAL" "HIGH" "URGENT" |
required | object |
{- "jobType": "ADD_PLAYWRIGHT_TEST",
- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string",
- "runAffectedTests": true,
- "createDraftPr": true,
- "captureContext": {
- "title": "string",
- "selectedElement": "string",
- "elementKey": "string",
- "domSnippet": "string",
- "outerHTML": "string",
- "screenshotAssetId": "string",
- "snapshotUrl": "string",
- "selectedText": "string",
- "imageName": "string",
- "consoleErrors": [ ],
- "networkEvents": [ ],
- "accessibleRole": "string",
- "accessibleName": "string",
- "role": "string",
- "name": "string",
- "selectors": [ ],
- "locatorCandidates": [ ],
- "thenLine": "string",
- "notes": "string",
- "captureRect": {
- "x": 0,
- "y": 0,
- "width": 1,
- "height": 1
}, - "viewport": {
- "width": 1,
- "height": 1
}, - "devicePixelRatio": 1
}, - "jiraIssue": {
- "key": "string",
- "url": "string"
}
}
}{- "id": "string",
- "jobType": "ADD_PLAYWRIGHT_TEST",
- "status": "DRAFT",
- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string",
- "runAffectedTests": true,
- "createDraftPr": true,
- "captureContext": {
- "title": "string",
- "selectedElement": "string",
- "elementKey": "string",
- "domSnippet": "string",
- "outerHTML": "string",
- "screenshotAssetId": "string",
- "snapshotUrl": "string",
- "selectedText": "string",
- "imageName": "string",
- "consoleErrors": [ ],
- "networkEvents": [ ],
- "accessibleRole": "string",
- "accessibleName": "string",
- "role": "string",
- "name": "string",
- "selectors": [ ],
- "locatorCandidates": [ ],
- "thenLine": "string",
- "notes": "string",
- "captureRect": {
- "x": 0,
- "y": 0,
- "width": 1,
- "height": 1
}, - "viewport": {
- "width": 1,
- "height": 1
}, - "devicePixelRatio": 1
}, - "jiraIssue": {
- "key": "string",
- "url": "string"
}
}, - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "latestRun": {
- "id": "string",
- "jobId": "string",
- "status": "STARTED",
- "workerId": "string",
- "startedAt": "string",
- "completedAt": "string",
- "metadata": null,
- "createdAt": "string",
- "updatedAt": "string"
}, - "claimedBy": "string",
- "claimedAt": "string",
- "completedAt": "string",
- "autoRetryCount": 0,
- "createdAt": "string",
- "updatedAt": "string"
}| includeCanceled | string Enum: "true" "false" |
| page | integer >= 1 Default: 1 |
| pageSize | integer [ 1 .. 50 ] Default: 10 |
| paginated | string Enum: "true" "false" |
| sort | string Default: "updated_desc" Enum: "status_asc" "status_desc" "updated_asc" "updated_desc" |
| status | string Enum: "DRAFT" "NEEDS_REVIEW" "QUEUED" "CLAIMED" "RUNNING" "VALIDATING" "REVIEW" "PR_APPROVED" "PR_CREATED" "COMPLETED" "FAILED" "BLOCKED" "RETRY" "CANCELED" "READY_FOR_CODEX" "CODEX_APPROVED" |
{- "jobs": [
- {
- "id": "string",
- "jobType": "ADD_PLAYWRIGHT_TEST",
- "status": "DRAFT",
- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string",
- "runAffectedTests": true,
- "createDraftPr": true,
- "captureContext": {
- "title": "string",
- "selectedElement": "string",
- "elementKey": "string",
- "domSnippet": "string",
- "outerHTML": "string",
- "screenshotAssetId": "string",
- "snapshotUrl": "string",
- "selectedText": "string",
- "imageName": "string",
- "consoleErrors": [ ],
- "networkEvents": [ ],
- "accessibleRole": "string",
- "accessibleName": "string",
- "role": "string",
- "name": "string",
- "selectors": [ ],
- "locatorCandidates": [ ],
- "thenLine": "string",
- "notes": "string",
- "captureRect": {
- "x": 0,
- "y": 0,
- "width": 1,
- "height": 1
}, - "viewport": {
- "width": 1,
- "height": 1
}, - "devicePixelRatio": 1
}, - "jiraIssue": {
- "key": "string",
- "url": "string"
}
}, - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "latestRun": {
- "id": "string",
- "jobId": "string",
- "status": "STARTED",
- "workerId": "string",
- "startedAt": "string",
- "completedAt": "string",
- "metadata": null,
- "createdAt": "string",
- "updatedAt": "string"
}, - "claimedBy": "string",
- "claimedAt": "string",
- "completedAt": "string",
- "autoRetryCount": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
], - "page": 1,
- "pageSize": 1,
- "total": 0
}| id required | string |
| priority required | string Enum: "LOW" "NORMAL" "HIGH" "URGENT" |
required | object |
{- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string"
}
}{- "id": "string",
- "jobType": "ADD_PLAYWRIGHT_TEST",
- "status": "DRAFT",
- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string",
- "runAffectedTests": true,
- "createDraftPr": true,
- "captureContext": {
- "title": "string",
- "selectedElement": "string",
- "elementKey": "string",
- "domSnippet": "string",
- "outerHTML": "string",
- "screenshotAssetId": "string",
- "snapshotUrl": "string",
- "selectedText": "string",
- "imageName": "string",
- "consoleErrors": [ ],
- "networkEvents": [ ],
- "accessibleRole": "string",
- "accessibleName": "string",
- "role": "string",
- "name": "string",
- "selectors": [ ],
- "locatorCandidates": [ ],
- "thenLine": "string",
- "notes": "string",
- "captureRect": {
- "x": 0,
- "y": 0,
- "width": 1,
- "height": 1
}, - "viewport": {
- "width": 1,
- "height": 1
}, - "devicePixelRatio": 1
}, - "jiraIssue": {
- "key": "string",
- "url": "string"
}
}, - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "latestRun": {
- "id": "string",
- "jobId": "string",
- "status": "STARTED",
- "workerId": "string",
- "startedAt": "string",
- "completedAt": "string",
- "metadata": null,
- "createdAt": "string",
- "updatedAt": "string"
}, - "claimedBy": "string",
- "claimedAt": "string",
- "completedAt": "string",
- "autoRetryCount": 0,
- "createdAt": "string",
- "updatedAt": "string"
}| id required | string |
| feedback | string <= 4000 characters |
{- "feedback": "string"
}{- "id": "string",
- "jobType": "ADD_PLAYWRIGHT_TEST",
- "status": "DRAFT",
- "priority": "LOW",
- "payload": {
- "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "featureArea": "string",
- "goal": "string",
- "acceptanceCriteria": "string",
- "runAffectedTests": true,
- "createDraftPr": true,
- "captureContext": {
- "title": "string",
- "selectedElement": "string",
- "elementKey": "string",
- "domSnippet": "string",
- "outerHTML": "string",
- "screenshotAssetId": "string",
- "snapshotUrl": "string",
- "selectedText": "string",
- "imageName": "string",
- "consoleErrors": [ ],
- "networkEvents": [ ],
- "accessibleRole": "string",
- "accessibleName": "string",
- "role": "string",
- "name": "string",
- "selectors": [ ],
- "locatorCandidates": [ ],
- "thenLine": "string",
- "notes": "string",
- "captureRect": {
- "x": 0,
- "y": 0,
- "width": 1,
- "height": 1
}, - "viewport": {
- "width": 1,
- "height": 1
}, - "devicePixelRatio": 1
}, - "jiraIssue": {
- "key": "string",
- "url": "string"
}
}, - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "latestRun": {
- "id": "string",
- "jobId": "string",
- "status": "STARTED",
- "workerId": "string",
- "startedAt": "string",
- "completedAt": "string",
- "metadata": null,
- "createdAt": "string",
- "updatedAt": "string"
}, - "claimedBy": "string",
- "claimedAt": "string",
- "completedAt": "string",
- "autoRetryCount": 0,
- "createdAt": "string",
- "updatedAt": "string"
}| provider | string Default: "GITHUB" Value: "GITHUB" |
| owner required | string non-empty ^[A-Za-z0-9_.-]+$ |
| name required | string non-empty ^[A-Za-z0-9_.-]+$ |
| defaultBranch | string non-empty Default: "main" |
| localPath required | string non-empty |
| validationCommand | string |
| installCommand | string |
| baseUrl | string <uri> |
| trackerIntegrationId | string or null <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
{- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "main",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegrationId": "ee513105-c4ce-4cc4-83e4-507983b3ea92"
}{- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}{- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}| id required | string <uuid> |
| provider | string Default: "GITHUB" Value: "GITHUB" |
| owner required | string non-empty ^[A-Za-z0-9_.-]+$ |
| name required | string non-empty ^[A-Za-z0-9_.-]+$ |
| defaultBranch | string non-empty Default: "main" |
| localPath required | string non-empty |
| validationCommand | string |
| installCommand | string |
| baseUrl | string <uri> |
| trackerIntegrationId | string or null <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
{- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "main",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegrationId": "ee513105-c4ce-4cc4-83e4-507983b3ea92"
}{- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}{- "duplicateScenarioIds": [ ],
- "features": [
- {
- "description": "string",
- "feature": "string",
- "modifiedAt": "string",
- "path": "string",
- "scenarioCount": 0,
- "scenarios": [
- {
- "fingerprint": "string",
- "id": "string",
- "idConflict": true,
- "idSource": "tag",
- "keyword": "string",
- "line": 1,
- "name": "string",
- "steps": [
- {
- "keyword": "string",
- "line": 1,
- "matchedDefinition": {
- "expression": "string",
- "line": 1,
- "path": "string"
}, - "text": "string"
}
], - "tags": [
- "string"
], - "unmatchedStepCount": 0
}
], - "tags": [
- "string"
]
}
], - "localPath": "string",
- "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "root": "string",
- "totalScenarios": 0
}| id required | string <uuid> |
| path required | string non-empty |
{- "associatedFiles": [
- {
- "kind": "feature",
- "path": "string"
}
], - "content": "string",
- "duplicateScenarioIds": [ ],
- "feature": {
- "description": "string",
- "feature": "string",
- "modifiedAt": "string",
- "path": "string",
- "scenarioCount": 0,
- "scenarios": [
- {
- "fingerprint": "string",
- "id": "string",
- "idConflict": true,
- "idSource": "tag",
- "keyword": "string",
- "line": 1,
- "name": "string",
- "steps": [
- {
- "keyword": "string",
- "line": 1,
- "matchedDefinition": {
- "expression": "string",
- "line": 1,
- "path": "string"
}, - "text": "string"
}
], - "tags": [
- "string"
], - "unmatchedStepCount": 0
}
], - "tags": [
- "string"
]
}, - "localPath": "string",
- "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
}| id required | string <uuid> |
| path required | string non-empty |
| scenarioLine required | integer ( 0 .. 9007199254740991 ] |
{- "path": "string",
- "scenarioLine": 1
}{- "explanation": "string",
- "provider": "openai",
- "scenarioLine": 1
}| id required | string <uuid> |
| featurePath required | string [ 1 .. 500 ] characters |
| scenarioId | string [ 1 .. 200 ] characters |
| scenarioLine | integer ( 0 .. 9007199254740991 ] |
{- "featurePath": "string",
- "scenarioId": "string",
- "scenarioLine": 1
}{- "command": "string",
- "completedAt": "string",
- "createdAt": "string",
- "durationMs": 0,
- "error": "string",
- "exitCode": -9007199254740991,
- "featurePath": "string",
- "id": "string",
- "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "repositoryId": "string",
- "scenarioId": "string",
- "scenarioLine": 1,
- "scope": "FEATURE",
- "startedAt": "string",
- "status": "QUEUED",
- "stderrPath": "string",
- "stdoutPath": "string",
- "updatedAt": "string",
- "workerId": "string"
}| id required | string <uuid> |
| featurePath | string |
| limit | integer [ 1 .. 25 ] Default: 3 |
| page | integer >= 1 Default: 1 |
| scenarioId | string non-empty Scenario tag ID (without @) or fingerprint. |
| scenarioLine | integer >= 1 |
{- "averageDurationMs": 0,
- "canceledRuns": 0,
- "completedRuns": 0,
- "failedRuns": 0,
- "failureRate": 0,
- "lastRunAt": "string",
- "lastStatus": "QUEUED",
- "maxDurationMs": 0,
- "minDurationMs": 0,
- "passedRuns": 0,
- "passRate": 0,
- "queuedRuns": 0,
- "runningRuns": 0,
- "totalRuns": 0
}{- "command": "string",
- "completedAt": "string",
- "createdAt": "string",
- "durationMs": 0,
- "error": "string",
- "exitCode": -9007199254740991,
- "featurePath": "string",
- "id": "string",
- "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "repositoryId": "string",
- "scenarioId": "string",
- "scenarioLine": 1,
- "scope": "FEATURE",
- "startedAt": "string",
- "status": "QUEUED",
- "stderrPath": "string",
- "stdoutPath": "string",
- "updatedAt": "string",
- "workerId": "string"
}required | Array of objects <= 40 items |
| notes | string <= 4000 characters Default: "" |
| pageUrl required | string <uri> |
| provider required | string [ 1 .. 80 ] characters |
required | Array of objects <= 25 items |
| repositoryId required | string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
| targetBranch required | string non-empty |
required | Array of objects <= 40 items |
{- "hiddenDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
], - "notes": "",
- "provider": "string",
- "relatedCoverage": [
- {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}
], - "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
- "targetBranch": "string",
- "visibleDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
]
}{- "createdAt": "string",
- "hiddenDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
], - "id": "string",
- "notes": "string",
- "pageUrl": "string",
- "provider": "string",
- "queuedTitles": [
- "string"
], - "relatedCoverage": [
- {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}
], - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "repositoryId": "string",
- "targetBranch": "string",
- "updatedAt": "string",
- "visibleDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
]
}{- "createdAt": "string",
- "hiddenDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
], - "id": "string",
- "notes": "string",
- "pageUrl": "string",
- "provider": "string",
- "queuedTitles": [
- "string"
], - "relatedCoverage": [
- {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}
], - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "repositoryId": "string",
- "targetBranch": "string",
- "updatedAt": "string",
- "visibleDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
]
}| id required | string <uuid> |
| queuedTitles required | Array of strings <= 40 items [ items [ 1 .. 160 ] characters ] |
{- "queuedTitles": [
- "string"
]
}{- "createdAt": "string",
- "hiddenDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
], - "id": "string",
- "notes": "string",
- "pageUrl": "string",
- "provider": "string",
- "queuedTitles": [
- "string"
], - "relatedCoverage": [
- {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}
], - "repository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "repositoryId": "string",
- "targetBranch": "string",
- "updatedAt": "string",
- "visibleDecisions": [
- {
- "matchedCoverage": {
- "feature": "string",
- "path": "string",
- "scenario": "string",
- "steps": [
- "string"
], - "tags": [
- "string"
]
}, - "recommendation": {
- "acceptance": [
- "string"
], - "impact": "High",
- "reason": "string",
- "scenario": [
- "string"
], - "tags": [
- "string"
], - "title": "string"
}, - "reason": "string",
- "score": 0,
- "status": "keep"
}
]
}| page | integer >= 1 Default: 1 |
| pageSize | integer [ 1 .. 50 ] Default: 25 |
| paginated | string Enum: "true" "false" |
{- "builds": [
- {
- "id": "string",
- "baseUrl": "string",
- "createdAt": "string",
- "createdFileCount": 0,
- "destinationType": "local",
- "githubOwner": "string",
- "githubRemoteStatus": "string",
- "githubRepository": "string",
- "installResult": null,
- "installStatus": "string",
- "localGitStatus": "string",
- "openFolderResult": null,
- "openFolderStatus": "string",
- "overwrittenFileCount": 0,
- "packageName": "string",
- "projectName": "string",
- "registeredRepositoryId": "string",
- "skippedFileCount": 0,
- "smokeValidationResult": null,
- "smokeValidationStatus": "string",
- "targetBranch": "string",
- "targetDirectory": "string",
- "totalFileCount": 0,
- "updatedAt": "string"
}
], - "page": 1,
- "pageSize": 1,
- "total": 0
}{- "id": "string",
- "baseUrl": "string",
- "createdAt": "string",
- "createdFileCount": 0,
- "destinationType": "local",
- "githubOwner": "string",
- "githubPullRequestUrl": "string",
- "githubRemoteStatus": "string",
- "githubRepository": "string",
- "installResult": null,
- "installStatus": "string",
- "localGitStatus": "string",
- "openFolderResult": null,
- "openFolderStatus": "string",
- "overwrittenFileCount": 0,
- "packageName": "string",
- "projectName": "string",
- "registeredRepositoryId": "string",
- "skippedFileCount": 0,
- "smokeValidationResult": null,
- "smokeValidationStatus": "string",
- "targetBranch": "string",
- "targetDirectory": "string",
- "totalFileCount": 0,
- "updatedAt": "string"
}| baseUrl | string <uri> Default: "https://example.com" |
| destinationType | string Default: "local" Enum: "local" "github" |
| features | Array of strings Default: ["pageObjects","apiTesting","accessibility","githubActions","sampleFeature"] Items Enum: "pageObjects" "apiTesting" "accessibility" "githubActions" "sampleFeature" |
| githubBranch | string <= 160 characters ^[A-Za-z0-9_./-]*$ Default: "main" |
| githubOwner | string <= 100 characters ^[A-Za-z0-9_.-]*$ Default: "" |
| githubRepositoryId | string Default: "" |
| githubRepository | string <= 100 characters ^[A-Za-z0-9_.-]*$ Default: "" |
| packageName | string [ 1 .. 80 ] characters ^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9.... Default: "playwright-cucumber-tests" |
| projectName | string [ 1 .. 80 ] characters Default: "Playwright Cucumber Tests" |
| targetDirectory | string [ 1 .. 500 ] characters Default: "qa/e2e" |
| autoRunDependenciesAndSmoke | boolean Default: true |
| createGithubRepository | boolean Default: false |
| githubRepositoryVisibility | string Default: "private" Enum: "private" "public" |
| initializeGitRepository | boolean Default: false |
| overwriteExisting | boolean Default: false |
| registerLocalRepository | boolean Default: false |
{- "destinationType": "local",
- "features": [
- "pageObjects",
- "apiTesting",
- "accessibility",
- "githubActions",
- "sampleFeature"
], - "githubBranch": "main",
- "githubOwner": "",
- "githubRepositoryId": "",
- "githubRepository": "",
- "packageName": "playwright-cucumber-tests",
- "projectName": "Playwright Cucumber Tests",
- "targetDirectory": "qa/e2e",
- "autoRunDependenciesAndSmoke": true,
- "createGithubRepository": false,
- "githubRepositoryVisibility": "private",
- "initializeGitRepository": false,
- "overwriteExisting": false,
- "registerLocalRepository": false
}{- "directories": [
- "string"
], - "files": [
- {
- "category": "config",
- "contentPreview": "string",
- "description": "string",
- "path": "string",
- "sizeBytes": 0,
- "status": "create"
}
], - "installCommand": "string",
- "packageName": "string",
- "projectName": "string",
- "runCommand": "string",
- "targetDirectory": "string",
- "totalFiles": 0,
- "buildRecord": {
- "id": "string",
- "baseUrl": "string",
- "createdAt": "string",
- "createdFileCount": 0,
- "destinationType": "local",
- "githubOwner": "string",
- "githubRemoteStatus": "string",
- "githubRepository": "string",
- "installResult": null,
- "installStatus": "string",
- "localGitStatus": "string",
- "openFolderResult": null,
- "openFolderStatus": "string",
- "overwrittenFileCount": 0,
- "packageName": "string",
- "projectName": "string",
- "registeredRepositoryId": "string",
- "skippedFileCount": 0,
- "smokeValidationResult": null,
- "smokeValidationStatus": "string",
- "targetBranch": "string",
- "targetDirectory": "string",
- "totalFileCount": 0,
- "updatedAt": "string"
}, - "createdFiles": [
- {
- "path": "string",
- "status": "created"
}
], - "githubRemote": {
- "message": "string",
- "remoteUrl": "string",
- "repository": "string",
- "status": "created",
}, - "githubPullRequest": {
- "branchName": "string",
- "commitSha": "string",
- "prNumber": 1,
}, - "localGit": {
- "message": "string",
- "status": "initialized"
}, - "registeredRepository": {
- "id": "string",
- "provider": "GITHUB",
- "owner": "string",
- "name": "string",
- "defaultBranch": "string",
- "cloneUrl": "string",
- "webUrl": "string",
- "baseUrl": "string",
- "localPath": "string",
- "validationCommand": "string",
- "installCommand": "string",
- "trackerIntegration": {
- "id": "string",
- "name": "string",
- "provider": "JIRA",
- "projectKey": "string"
}, - "trackerIntegrationId": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "skippedFiles": [
- {
- "path": "string",
- "status": "created"
}
], - "overwrittenFiles": [
- {
- "path": "string",
- "status": "created"
}
]
}| frameworkBuildId | string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
| targetDirectory required | string [ 1 .. 500 ] characters |
{- "frameworkBuildId": "a70d9ab6-3f07-4e33-b5a4-a410de804c75",
- "targetDirectory": "string"
}{- "command": "pnpm install && pnpm exec playwright install chromium",
- "durationMs": 0,
- "exitCode": -9007199254740991,
- "message": "string",
- "status": "installed",
- "stderr": "string",
- "stdout": "string",
- "targetDirectory": "string"
}| frameworkBuildId | string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
| targetDirectory required | string [ 1 .. 500 ] characters |
{- "frameworkBuildId": "a70d9ab6-3f07-4e33-b5a4-a410de804c75",
- "targetDirectory": "string"
}{- "command": "open",
- "durationMs": 0,
- "message": "string",
- "status": "opened",
- "targetDirectory": "string"
}| frameworkBuildId | string <uuid> ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA... |
| targetDirectory required | string [ 1 .. 500 ] characters |
{- "frameworkBuildId": "a70d9ab6-3f07-4e33-b5a4-a410de804c75",
- "targetDirectory": "string"
}{- "command": "pnpm test:smoke",
- "durationMs": 0,
- "exitCode": -9007199254740991,
- "message": "string",
- "scenarios": [
- {
- "name": "string",
- "status": "passed"
}
], - "status": "passed",
- "stderr": "string",
- "stdout": "string",
- "targetDirectory": "string"
}| baseUrl | string <uri> Default: "https://example.com" |
| destinationType | string Default: "local" Enum: "local" "github" |
| features | Array of strings Default: ["pageObjects","apiTesting","accessibility","githubActions","sampleFeature"] Items Enum: "pageObjects" "apiTesting" "accessibility" "githubActions" "sampleFeature" |
| githubBranch | string <= 160 characters ^[A-Za-z0-9_./-]*$ Default: "main" |
| githubOwner | string <= 100 characters ^[A-Za-z0-9_.-]*$ Default: "" |
| githubRepositoryId | string Default: "" |
| githubRepository | string <= 100 characters ^[A-Za-z0-9_.-]*$ Default: "" |
| packageName | string [ 1 .. 80 ] characters ^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9.... Default: "playwright-cucumber-tests" |
| projectName | string [ 1 .. 80 ] characters Default: "Playwright Cucumber Tests" |
| targetDirectory | string [ 1 .. 500 ] characters Default: "qa/e2e" |
{- "destinationType": "local",
- "features": [
- "pageObjects",
- "apiTesting",
- "accessibility",
- "githubActions",
- "sampleFeature"
], - "githubBranch": "main",
- "githubOwner": "",
- "githubRepositoryId": "",
- "githubRepository": "",
- "packageName": "playwright-cucumber-tests",
- "projectName": "Playwright Cucumber Tests",
- "targetDirectory": "qa/e2e"
}{- "directories": [
- "string"
], - "files": [
- {
- "category": "config",
- "contentPreview": "string",
- "description": "string",
- "path": "string",
- "sizeBytes": 0,
- "status": "create"
}
], - "installCommand": "string",
- "packageName": "string",
- "projectName": "string",
- "runCommand": "string",
- "targetDirectory": "string",
- "totalFiles": 0
}| provider | string Default: "JIRA" Value: "JIRA" |
| name required | string [ 1 .. 80 ] characters |
| baseUrl required | string <uri> |
| email required | string <email> ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z... |
| apiToken required | string non-empty |
| projectKey required | string [ 1 .. 32 ] characters ^[A-Z][A-Z0-9_]+$ |
| issueType | string non-empty Default: "Task" |
{- "provider": "JIRA",
- "name": "string",
- "email": "user@example.com",
- "apiToken": "string",
- "projectKey": "string",
- "issueType": "Task"
}{- "id": "string",
- "provider": "JIRA",
- "name": "string",
- "baseUrl": "string",
- "email": "string",
- "hasApiToken": true,
- "projectKey": "string",
- "issueType": "string",
- "createdAt": "string",
- "updatedAt": "string"
}| id required | string |
| provider | string Default: "JIRA" Value: "JIRA" |
| name required | string [ 1 .. 80 ] characters |
| baseUrl required | string <uri> |
| email required | string <email> ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z... |
| apiToken | string |
| projectKey required | string [ 1 .. 32 ] characters ^[A-Z][A-Z0-9_]+$ |
| issueType | string non-empty Default: "Task" |
{- "provider": "JIRA",
- "name": "string",
- "email": "user@example.com",
- "apiToken": "string",
- "projectKey": "string",
- "issueType": "Task"
}{- "id": "string",
- "provider": "JIRA",
- "name": "string",
- "baseUrl": "string",
- "email": "string",
- "hasApiToken": true,
- "projectKey": "string",
- "issueType": "string",
- "createdAt": "string",
- "updatedAt": "string"
}