Interface ElementSchema

interface ElementSchema {
    $comment?: string;
    $id: `#${string}/${Type}`;
    additionalProperties?: boolean;
    default?: any;
    dependencies?: Record<string, string[] | ObjectProp>;
    description?: string;
    examples?: any[];
    id?: string;
    legacyId?: string;
    maxProperties?: number;
    minProperties?: number;
    organizationId?: string[];
    parentSchemaId?: string;
    patternProperties?: Record<string, Attribute>;
    properties?: Record<string, Attribute>;
    propertyNames?: { pattern: string };
    putLegacyOverride?: boolean;
    readOnly?: boolean;
    required?: string[];
    scope: string;
    title: string;
    type: NativeType;
}

Hierarchy (View Summary)

Properties

$comment? $id additionalProperties? default? dependencies? description? examples? id? legacyId? maxProperties? minProperties? organizationId? parentSchemaId? patternProperties? properties? propertyNames? putLegacyOverride? readOnly? required? scope title type

Properties

Optional$comment

$comment?: string

Internal comment

$id

$id: `#${string}/${Type}`

Unique Schema ID

OptionaladditionalProperties

additionalProperties?: boolean

Enable additional = not-defined properties

Optionaldefault

default?: any

Default attribute value

Optionaldependencies

dependencies?: Record<string, string[] | ObjectProp>

https://json-schema.org/understanding-json-schema/reference/object.html?highlight=object#dependencies

Optionaldescription

description?: string

Attribute description

Optionalexamples

examples?: any[]

List of attribute examples

Optionalid

id?: string

DB Record ID

OptionallegacyId

legacyId?: string

OptionalmaxProperties

maxProperties?: number

https://json-schema.org/understanding-json-schema/reference/object.html?highlight=object#size

OptionalminProperties

minProperties?: number

OptionalorganizationId

organizationId?: string[]

OptionalparentSchemaId

parentSchemaId?: string

OptionalpatternProperties

patternProperties?: Record<string, Attribute>

List of internal properties but defined by regex not specific name https://json-schema.org/understanding-json-schema/reference/object.html?highlight=object#pattern-properties

Optionalproperties

properties?: Record<string, Attribute>

List of internal properties

OptionalpropertyNames

propertyNames?: { pattern: string }

Regex for custom property names = does not have to be defined, https://json-schema.org/understanding-json-schema/reference/object.html?highlight=object#property-names

OptionalputLegacyOverride

putLegacyOverride?: boolean

OptionalreadOnly

readOnly?: boolean

Non-editable schema

Optionalrequired

required?: string[]

https://json-schema.org/understanding-json-schema/reference/object.html?highlight=object#property-names

scope

scope: string

Organization scope

title

title: string

Human readable name

type

type: NativeType

Type

Settings

Member Visibility

On This Page

Properties