OMomni
Models

Validate model

Changed on

Retrieve validation issues for a model and its branches.

get/v1/models/{modelId}/validate

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/validate
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

The ID of the model.

Query parameters

branchIdstring uuid

The ID of the branch to validate. The branch must exist for the model. If not provided, the model is validated directly. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

Note: Schema models do not support branches.

Response

A list of validation issues.

messagestring required

The validation issue message.

is_warningboolean required

If true, the issue is a warning. If false, the issue is an error.

yaml_pathstring required

Where the issue is, as a comma-separated path from the model file through the YAML keys down to the object, for example orders.view,dimensions,total.

slugstring required

Stable identifier for the kind of issue.

prop_namestring

Model property the issue is about.

Changes

  • 43290040f88fRevision changes
    • info

      added the optional property / to the response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status