Manifest

Validate Manifest

Changed on

Validate a YAML manifest without applying.

Checks:

  • YAML syntax validity
  • Schema validation against manifest models
  • Cross-resource reference validation
  • Dependency resolution (no circular dependencies)
  • Secret reference existence
  • Every extractor a namespace or collection names exists and is turned on
  • Retriever stages are registered and their parameters valid
  • Every feature URI a retriever or cluster names is written by a collection
  • Alert applications map every input their alert's retriever requires
  • Namespace budgets above the organization's bound (a warning: apply sets the bound)

These are the checks apply runs before creating anything, so a manifest that validates with no errors is one apply will not refuse on references.

Returns detailed validation results including:

  • Resource counts by type
  • Missing secrets that need to be configured
  • Validation errors and warnings

Example:

curl -X POST /v1/manifest/validate \
  -H "Authorization: Bearer $API_KEY" \
  -F "manifest_file=@mixpeek.yaml"
post/v1/manifest/validate

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/manifest/validate
  • Auth: HTTP bearer

Request body multipart/form-data

manifest_filestring binary required

YAML manifest file

parametersstring nullable

JSON object of values for the manifest's declared parameters, e.g. {"camera_url": "rtsp://host/stream", "polling_seconds": 300}. Each value must match its declared type. Omit when the manifest declares none.

Response

Successful Response

validboolean required

Whether the manifest is valid

resourcesobject

Count of each resource type

missing_secretsstring[]

Secret names referenced but not configured

errorsstring[]

Validation errors

warningsstring[]

Validation warnings

Example response

{
  "errors": [],
  "missing_secrets": [],
  "resources": {
    "buckets": 2,
    "collections": 1,
    "namespaces": 1,
    "retrievers": 1
  },
  "valid": true,
  "warnings": []
}

Changes

  • 790bc16455f6Revision changes
    • breaking

      response property parameters/items/default list-of-types was widened by adding types array to media type application/json of response 200

    • warning

      added the new array enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status