Interface ElementSchema

Hierarchy

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

Unique Schema ID

Optional additionalProperties

additionalProperties?: boolean

Enable additional = not-defined properties

Optional default

default?: any

Default attribute value

Optional dependencies

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

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

Optional description

description?: string

Attribute description

Optional examples

examples?: any[]

List of attribute examples

Optional id

id?: string

DB Record ID

Optional legacyId

legacyId?: string

Optional maxProperties

maxProperties?: number

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

Optional minProperties

minProperties?: number

Optional organizationId

organizationId?: string[]

Optional parentSchemaId

parentSchemaId?: string

Optional patternProperties

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

Optional properties

properties?: Record<string, Attribute>

List of internal properties

Optional propertyNames

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

Type declaration

  • pattern: string

Optional putLegacyOverride

putLegacyOverride?: boolean

Optional readOnly

readOnly?: boolean

Non-editable schema

Optional required

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

Theme

On This Page

Generated using TypeDoc