JsonSchema Class

Note: This API is now obsolete.

An in-memory representation of a JSON Schema.

Caution
JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.

Inheritance Hierarchy

SystemObject
Newtonsoft.Json.SchemaJsonSchema

Namespace: Newtonsoft.Json.Schema
Assembly: Newtonsoft.Json (in Newtonsoft.Json.dll) Version: 12.0.1+509643a8952ce731e0207710c429ad6e67dc43db

Syntax

Copy

[ObsoleteAttribute("JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details.")]
public class JsonSchema

The JsonSchema type exposes the following members.

Constructors

	Name	Description
	JsonSchema	Initializes a new instance of the JsonSchema class.

Top

Properties

	Name	Description
	AdditionalItems	Gets or sets the JsonSchema of additional items.
	AdditionalProperties	Gets or sets the JsonSchema of additional properties.
	AllowAdditionalItems	Gets or sets a value indicating whether additional items are allowed.
	AllowAdditionalProperties	Gets or sets a value indicating whether additional properties are allowed.
	Default	Gets or sets the default value.
	Description	Gets or sets the description of the object.
	Disallow	Gets or sets disallowed types.
	DivisibleBy	Gets or sets a number that the value should be divisible by.
	Enum	Gets or sets the a collection of valid enum values allowed.
	ExclusiveMaximum	Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (Maximum).
	ExclusiveMinimum	Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (Minimum).
	Extends	Gets or sets the collection of JsonSchema that this schema extends.
	Format	Gets or sets the format.
	Hidden	Gets or sets whether the object is visible to users.
	Id	Gets or sets the id.
	Items	Gets or sets the JsonSchema of items.
	Maximum	Gets or sets the maximum.
	MaximumItems	Gets or sets the maximum number of items.
	MaximumLength	Gets or sets the maximum length.
	Minimum	Gets or sets the minimum.
	MinimumItems	Gets or sets the minimum number of items.
	MinimumLength	Gets or sets the minimum length.
	Pattern	Gets or sets the pattern.
	PatternProperties	Gets or sets the pattern properties.
	PositionalItemsValidation	Gets or sets a value indicating whether items in an array are validated using the JsonSchema instance at their array position from Items.
	Properties	Gets or sets the JsonSchema of properties.
	ReadOnly	Gets or sets whether the object is read-only.
	Required	Gets or sets whether the object is required.
	Requires	Gets or sets the required property if this property is present.
	Title	Gets or sets the title.
	Transient	Gets or sets whether the object is transient.
	Type	Gets or sets the types of values allowed by the object.
	UniqueItems	Gets or sets whether the array items must be unique.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Parse(String)	Load a JsonSchema from a string that contains JSON Schema.
	Parse(String, JsonSchemaResolver)	Load a JsonSchema from a string that contains JSON Schema using the specified JsonSchemaResolver.
	Read(JsonReader)	Reads a JsonSchema from the specified JsonReader.
	Read(JsonReader, JsonSchemaResolver)	Reads a JsonSchema from the specified JsonReader.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)
	WriteTo(JsonWriter)	Writes this schema to a JsonWriter.
	WriteTo(JsonWriter, JsonSchemaResolver)	Writes this schema to a JsonWriter using the specified JsonSchemaResolver.

Top

Reference

Newtonsoft.Json.Schema Namespace