Validate project - Lightdash

Error

A valid request URL is required to generate request examples

{
  "results": {
    "jobId": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

POST

api

projects

{projectUuid}

validate

Error

A valid request URL is required to generate request examples

{
  "results": {
    "jobId": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid

string

required

the projectId for the validation

Body

application/json

the compiled explores to validate against an existing project, this is used in the CLI to validate a project without creating a preview

validationTargets

enum<string>[]

Available options:

apps,

charts,

dashboards,

tables

explores

any[]

This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are only used on legacy any types, don't use it for new types. This is added on a separate file to avoid circular dependencies.

onlyValidateExploresInArgs

boolean

Response

Success

results

object

required

Show child attributes

status

enum<string>

required

Available options:

ok