Models

Update model YAML

Changed on
post/api/v1/models/{modelId}/yaml

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}/yaml
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

Model UUID

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

Request body

branchIdstring uuid

Branch ID for branch-aware operations

fileNamestring required

File name to create or update

mode'combined' | 'extension' | 'staged' | 'merged' | 'fully-resolved'

IDE mode for YAML operations. 'merged' requires branchId on a shared or shared extension model.

commitMessagestring

Commit message for git sync

fetchedAtMillisnumber

Timestamp when the file was fetched

fullyResolvedboolean

Treat the posted YAML as fully resolved (with the extends chain expanded). Only valid with mode=combined.

previousChecksumstring

Previous checksum for conflict detection

rejectIfViewExistsboolean

Only applies to .view files. Return 400 if this model layer already defines the resolved view name. Inherited views do not count. Cannot be true with branchId. Omitted or false preserves the default save behavior.

yamlstring required

YAML content for the file

Response

Model YAML updated

checksumsobject

Checksums for each file

filesobject required

YAML content for each file

versionnumber required

Model version number

viewNamesobject

Mapping of file name to view name

Changes