Interface IMetadataSchema

The metadata schema as defined in JSON schema.

interface IMetadataSchema {
    $comment?: string;
    $defs?: {
        [key: string]: JSONSchema7Definition;
    };
    $id?: string;
    $ref?: string;
    $schema?: string;
    additionalItems?: JSONSchema7Definition;
    additionalProperties?: JSONSchema7Definition;
    allOf?: PartialJSONObject[];
    anyOf?: JSONSchema7Definition[];
    const?: JSONSchema7Type;
    contains?: JSONSchema7Definition;
    contentEncoding?: string;
    contentMediaType?: string;
    default?: JSONSchema7Type;
    definitions?: {
        [key: string]: JSONSchema7Definition;
    };
    dependencies?: {
        [key: string]: JSONSchema7Definition | string[];
    };
    description?: string;
    else?: JSONSchema7Definition;
    enum?: JSONSchema7Type[];
    examples?: JSONSchema7Type;
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    format?: string;
    if?: JSONSchema7Definition;
    items?: JSONSchema7Definition | JSONSchema7Definition[];
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    not?: JSONSchema7Definition;
    oneOf?: JSONSchema7Definition[];
    pattern?: string;
    patternProperties?: {
        [key: string]: JSONSchema7Definition;
    };
    properties: {
        [option: string]: any;
    };
    propertyNames?: JSONSchema7Definition;
    readOnly?: boolean;
    required?: string[];
    then?: JSONSchema7Definition;
    title?: string;
    type?: JSONSchema7TypeName | JSONSchema7TypeName[];
    uniqueItems?: boolean;
    writeOnly?: boolean;
}

Hierarchy

  • RJSFSchema
    • IMetadataSchema

Properties

$comment? $defs? $id? $ref? $schema? additionalItems? additionalProperties? allOf? anyOf? const? contains? contentEncoding? contentMediaType? default? definitions? dependencies? description? else? enum? examples? exclusiveMaximum? exclusiveMinimum? format? if? items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? not? oneOf? pattern? patternProperties? properties propertyNames? readOnly? required? then? title? type? uniqueItems? writeOnly?

Properties

Optional $comment

$comment?: string

Optional $defs

$defs?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

  • [key: string]: JSONSchema7Definition

See

Optional $id

$id?: string

Optional $ref

$ref?: string

Optional $schema

$schema?: string

Optional additionalItems

additionalItems?: JSONSchema7Definition

Optional additionalProperties

additionalProperties?: JSONSchema7Definition

Optional allOf

allOf?: PartialJSONObject[]

Support for allOf feature of JSON schema (useful for if/then/else).

Optional anyOf

anyOf?: JSONSchema7Definition[]

Optional const

const?: JSONSchema7Type

Optional contains

contains?: JSONSchema7Definition

Optional contentEncoding

contentEncoding?: string

Optional contentMediaType

contentMediaType?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8

Optional default

default?: JSONSchema7Type

Optional definitions

definitions?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

  • [key: string]: JSONSchema7Definition

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9

Optional dependencies

dependencies?: {
    [key: string]: JSONSchema7Definition | string[];
}

Type declaration

  • [key: string]: JSONSchema7Definition | string[]

Optional description

description?: string

Optional else

else?: JSONSchema7Definition

Optional enum

enum?: JSONSchema7Type[]

Optional examples

examples?: JSONSchema7Type

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional format

format?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7

Optional if

if?: JSONSchema7Definition

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6

Optional items

items?: JSONSchema7Definition | JSONSchema7Definition[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4

Optional maxItems

maxItems?: number

Optional maxLength

maxLength?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3

Optional maxProperties

maxProperties?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5

Optional maximum

maximum?: number

Optional minItems

minItems?: number

Optional minLength

minLength?: number

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2

Optional not

not?: JSONSchema7Definition

Optional oneOf

oneOf?: JSONSchema7Definition[]

Optional pattern

pattern?: string

Optional patternProperties

patternProperties?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

  • [key: string]: JSONSchema7Definition

properties

properties: {
    [option: string]: any;
}

The properties as defined in JSON schema, and interpretable by react-JSON-schema-form.

Type declaration

  • [option: string]: any

Optional propertyNames

propertyNames?: JSONSchema7Definition

Optional readOnly

readOnly?: boolean

Optional required

required?: string[]

The required fields.

Optional then

then?: JSONSchema7Definition

Optional title

title?: string

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10

Optional type

type?: JSONSchema7TypeName | JSONSchema7TypeName[]

See

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1

Optional uniqueItems

uniqueItems?: boolean

Optional writeOnly

writeOnly?: boolean

Settings

Member Visibility

Theme

On This Page

$comment$defs$id$ref$schemaadditionalItemsadditionalPropertiesallOfanyOfconstcontainscontentEncodingcontentMediaTypedefaultdefinitionsdependenciesdescriptionelseenumexamplesexclusiveMaximumexclusiveMinimumformatifitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnotoneOfpatternpatternPropertiespropertiespropertyNamesreadOnlyrequiredthentitletypeuniqueItemswriteOnly