The metadata schema as defined in JSON schema.

Hierarchy

  • RJSFSchema
    • IMetadataSchema

Properties

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

Type declaration

  • [key: string]: JSONSchema7Definition
$id?: string
$ref?: string
$schema?: string
additionalItems?: JSONSchema7Definition
additionalProperties?: JSONSchema7Definition
allOf?: PartialJSONObject[]

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

anyOf?: JSONSchema7Definition[]
const?: JSONSchema7Type
contains?: JSONSchema7Definition
contentEncoding?: string
contentMediaType?: string
default?: JSONSchema7Type
definitions?: {
    [key: string]: JSONSchema7Definition;
}

Type declaration

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

Type declaration

  • [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;
}

Type declaration

  • [key: string]: JSONSchema7Definition
properties: {
    [option: string]: any;
}

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

Type declaration

  • [option: string]: any
propertyNames?: JSONSchema7Definition
readOnly?: boolean
required?: string[]

The required fields.

then?: JSONSchema7Definition
title?: string
type?: JSONSchema7TypeName | JSONSchema7TypeName[]
uniqueItems?: boolean
writeOnly?: boolean

Generated using TypeDoc