Homepage

ModelSchemaInputType

Last edit: Oct 13, 2026

Attributes of a model schema (table); prefer TableInputType with admin_table_create

type ModelSchemaInputType {
  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

name (String)

Deprecated, the name is derived from physical_file_path

physical_file_path (String)

Path of the file the model schema is stored as, used by pos-cli pull and
deploy. 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 derived from it, for
example schema/blog_post.yml gives blog_post

properties (NestedPropertyInputType)

Properties (columns) of the schema

Questions?

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

contact us