NJsonSchema 10.0.0

API Differences between 10.0.0 and 9.13.26

212 Additions 71 Removals

NJsonSchema

public class ConversionUtilities
- public static string ConvertCSharpDocBreaks(string input, int tabCount)
- public static string ConvertCSharpDocs(string input, int tabCount)
public class DefaultSchemaNameGenerator : ISchemaNameGenerator
public class DefaultTypeNameGenerator : ITypeNameGenerator
- public virtual string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- protected virtual string Generate(JsonSchema4 schema, string typeNameHint)
- public virtual string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- protected virtual string Generate(JsonSchema schema, string typeNameHint)
public enum EnumHandling
public interface ISchemaNameGenerator
public interface ITypeNameGenerator
- string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
public class JsonProperty : JsonSchema4
public class JsonReferenceResolver
- public JsonReferenceResolver(JsonSchemaResolver schemaResolver)
- public static Func<JsonSchema4, JsonReferenceResolver> CreateJsonReferenceResolverFactory(JsonSchemaGeneratorSettings settings)
- public JsonReferenceResolver(JsonSchemaAppender schemaAppender)
- public static Func<JsonSchema, JsonReferenceResolver> CreateJsonReferenceResolverFactory(ITypeNameGenerator typeNameGenerator)
public class JsonSchema4 : JsonReferenceBase<JsonSchema4>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public static string ToolchainVersion { get; }
- public string ActualDiscriminator { get; }
- public OpenApiDiscriminator ActualDiscriminatorObject { get; }
- public IReadOnlyDictionary<string, JsonSchemaProperty> ActualProperties { get; }
- public virtual JsonSchema ActualSchema { get; }
- public virtual JsonSchema ActualTypeSchema { get; }
- public JsonSchema AdditionalItemsSchema { get; set; }
- public JsonSchema AdditionalPropertiesSchema { get; set; }
- public IReadOnlyCollection<JsonSchema> AllInheritedSchemas { get; }
- public ICollection<JsonSchema> AllOf { get; }
- public bool AllowAdditionalItems { get; set; }
- public bool AllowAdditionalProperties { get; set; }
- public ICollection<JsonSchema> AnyOf { get; }
- public object Default { get; set; }
- public IDictionary<string, JsonSchema> Definitions { get; }
- public virtual string Description { get; set; }
- public JsonSchema DictionaryKey { get; set; }
- public string Discriminator { get; set; }
- public OpenApiDiscriminator DiscriminatorObject { get; set; }
- public ICollection<object> Enumeration { get; }
- public Collection<string> EnumerationNames { get; set; }
- public Collection<string> EnumerationNamesRaw { get; set; }
- public object Example { get; set; }
- public decimal? ExclusiveMaximum { get; set; }
- public decimal? ExclusiveMinimum { get; set; }
- public IDictionary<string, object> ExtensionData { get; set; }
- public string Format { get; set; }
- public bool HasAllOfSchemaReference { get; }
- public bool HasAnyOfSchemaReference { get; }
- public bool HasOneOfSchemaReference { get; }
- public bool HasReference { get; }
- public bool HasTypeNameTitle { get; }
- public string Id { get; set; }
- public JsonSchema InheritedSchema { get; }
- public JsonSchema InheritedTypeSchema { get; }
- public bool IsAbstract { get; set; }
- public bool IsAnyType { get; }
- public bool IsArray { get; }
- public bool IsBinary { get; }
- public bool IsDeprecated { get; set; }
- public bool IsDictionary { get; }
- public bool IsEnumeration { get; }
- public bool IsExclusiveMaximum { get; set; }
- public bool IsExclusiveMinimum { get; set; }
- public bool IsFlagEnumerable { get; set; }
- public bool? IsNullableRaw { get; set; }
- public bool IsObject { get; }
- public bool IsTuple { get; }
- public JsonSchema Item { get; set; }
- public ICollection<JsonSchema> Items { get; }
- public decimal? Maximum { get; set; }
- public int MaxItems { get; set; }
- public int? MaxLength { get; set; }
- public int MaxProperties { get; set; }
- public decimal? Minimum { get; set; }
- public int MinItems { get; set; }
- public int? MinLength { get; set; }
- public int MinProperties { get; set; }
- public decimal? MultipleOf { get; set; }
- public JsonSchema Not { get; set; }
- public ICollection<JsonSchema> OneOf { get; }
- public virtual object Parent { get; set; }
- public JsonSchema ParentSchema { get; }
- public string Pattern { get; set; }
- public IDictionary<string, JsonSchemaProperty> PatternProperties { get; }
- public IDictionary<string, JsonSchemaProperty> Properties { get; }
- public ICollection<string> RequiredProperties { get; }
- public OpenApiDiscriminator ResponsibleDiscriminatorObject { get; }
- public string SchemaVersion { get; set; }
- public string Title { get; set; }
- public JsonObjectType Type { get; set; }
- public bool UniqueItems { get; set; }
- public JsonXmlObject Xml { get; set; }
- public JsonSchema()
- public static JsonSchema CreateAnySchema()
- public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema
- public static PropertyRenameAndIgnoreSerializerContractResolver CreateJsonSerializerContractResolver(SchemaType schemaType)
- public static Task<JsonSchema> FromFileAsync(string filePath)
- public static Task<JsonSchema> FromFileAsync(string filePath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory)
- public static Task<JsonSchema> FromJsonAsync(string data)
- public static Task<JsonSchema> FromJsonAsync(string data, string documentPath)
- public static Task<JsonSchema> FromJsonAsync(string data, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory)
- public static JsonSchema FromSampleJson(string data)
- public static Task<JsonSchema> FromTypeAsync<TType>()
- public static Task<JsonSchema> FromTypeAsync(Type type)
- public static Task<JsonSchema> FromTypeAsync<TType>(JsonSchemaGeneratorSettings settings)
- public static Task<JsonSchema> FromTypeAsync(Type type, JsonSchemaGeneratorSettings settings)
- public static Task<JsonSchema> FromUrlAsync(string url)
- public static Task<JsonSchema> FromUrlAsync(string url, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory)
- public bool Inherits(JsonSchema schema)
- public bool InheritsSchema(JsonSchema parentSchema)
- public virtual bool IsNullable(SchemaType schemaType)
- public string ToJson()
- public string ToJson(Formatting formatting)
- public ICollection<ValidationError> Validate(string jsonData)
- public ICollection<ValidationError> Validate(JToken token)
public class JsonSchemaAppender
- public object RootObject { get; }
- protected JsonSchema RootSchema { get; }
- public JsonSchemaAppender(object rootObject, ITypeNameGenerator typeNameGenerator)
- public virtual void AppendSchema(JsonSchema schema, string typeNameHint)
public class JsonSchemaProperty : JsonSchema
- public bool IsInheritanceDiscriminator { get; }
- public bool IsReadOnly { get; set; }
- public bool IsRequired { get; set; }
- public bool IsWriteOnly { get; set; }
- public string Name { get; }
- public JsonSchemaProperty()
public class JsonSchemaResolver
public class JsonXmlObject
- public JsonSchema4 ParentSchema { get; }
- public JsonSchema ParentSchema { get; }
public class OpenApiDiscriminator
- public IDictionary<string, JsonSchema4> Mapping { get; }
- public IDictionary<string, JsonSchema> Mapping { get; }
- public void AddMapping(Type type, JsonSchema4 schema)
- public void AddMapping(Type type, JsonSchema schema)
public enum PropertyNameHandling
public enum ReferenceTypeNullHandling

