Properties
Optional $comment
$comment: string
Optional $ref
$ref: string
Optional $schema
$schema: string
Optional @id
@id: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:19
Optional additionalItems
additionalItems: JSONSchema7Definition
Optional additionalProperties
additionalProperties: JSONSchema7Definition
Optional aliases
aliases: string []
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:75
Optional category
category: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:36
Optional children
children: string []
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:45
Optional const
const: JSONSchema7Type
Optional contains
contains: JSONSchema7
Optional contentEncoding
contentEncoding: string
Optional contentMediaType
contentMediaType: string
Optional default
default: JSONSchema7Type
Optional definitions
definitions: {}
Type declaration
[ key: string ]: JSONSchema7Definition
Optional dependencies
dependencies: {}
Type declaration
[ key: string ]: JSONSchema7Definition | string []
Optional descendants
descendants: string []
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:50
Optional description
description: string
Optional else
else: JSONSchema7Definition
Optional enum
enum: ( string | number ) []
Optional examples
examples: JSONSchema7Type
Optional exclusiveMaximum
exclusiveMaximum: number
Optional exclusiveMinimum
exclusiveMinimum: number
Optional extends
extends: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:40
Optional file
file: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:93
Optional format
format: string
Optional from
from: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:56
Optional if
if: JSONSchema7Definition
Optional isArray
isArray: boolean
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:66
Optional isOverride
isOverride: boolean
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:62
Optional isPlural
isPlural: boolean
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:70
Optional maxItems
maxItems: number
Optional maxLength
maxLength: number
Optional maxProperties
maxProperties: number
Optional maximum
maximum: number
Optional minItems
minItems: number
Optional minLength
minLength: number
Optional minProperties
minProperties: number
Optional minimum
minimum: number
Optional multipleOf
multipleOf: number
Optional not
not: JSONSchema7Definition
Optional oneOf
oneOf: JSONSchema7Definition []
Optional parser
parser: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:88
Optional pattern
pattern: string
Optional patternProperties
patternProperties: {}
Type declaration
[ key: string ]: JSONSchema7Definition
Optional properties
properties: {}
Optional propertyAliases
propertyAliases: {}
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:81
Optional propertyNames
propertyNames: JSONSchema7Definition
Optional readOnly
readOnly: boolean
Optional required
required: string []
Optional role
role: "base" | "primary" | "secondary" | "tertiary"
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:28
Optional source
source: string
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:98
Optional status
status: "experimental" | "unstable" | "stable"
Defined in node_modules/@stencila/schema/dist/ts/JsonSchema.d.ts:32
Optional then
then: JSONSchema7Definition
Optional title
title: string
Optional type
type: JSONSchema7TypeName | JSONSchema7TypeName []
Optional uniqueItems
uniqueItems: boolean
Optional writeOnly
writeOnly: boolean
Interface for Stencila
JsonSchema
instances.The
JsonSchema
interface extends JSON Schema with additional properties for:For more details see the guidelines for authoring schemas.