Templates

Dry-run a payload against a template schema

Renders nothing and costs nothing. Returns the same field-level errors POST /v1/render would.

post/v1/templates/{ref}/validate

Request

  • Base URL: https://api.galleyrender.com
  • URL: https://api.galleyrender.com/v1/templates/{ref}/validate
  • Auth: HTTP bearer

Path parameters

refstring required
Example:invoice

invoice for the latest version, or invoice@3 to pin one.

Request body

dataunknown required

Response

Whether the payload is valid, and why not.

object'validation' required
templatestring required
validboolean required
exampleunknown

Example response

{
  "template": "invoice@1",
  "errors": [
    {
      "path": "data.line_items[1].quantity",
      "expected": "number",
      "received": "string"
    }
  ],
  "warnings": [
    {
      "path": "data.deposit",
      "did_you_mean": "data.deposit_amount"
    }
  ]
}

Changes

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