STsteep
code

POST /v1/code/validate

Check a set of Steep YAML files before syncing them, e.g. in CI: returns whether they are valid and every problem, each pointing at its file. Only the files are checked: nothing is read from your workspace or warehouse, so metric operands, categories, owners, tables and columns are not checked. No API key needed. Send all Steep YAML files, not only the changed ones. Nothing is written; to see what a sync would change, use dryRun on POST /v1/code/syncs. The request may be up to 10 MB.

Request

  • Base URL
    https://help.steep.app (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

Response

Response for status 200

validboolean required

false when any problem is fatal or an error. Warnings alone keep it true.

Changes

No recorded changes to this operation across all 1 revision of this API.