Compose

The project's most recent stored Compose check (from its last deployment or the revalidation after an upgrade); `null` when it was never checked.

Changed on
get/projects/{project_id}/compose-validation

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/compose-validation
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Response

Last stored check, or null

checked_atstring date-time required
errorstring nullable
error_class'interpolation' | 'policy_violation' | 'invalid_path' | 'invalid_yaml' | 'invalid_override' | 'unsupported_compose_version' | 'config_resolution' | 'compose_unavailable' | 'internal'

Stable, user-facing class of a Compose check failure. The deploy job, the preview and the check action all report the same class for the same input.

outdatedboolean required

True when the check ran under an older validation revision than this server's and has not been repeated yet.

passedboolean required
project_idinteger required

Changes