Class JsonSchema

Encapsulates and models JSON Schema.

Inheritance
System.Object
System.Collections.Generic.List<IJsonSchemaKeyword>
JsonSchema
Implements
System.Collections.Generic.IList<IJsonSchemaKeyword>
System.Collections.Generic.ICollection<IJsonSchemaKeyword>
System.Collections.Generic.IReadOnlyList<IJsonSchemaKeyword>
System.Collections.Generic.IReadOnlyCollection<IJsonSchemaKeyword>
System.Collections.Generic.IEnumerable<IJsonSchemaKeyword>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.IEquatable<JsonSchema>
Inherited Members
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.get_Item(System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.set_Item(System.Int32, System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Add(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.AddRange(System.Collections.Generic.IEnumerable<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.AsReadOnly()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.BinarySearch(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.BinarySearch(Manatee.Json.Schema.IJsonSchemaKeyword, System.Collections.Generic.IComparer<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.BinarySearch(System.Int32, System.Int32, Manatee.Json.Schema.IJsonSchemaKeyword, System.Collections.Generic.IComparer<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Clear()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Contains(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.ConvertAll<TOutput>(System.Converter<Manatee.Json.Schema.IJsonSchemaKeyword, TOutput>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.CopyTo(Manatee.Json.Schema.IJsonSchemaKeyword[])
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.CopyTo(Manatee.Json.Schema.IJsonSchemaKeyword[], System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.CopyTo(System.Int32, Manatee.Json.Schema.IJsonSchemaKeyword[], System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Exists(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Find(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindAll(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindIndex(System.Int32, System.Int32, System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindIndex(System.Int32, System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindIndex(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindLast(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindLastIndex(System.Int32, System.Int32, System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindLastIndex(System.Int32, System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.FindLastIndex(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.ForEach(System.Action<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.GetEnumerator()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.GetRange(System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.IndexOf(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.IndexOf(Manatee.Json.Schema.IJsonSchemaKeyword, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.IndexOf(Manatee.Json.Schema.IJsonSchemaKeyword, System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Insert(System.Int32, Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.InsertRange(System.Int32, System.Collections.Generic.IEnumerable<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.LastIndexOf(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.LastIndexOf(Manatee.Json.Schema.IJsonSchemaKeyword, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.LastIndexOf(Manatee.Json.Schema.IJsonSchemaKeyword, System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Remove(Manatee.Json.Schema.IJsonSchemaKeyword)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.RemoveAll(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.RemoveAt(System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.RemoveRange(System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Reverse()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Reverse(System.Int32, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Sort()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Sort(System.Collections.Generic.IComparer<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Sort(System.Comparison<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Sort(System.Int32, System.Int32, System.Collections.Generic.IComparer<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.Generic.IEnumerable<Manatee.Json.Schema.IJsonSchemaKeyword>.GetEnumerator()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IEnumerable.GetEnumerator()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.Add(System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.Contains(System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.IndexOf(System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.Insert(System.Int32, System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.Remove(System.Object)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.ToArray()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.TrimExcess()
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.TrueForAll(System.Predicate<Manatee.Json.Schema.IJsonSchemaKeyword>)
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Capacity
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Count
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.Item[System.Int32]
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.Generic.ICollection<Manatee.Json.Schema.IJsonSchemaKeyword>.IsReadOnly
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.ICollection.IsSynchronized
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.ICollection.SyncRoot
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.IsFixedSize
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.IsReadOnly
System.Collections.Generic.List<Manatee.Json.Schema.IJsonSchemaKeyword>.System.Collections.IList.Item[System.Int32]
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Manatee.Json.Schema
Assembly: Manatee.Json.dll
Syntax
public class JsonSchema : List<IJsonSchemaKeyword>, IList<IJsonSchemaKeyword>, ICollection<IJsonSchemaKeyword>, IReadOnlyList<IJsonSchemaKeyword>, IReadOnlyCollection<IJsonSchemaKeyword>, IEnumerable<IJsonSchemaKeyword>, IList, ICollection, IEnumerable, IJsonSerializable, IEquatable<JsonSchema>

Constructors

| Improve this Doc View Source

JsonSchema()

Creates a new instance of the JsonSchema class.

Declaration
public JsonSchema()
| Improve this Doc View Source

JsonSchema(Boolean)

Creates a new instance of the JsonSchema class, explicitly set to a true/false value.

Declaration
public JsonSchema(bool value)
Parameters
Type Name Description
System.Boolean value

Fields

| Improve this Doc View Source

Empty

Defines the empty schema. Analogous to True.

Declaration
public static readonly JsonSchema Empty
Field Value
Type Description
JsonSchema
| Improve this Doc View Source

False

Defines the False schema. Validates no JSON instances.

Declaration
public static readonly JsonSchema False
Field Value
Type Description
JsonSchema
| Improve this Doc View Source

True

Defines the True schema. Validates all JSON instances.

Declaration
public static readonly JsonSchema True
Field Value
Type Description
JsonSchema

Properties

| Improve this Doc View Source

DocumentPath

Defines the document path. If not explicitly provided, it will be derived from the Id property.

Declaration
public Uri? DocumentPath { get; set; }
Property Value
Type Description
System.Nullable<System.Uri>
| Improve this Doc View Source

ErrorTemplate

Gets or sets the error message template used for false schemas.

Declaration
public static string ErrorTemplate { get; set; }
Property Value
Type Description
System.String
Remarks

Does not supports any tokens.

| Improve this Doc View Source

Id

Gets the $id (or id for draft-04) property value, if declared.

Declaration
public string? Id { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

OtherData

Gets other data that may be present in the schema but unrelated to any known keywords.

Declaration
public JsonObject OtherData { get; set; }
Property Value
Type Description
JsonObject
| Improve this Doc View Source

ProcessingVersion

Gets or sets the processing version for this schema.

Declaration
public JsonSchemaVersion? ProcessingVersion { get; set; }
Property Value
Type Description
System.Nullable<JsonSchemaVersion>
| Improve this Doc View Source

Schema

Gets the $schema property, if declared.

Declaration
public string? Schema { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

SupportedVersions

Declaration
public JsonSchemaVersion SupportedVersions { get; }
Property Value
Type Description
JsonSchemaVersion

Methods

| Improve this Doc View Source

Equals(Nullable<JsonSchema>)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(JsonSchema? other)
Parameters
Type Name Description
System.Nullable<JsonSchema> other

An object to compare with this object.
Returns
Type Description
System.Boolean

true if the current object is equal to the other parameter; otherwise, false.
| Improve this Doc View Source

Equals(Nullable<Object>)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
System.Nullable<System.Object> obj

The object to compare with the current object.
Returns
Type Description
System.Boolean

true if the specified object is equal to the current object; otherwise, false.
| Improve this Doc View Source

FromJson(JsonValue, JsonSerializer)

Builds an object from a JsonValue.

Declaration
public void FromJson(JsonValue json, JsonSerializer serializer)
Parameters
Type Name Description
JsonValue json

The JsonValue representation of the object.
JsonSerializer serializer

The JsonSerializer instance to use for additional serialization of values.
| Improve this Doc View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

A hash code for the current object.
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

RegisterSubschemas(SchemaValidationContext)

Used register any subschemas during validation. Enables look-forward compatibility with $ref keywords.

Declaration
public void RegisterSubschemas(SchemaValidationContext context)
Parameters
Type Name Description
SchemaValidationContext context

The context for the validation.
| Improve this Doc View Source

ResolveSubschema(JsonPointer, Uri, JsonSchemaVersion)

Resolves any subschemas during resolution of a $ref during validation.

Declaration
public JsonSchema? ResolveSubschema(JsonPointer pointer, Uri baseUri, JsonSchemaVersion supportedVersions)
Parameters
Type Name Description
JsonPointer pointer

A JsonPointer to the target schema.
System.Uri baseUri

The current base URI.
JsonSchemaVersion supportedVersions

Indicates the root schema's supported versions.
Returns
Type Description
System.Nullable<JsonSchema>

The referenced schema, if it exists; otherwise null.
| Improve this Doc View Source

ToJson(JsonSerializer)

Converts an object to a JsonValue.

Declaration
public JsonValue ToJson(JsonSerializer serializer)
Parameters
Type Name Description
JsonSerializer serializer

The JsonSerializer instance to use for additional serialization of values.
Returns
Type Description
JsonValue

The JsonValue representation of the object.
| Improve this Doc View Source

Validate(JsonValue, Nullable<JsonSchemaOptions>)

Validates a JSON instance.

Declaration
public SchemaValidationResults Validate(JsonValue json, JsonSchemaOptions? options = default(JsonSchemaOptions? ))
Parameters
Type Name Description
JsonValue json

The instance to validate.
System.Nullable<JsonSchemaOptions> options

Options for the validation.
Returns
Type Description
SchemaValidationResults

Results object containing a final result and any errors that may have been found.
| Improve this Doc View Source

Validate(SchemaValidationContext)

DO NOT USE FOR BASIC JSON INSTANCE VALIDATION. Used for subschema validation from within a custom keyword.

Declaration
public SchemaValidationResults Validate(SchemaValidationContext context)
Parameters
Type Name Description
SchemaValidationContext context

The context for the validation.
Returns
Type Description
SchemaValidationResults

The schema validation results.
| Improve this Doc View Source

ValidateSchema(Nullable<JsonSchemaOptions>)

Validates that the schema object represents a valid schema in accordance with a known meta-schema.

Declaration
public MetaSchemaValidationResults ValidateSchema(JsonSchemaOptions? options = default(JsonSchemaOptions? ))
Parameters
Type Name Description
System.Nullable<JsonSchemaOptions> options
Returns
Type Description
MetaSchemaValidationResults

Validation results.

Operators

| Improve this Doc View Source

Equality(Nullable<JsonSchema>, Nullable<JsonSchema>)

Overloads the equals operator for JsonSchema.

Declaration
public static bool operator ==(JsonSchema? left, JsonSchema? right)
Parameters
Type Name Description
System.Nullable<JsonSchema> left
System.Nullable<JsonSchema> right
Returns
Type Description
System.Boolean

true if the two values represent the same schema; false otherwise
| Improve this Doc View Source

Implicit(Boolean to JsonSchema)

Implicitly converts a boolean into a boolean schema.

Declaration
public static implicit operator JsonSchema(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
JsonSchema
| Improve this Doc View Source

Inequality(Nullable<JsonSchema>, Nullable<JsonSchema>)

Overloads the not-equal operator for JsonSchema.

Declaration
public static bool operator !=(JsonSchema? left, JsonSchema? right)
Parameters
Type Name Description
System.Nullable<JsonSchema> left
System.Nullable<JsonSchema> right
Returns
Type Description
System.Boolean

false if the two values represent the same schema; true otherwise

Implements

System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IReadOnlyList<T>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.IEquatable<T>

Extension Methods