curl --request POST \
--url https://api.example.com/v1/projects/{project}/releases:check \
--header 'Content-Type: application/json' \
--data '
{
"parent": "<string>",
"release": {
"title": "<string>",
"files": [
{
"id": "<string>",
"path": "<string>",
"type": "TYPE_UNSPECIFIED",
"version": "<string>",
"enableGhost": true,
"sheet": "<string>",
"statement": "<string>"
}
],
"vcsSource": {
"vcsType": "VCS_TYPE_UNSPECIFIED",
"url": "<string>"
},
"digest": "<string>"
},
"targets": [
"<string>"
],
"customRules": "<string>"
}
'{
"results": [
{
"file": "<string>",
"target": "<string>",
"advices": [
{
"status": "STATUS_UNSPECIFIED",
"code": 123,
"title": "<string>",
"content": "<string>",
"startPosition": {
"line": 123,
"column": 123
},
"endPosition": {
"line": 123,
"column": 123
}
}
],
"affectedRows": "<string>",
"riskLevel": "RISK_LEVEL_UNSPECIFIED"
}
],
"affectedRows": "<string>",
"riskLevel": "RISK_LEVEL_UNSPECIFIED"
}Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check
curl --request POST \
--url https://api.example.com/v1/projects/{project}/releases:check \
--header 'Content-Type: application/json' \
--data '
{
"parent": "<string>",
"release": {
"title": "<string>",
"files": [
{
"id": "<string>",
"path": "<string>",
"type": "TYPE_UNSPECIFIED",
"version": "<string>",
"enableGhost": true,
"sheet": "<string>",
"statement": "<string>"
}
],
"vcsSource": {
"vcsType": "VCS_TYPE_UNSPECIFIED",
"url": "<string>"
},
"digest": "<string>"
},
"targets": [
"<string>"
],
"customRules": "<string>"
}
'{
"results": [
{
"file": "<string>",
"target": "<string>",
"advices": [
{
"status": "STATUS_UNSPECIFIED",
"code": 123,
"title": "<string>",
"content": "<string>",
"startPosition": {
"line": 123,
"column": 123
},
"endPosition": {
"line": 123,
"column": 123
}
}
],
"affectedRows": "<string>",
"riskLevel": "RISK_LEVEL_UNSPECIFIED"
}
],
"affectedRows": "<string>",
"riskLevel": "RISK_LEVEL_UNSPECIFIED"
}The project id.
Format: projects/{project}
The release to check.
Show child attributes
The targets to dry-run the release. Can be database or databaseGroup. Format: projects/{project}/databaseGroups/{databaseGroup} instances/{instance}/databases/{database}
Custom linting rules in natural language for AI-powered validation. Each rule should be a clear statement describing the desired schema constraint. Example: "All tables must have a primary key" Example: "VARCHAR columns should specify a maximum length"
Was this page helpful?