Homepage

UpdateModelSchemaInputType

Last edit: Oct 13, 2026

Attributes of a model schema to change; omitted attributes keep their current value

type UpdateModelSchemaInputType {
  fields: [NestedPropertyInputType]
  metadata: HashObject
  name: String
  physical_file_path: String
  properties: [NestedPropertyInputType]
}

Fields

fields (NestedPropertyInputType)

Deprecated, use properties

metadata (HashObject)

Arbitrary JSON data stored with the schema; replaces the existing metadata

name (String)

Deprecated, the name is derived from physical_file_path

physical_file_path (String)

New path of the file the model schema is stored as. Must be
schema/<name>.yml (or legacy custom_model_types/ or model_schemas/),
optionally prefixed with modules/<module_name>/public/ or
modules/<module_name>/private/. The schema name is not changed

properties (NestedPropertyInputType)

Properties to add, change or remove: entries with an id change that property
(or remove it with _destroy), entries without an id are added; properties not
listed are kept

Questions?

We are always happy to help with any questions you may have.

contact us