JsonSchema
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.
Constructors
Types
Sets additionalProperties to true or false. Use AdditionalPropertiesRef if you need to define a schema for additional properties.
Defines the schema for any additional properties not explicitly listed in properties.
deprecated
description
Configures polymorphism using a discriminator property and optional explicit mappings.
$id
Skips the property from the inferred JSON schema model
maxProperties
minProperties
multipleOf
Defines positional schemas for items within a tuple-style array (prefixItems).
readOnly
Represents a sealed interface for defining schema types in a JSON structure.
uniqueItems
writeOnly
Properties
Schema or boolean defining allowed additional properties.
Subschemas that must all be valid.
The $anchor reference anchor of the schema.
Subschemas where at least one must be valid.
Constant value for the instance.
Unlike JSON Schema, this value MUST conform to the defined type for this parameter.
Indicates that the schema is deprecated.
A verbose explanation of the schema behavior.
Polymorphic discriminator configuration.
The $dynamicAnchor dynamic anchor flag of the schema.
Allowed values for the instance.
A single example value for the schema.
A list of example values for the schema.
Numeric maximum value (exclusive).
Numeric minimum value (exclusive).
External documentation reference.
The $id identifier of the schema.
Schema for items within an array.
Maximum number of properties allowed in an object.
Minimum number of properties allowed in an object.
Numeric factor for multiples.
A subschema that must not be valid.
Subschemas where exactly one must be valid.
Positional schemas for items within an array (tuple validation).
Definitions for object properties, keyed by property name.
The type of the schema (e.g. string, object, array).
Indicates whether all items in an array must be unique.