OMomniapp
Models

Get model YAML

Changed on
get/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

Query parameters

branchIdstring uuid

Branch ID for branch-aware operations

fileNamestring

File name to operate on

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

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

string
OR
boolean
includeChecksumsboolean nullable

Include checksums in response

includeSchemasstring

A single schema name (optionally catalog-scoped, e.g. 'warehouse.reporting') to additionally load into the response. Use this to include view YAML from a schema that isn't active in the model (inactive or offloaded). Only views from this schema will be returned (views with no schema are always included).

Response

Model YAML content

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

  • d84b70fbd0efRevision changes
    • breaking

      the / response's property type changed from no type to string for status