NJsonSchema 10.2.1

API Differences between 10.2.1 and 10.0.5

81 Additions 50 Removals

NJsonSchema

public static class JsonPathUtilities
- public const string ReferenceReplaceString = "__referencePath"
public class JsonReferenceResolver
- public virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath)
- public virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver)
- public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath)
- public Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath)
- public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver)
- public Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver)
public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public string DeprecatedMessage { get; set; }
- public Collection<string> EnumerationNamesRaw { get; set; }
- 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 JsonSchema FromType<TType>()
- public static JsonSchema FromType(Type type)
- public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
- public ICollection<ValidationError> Validate(string jsonData)
- public ICollection<ValidationError> Validate(JToken token)
- public JToken ToSampleJson()
- public ICollection<ValidationError> Validate(string jsonData, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
public static class JsonSchemaReferenceUtilities
- public static string ConvertJsonReferences(string data)
- public static string ConvertPropertyReferences(string data)

NJsonSchema.Annotations

public interface IJsonSchemaExtensionDataAttribute
- string Key { get; }
- object Value { get; }
public class JsonSchemaPatternPropertiesAttribute : Attribute
- public string RegularExpression { get; }
- public Type Type { get; }
- public JsonSchemaPatternPropertiesAttribute(string regularExpression)
- public JsonSchemaPatternPropertiesAttribute(string regularExpression, Type type)

NJsonSchema.Converters

public class JsonExceptionConverter : JsonConverter
- public JsonExceptionConverter()
- public JsonExceptionConverter(bool hideStackTrace, IDictionary<string, Assembly> searchedNamespaces)

NJsonSchema.Generation

public interface ISchemaProcessor
- Task ProcessAsync(SchemaProcessorContext context)
- void Process(SchemaProcessorContext context)
public class JsonSchemaGenerator
- public virtual void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
- public virtual void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription)
- 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 Task GenerateAsync<TSchemaType>(Type type, TSchemaType schema, 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 virtual string GetPropertyName(JsonProperty jsonProperty, MemberInfo memberInfo)
- public JsonSchema Generate(Type type)
- public JsonSchema Generate(Type type, JsonSchemaResolver schemaResolver)
- public TSchemaType Generate<TSchemaType>(Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- public JsonSchema Generate(ContextualType contextualType, JsonSchemaResolver schemaResolver)
- public TSchemaType Generate<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- public void Generate<TSchemaType>(TSchemaType schema, Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- public virtual void Generate<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual void GenerateArray<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual void GenerateDictionary<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual void GenerateEnum(JsonSchema schema, JsonTypeDescription typeDescription)
- public virtual object GenerateExample(ContextualType type)
- protected virtual void GenerateObject(JsonSchema schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver)
- public TSchemaType GenerateWithReference<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
- public TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
- public virtual TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, bool isNullable, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
- public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
- protected virtual bool IsPropertyIgnored(ContextualMemberInfo property, Type parentType)
public class JsonSchemaGeneratorSettings
- public bool AlwaysAllowAdditionalObjectProperties { get; set; }
- public ReferenceTypeNullHandling DefaultDictionaryValueReferenceTypeNullHandling { get; set; }
- public bool GenerateExamples { get; set; }
- public object SerializerOptions { get; set; }
public class JsonTypeDescription
- public ContextualType ContextualType { get; }
- public static JsonTypeDescription Create(Type type, JsonObjectType jsonType, bool isNullable, string format)
- public static JsonTypeDescription CreateForDictionary(Type type, JsonObjectType jsonType, bool isNullable)
- public static JsonTypeDescription CreateForEnumeration(Type type, JsonObjectType jsonType, bool isNullable)
- public static JsonTypeDescription Create(ContextualType type, JsonObjectType jsonType, bool isNullable, string format)
- public static JsonTypeDescription CreateForDictionary(ContextualType type, JsonObjectType jsonType, bool isNullable)
- public static JsonTypeDescription CreateForEnumeration(ContextualType type, JsonObjectType jsonType, bool isNullable)
public enum ReferenceTypeNullHandling
- Default = 0
public class SampleJsonDataGenerator
- public SampleJsonDataGenerator()
- public JToken Generate(JsonSchema schema)
public static class SystemTextJsonUtilities
- public static JsonSerializerSettings ConvertJsonOptionsToNewtonsoftSettings(object serializerOptions)

NJsonSchema.Generation.SchemaProcessors

public class DiscriminatorSchemaProcessor : ISchemaProcessor
- public Task ProcessAsync(SchemaProcessorContext context)
- public void Process(SchemaProcessorContext context)

NJsonSchema.Generation.TypeMappers

public interface ITypeMapper
- Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
- void GenerateSchema(JsonSchema schema, TypeMapperContext context)
public class ObjectTypeMapper : ITypeMapper
- public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema>> schemaFactory)
- public Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
- public void GenerateSchema(JsonSchema schema, TypeMapperContext context)
public class PrimitiveTypeMapper : ITypeMapper
- public Task GenerateSchemaAsync(JsonSchema schema, TypeMapperContext context)
- public void GenerateSchema(JsonSchema schema, TypeMapperContext context)

NJsonSchema.Infrastructure

public static class DynamicApis
- public static Task DirectoryCreateDirectoryAsync(string directory)
- public static Task<bool> DirectoryExistsAsync(string filePath)
- public static Task<string> DirectoryGetCurrentDirectoryAsync()
- public static Task<string[]> DirectoryGetFilesAsync(string directory, string filter)
- public static Task<bool> FileExistsAsync(string filePath)
- public static Task<string> FileReadAllTextAsync(string filePath)
- public static Task FileWriteAllTextAsync(string filePath, string text)
- public static void DirectoryCreateDirectory(string directory)
- public static bool DirectoryExists(string filePath)
- public static string DirectoryGetCurrentDirectory()
- public static string[] DirectoryGetFiles(string directory, string filter)
- public static bool FileExists(string filePath)
- public static string FileReadAllText(string filePath)
- public static void FileWriteAllText(string filePath, string text)
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 string GetDescription(this CachedType type, DescriptionAttributeType attributeType = 0)
- public static string GetDescription(this ContextualParameterInfo parameter)

NJsonSchema.Validation

public class JsonSchemaValidator
- public JsonSchemaValidator()
- public JsonSchemaValidator(IFormatValidator[] customValidators)

NJsonSchema.Visitors

public abstract class AsyncJsonReferenceVisitorBase
- protected AsyncJsonReferenceVisitorBase()
- protected AsyncJsonReferenceVisitorBase(IContractResolver contractResolver)
- public virtual Task VisitAsync(object obj)
- protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
- protected abstract Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint)
public abstract class AsyncJsonSchemaVisitorBase : AsyncJsonReferenceVisitorBase
- protected AsyncJsonSchemaVisitorBase()
- protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint)
public abstract class JsonReferenceVisitorBase
- public virtual Task VisitAsync(object obj)
- protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
- protected abstract Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint)
- public virtual void Visit(object obj)
- protected virtual void Visit(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
- protected abstract IJsonReference VisitJsonReference(IJsonReference reference, string path, string typeNameHint)
public abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase
- protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint)
- protected abstract JsonSchema VisitSchema(JsonSchema schema, string path, string typeNameHint)