Models

Validate model

get/api/v1/models/{modelId}/validate

Request

Base URL
https://omniapp.co (the document declares no server; this is the origin it was published from)
URL
https://omniapp.co/api/v1/models/{modelId}/validate
Auth
HTTP bearer

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

branchIdstring uuid

Branch ID to validate

limitinteger

Maximum number of validation issues to return

Validation results

is_warningboolean required

False for an error, true for a warning

messagestring required

Validation issue message

prop_namestring

Model property the issue is about

slugstring required

Stable identifier for the kind of issue

yaml_pathstring required

Where the issue is: the model file, then the YAML keys down to the object, comma-separated

[
  {
    "yaml_path": "orders.view,dimensions,total"
  }
]