Skip to main content
POST
Validate a resource

Authorizations

Authorization
string
header
required

a valid bearer token

Path Parameters

projectId
string<uuid>
required

The UUID of the project the resource belongs to

Query Parameters

runnerId
string
required

The ID of the runner to validate against. The runner version is derived from this ID, and it must be a runner the project and environment can use.

Minimum string length: 1
fileName
string
required

The name of the resource file being validated. The file extension determines validation behaviour: .orch.yaml, .tran.yaml, or .test.yaml.

Minimum string length: 1
depth
integer<int32>
default:1

The validation depth, from 1 (syntax only) to 4 (full validation, invoking all Runner capabilities).

Required range: 1 <= x <= 4
environmentName
string
required

The environment whose parameters, configuration, and data warehouse type the resource is validated against. Required at every depth.

Minimum string length: 1

Body

text/plain

The body is of type string.

Response

Validation completed (synchronous, depth 1-2)

The result of a resource validation request.

invalidComponentCount
integer<int32>

The number of components within the resource that were found to be invalid. Present when components were validated individually.

Example:

2

invalidComponentNames
string[]

The names of components within the resource that were found to be invalid.

Example:
messages
object[]

The set of validation findings produced by this validation run. Empty for a fully VALID resource.

operationId
string

Identifier of the asynchronous validation operation. Present when the status is PENDING.

Example:

"abc123def456"

status
enum<string>

Overall validation status. VALID and INVALID are terminal; PENDING indicates that asynchronous processing is still in progress and the caller should poll the operation ID.

Available options:
VALID,
INVALID,
PENDING
Example:

"VALID"