Lightdash · Example Payload

Lightdash Projects Example

Projects

Lightdash Projects Example is an example object payload from Lightdash, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

methodpathsummarytagsrequestBodyresponses

Example Payload

Raw ↑ 
{
  "method": "POST",
  "path": "/api/v1/projects/{projectUuid}/validate",
  "summary": "Validate project",
  "tags": [
    "Projects"
  ],
  "requestBody": {
    "description": "the compiled explores to validate against an existing project, this is used in the CLI to validate a project without creating a preview",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "validationTargets": {
              "items": {
                "$ref": "#/components/schemas/ValidationTarget"
              },
              "type": "array"
            },
            "explores": {
              "items": {
                "$ref": "#/components/schemas/AnyType"
              },
              "type": "array"
            },
            "onlyValidateExploresInArgs": {
              "type": "boolean"
            }
          },
          "type": "object",
          "description": "the compiled explores to validate against an existing project, this is used in the CLI to validate a project without creating a preview"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiJobScheduledResponse"
          }
        }
      }
    },
    "default": {
      "description": "Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiErrorPayload"
          }
        }
      }
    }
  }
}