NJsonSchema.Annotations

public class JsonSchemaAbstractAttribute : Attribute
- public bool IsAbstract { get; }
- public JsonSchemaAbstractAttribute()
- public JsonSchemaAbstractAttribute(bool isAbstract)
public class JsonSchemaFlattenAttribute : Attribute
- public bool Flatten { get; }
- public JsonSchemaFlattenAttribute(bool flatten)
public class JsonSchemaTypeAttribute : Attribute
- public bool? IsNullableRaw { get; }

NJsonSchema.Converters

public class JsonInheritanceConverter : JsonConverter
- public static string DefaultDiscriminatorName { get; }

NJsonSchema.Generation

public class DefaultReflectionService : IReflectionService
- public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
- protected virtual bool IsArrayType(Type type, IEnumerable<Attribute> parentAttributes)
- protected virtual bool IsBinary(Type type, IEnumerable<Attribute> parentAttributes)
- protected virtual bool IsDictionaryType(Type type, IEnumerable<Attribute> parentAttributes)
- public virtual bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
- public JsonTypeDescription GetDescription(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
- public virtual JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings)
- protected virtual bool IsArrayType(ContextualType contextualType)
- protected virtual bool IsBinary(ContextualType contextualType)
- protected virtual bool IsDictionaryType(ContextualType contextualType)
- public virtual bool IsNullable(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
public class DefaultSchemaNameGenerator : ISchemaNameGenerator
- public DefaultSchemaNameGenerator()
- public virtual string Generate(Type type)
public enum EnumHandling
- CamelCaseString = 2
- Integer = 0
- String = 1
public interface IReflectionService
- JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
- bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
- JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings)
- JsonTypeDescription GetDescription(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
- bool IsNullable(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
public interface ISchemaNameGenerator
- string Generate(Type type)
public class JsonSchemaGenerator
- public virtual void ApplyDataAnnotations(JsonSchema4 schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
- public Task<JsonSchema4> GenerateAsync(Type type)
- public Task<JsonSchema4> GenerateAsync(Type type, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateAsync<TSchemaType>(Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
- public Task<JsonSchema4> GenerateAsync(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
- public virtual Task GenerateAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
- protected virtual Task GenerateObjectAsync(Type type, JsonTypeDescription typeDescription, JsonSchema4 schema, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
- public virtual Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, bool isNullable, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
- public Task<TSchemaType> GenerateWithReferenceAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
- public virtual void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
- public Task<JsonSchema> GenerateAsync(Type type)
- public Task<JsonSchema> GenerateAsync(Type type, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateAsync<TSchemaType>(Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- public Task<JsonSchema> GenerateAsync(ContextualType contextualType, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateAsync<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- public virtual Task GenerateAsync<TSchemaType>(ContextualType contextualType, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual Task GenerateObjectAsync(Type type, JsonTypeDescription typeDescription, JsonSchema schema, JsonSchemaResolver schemaResolver)
- public Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema, Task> transformation = null) where TSchemaType : JsonSchema
- public virtual Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(ContextualType contextualType, bool isNullable, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema, Task> transformation = null) where TSchemaType : JsonSchema
- public Task<TSchemaType> GenerateWithReferenceAsync<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema, Task> transformation = null) where TSchemaType : JsonSchema
public class JsonSchemaGeneratorSettings
- public EnumHandling DefaultEnumHandling { get; set; }
- public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
- public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
- public EnumHandling DefaultEnumHandling { get; set; }
- public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
- public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
- public bool GenerateAbstractSchemas { get; set; }
- public bool GenerateCustomNullableProperties { get; set; }
- public bool GenerateEnumMappingDescription { get; set; }
- public ISchemaNameGenerator SchemaNameGenerator { get; set; }
- public ISchemaNameGenerator SchemaNameGenerator { get; set; }
- public bool GetActualGenerateAbstractSchema(Type type)
public class JsonSchemaResolver : JsonSchemaAppender
- public IEnumerable<JsonSchema> Schemas { get; }
- public JsonSchemaResolver(object rootObject, JsonSchemaGeneratorSettings settings)
- public virtual void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema schema)
- public JsonSchema GetSchema(Type type, bool isIntegerEnumeration)
- public bool HasSchema(Type type, bool isIntegerEnumeration)
public class JsonTypeDescription
- public void ApplyType(JsonSchema4 schema)
- public void ApplyType(JsonSchema schema)
public enum PropertyNameHandling
- CamelCase = 1
- Default = 0
- SnakeCase = 2
public enum ReferenceTypeNullHandling
- Default = 0
- NotNull = 2
- Null = 1
public class SampleJsonSchemaGenerator
- public JsonSchema4 Generate(string json)
- public JsonSchema Generate(string json)
public class SchemaProcessorContext
- public JsonSchemaResolver Resolver { get; }
- public JsonSchema4 Schema { get; }
- public JsonSchemaResolver Resolver { get; }
- public JsonSchema Schema { get; }
- public SchemaProcessorContext(Type type, JsonSchema4 schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
- public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)

NJsonSchema.Generation.TypeMappers

public interface ITypeMapper
- Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
- Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
public class ObjectTypeMapper : ITypeMapper
- public ObjectTypeMapper(Type mappedType, JsonSchema4 schema)
- public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, JsonSchema4> schemaFactory)
- public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema4>> schemaFactory)
- public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
- public ObjectTypeMapper(Type mappedType, JsonSchema schema)
- public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, JsonSchema> schemaFactory)
- public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema>> schemaFactory)
- public Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
public class PrimitiveTypeMapper : ITypeMapper
- public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema4> transformer)
- public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
- public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema> transformer)
- public Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
public class TypeMapperContext
- public JsonSchemaResolver JsonSchemaResolver { get; }
- public JsonSchemaResolver JsonSchemaResolver { get; }
- public TypeMapperContext(Type type, JsonSchemaGenerator jsonSchemaGenerator, JsonSchemaResolver jsonSchemaResolver, IEnumerable<Attribute> parentAttributes)
- public TypeMapperContext(Type type, JsonSchemaGenerator jsonSchemaGenerator, JsonSchemaResolver jsonSchemaResolver, IEnumerable<Attribute> parentAttributes)

NJsonSchema.Infrastructure

public enum DescriptionAttributeType
- Context = 0
- Type = 1
public class JsonSchemaSerialization
- public static JsonSerializerSettings CurrentSerializerSettings { get; }
- public static T FromJson<T>(string json, IContractResolver contractResolver)
- public static string ToJson(object obj, SchemaType schemaType, IContractResolver contractResolver)
public static class ReflectionCache
public static class ReflectionExtensions
public enum TypeNameStyle
public static class XmlDocumentationExtensions
public static class TypeExtensions
- public static Task<string> GetDescriptionAsync(this CachedType type, DescriptionAttributeType attributeType = 0)
- public static Task<string> GetDescriptionAsync(this ContextualParameterInfo parameter)
public static class XmlObjectExtension
- public static void GenerateXmlObjectForArrayType(this JsonSchema4 schema, Type type)
- public static void GenerateXmlObjectForItemType(this JsonSchema4 schema, Type type)
- public static void GenerateXmlObjectForProperty(this JsonProperty propertySchema, Type type, string propertyName, IEnumerable<Attribute> attributes)
- public static void GenerateXmlObjectForType(this JsonSchema4 schema, Type type)
- public static void GenerateXmlObjectForArrayType(this JsonSchema schema)
- public static void GenerateXmlObjectForItemType(this JsonSchema schema, CachedType type)
- public static void GenerateXmlObjectForProperty(this JsonSchemaProperty propertySchema, ContextualType type, string propertyName)
- public static void GenerateXmlObjectForType(this JsonSchema schema, Type type)

NJsonSchema.Validation

public class ChildSchemaValidationError : ValidationError
- public IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> errors, JToken token, JsonSchema4 schema)
- public IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
public class JsonSchemaValidator
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema4 schema)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema4 schema)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema4 schema, string propertyName, string propertyPath)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema schema)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema schema)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema schema, string propertyName, string propertyPath)
public class MultiTypeValidationError : ValidationError
- public MultiTypeValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonObjectType, ICollection<ValidationError>> errors, JToken token, JsonSchema4 schema)
- public MultiTypeValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonObjectType, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
public class ValidationError
- public JsonSchema4 Schema { get; }
- public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema4 schema)
- public JsonSchema Schema { get; }
- public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema schema)

NJsonSchema.Visitors

public abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase
- protected abstract Task<JsonSchema4> VisitSchemaAsync(JsonSchema4 schema, string path, string typeNameHint)
- protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint)