NJsonSchema 10.2.2

API Differences between 10.2.2 and 11.0.0-preview002

79 Additions 75 Removals

NJsonSchema

public class ConversionUtilities
- public static void Tab(string input, int tabCount, TextWriter writer)
public static class JsonFormatStrings
- public const string Duration = "duration"
public class JsonReferenceResolver
- public virtual string ResolveFilePath(string documentPath, string jsonPath)
- public virtual Task<IJsonReference> ResolveFileReferenceAsync(string filePath, CancellationToken cancellationToken = default)
- public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver, CancellationToken cancellationToken = default)
- public Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver, CancellationToken cancellationToken = default)
- public virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url, CancellationToken cancellationToken = default)
- public virtual Task<IJsonReference> ResolveFileReferenceAsync(string filePath)
- 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 virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url)
public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public bool HasActualProperties { get; }
- public static Task<JsonSchema> FromFileAsync(string filePath, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromFileAsync(string filePath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(string data, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(Stream stream, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(string data, string documentPath, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(string data, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(Stream stream, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- 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 Task<JsonSchema> FromUrlAsync(string url, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromUrlAsync(string url, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromUrlAsync(string url)
- public static Task<JsonSchema> FromUrlAsync(string url, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(string jsonData, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(string jsonData, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
public static class JsonSchemaReferenceUtilities
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, CancellationToken cancellationToken = default)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver, CancellationToken cancellationToken = default)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver)
public class SampleJsonDataGenerator
public class SampleJsonDataGeneratorSettings
public class SampleJsonSchemaGenerator

NJsonSchema.Converters

public class JsonInheritanceAttribute : Attribute
public class JsonInheritanceConverter<TBase> : JsonConverter<TBase>
public class JsonInheritanceConverterAttribute : JsonConverterAttribute
public class JsonExceptionConverter : JsonConverter
- public JsonExceptionConverter()
- public JsonExceptionConverter(bool hideStackTrace, IDictionary<string, Assembly> searchedNamespaces)
public class JsonInheritanceConverter : JsonConverter
- public static string DefaultDiscriminatorName { get; }
- public virtual string DiscriminatorName { get; }
- public JsonInheritanceConverter()
- public JsonInheritanceConverter(string discriminator)
- public JsonInheritanceConverter(string discriminator, bool readTypeProperty)
- public JsonInheritanceConverter(Type baseType)
- public JsonInheritanceConverter(Type baseType, string discriminator)
- protected virtual Type GetDiscriminatorType(JObject jObject, Type objectType, string discriminatorValue)
- public virtual string GetDiscriminatorValue(Type type)
public class JsonReferenceConverter : JsonConverter
- public JsonReferenceConverter()

NJsonSchema.Generation

public class DefaultReflectionService : IReflectionService
- public DefaultReflectionService()
- 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 virtual bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
public enum EnumHandling
- CamelCaseString = 2
- Integer = 0
- String = 1
public interface IReflectionService
- string ConvertEnumValue(object value, JsonSchemaGeneratorSettings settings)
- void GenerateProperties(JsonSchema schema, ContextualType contextualType, JsonSchemaGeneratorSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
- string GetPropertyName(ContextualAccessorInfo accessorInfo, JsonSchemaGeneratorSettings settings)
- bool IsStringEnum(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
- bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
public interface IXmlDocsSettings
public class JsonSchemaGenerator
- public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
- public void AddProperty(JsonSchema parentSchema, ContextualAccessorInfo property, JsonTypeDescription propertyTypeDescription, string propertyName, Attribute requiredAttribute, bool hasRequiredAttribute, bool isNullable, object defaultValue, JsonSchemaResolver schemaResolver)
- public virtual object GenerateExample(ContextualAccessorInfo accessorInfo)
- public object GetDataMemberAttribute(ContextualAccessorInfo accessorInfo, Type parentType)
- public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
- public bool IsAbstractProperty(ContextualMemberInfo memberInfo)
- public virtual bool IsPropertyIgnored(ContextualAccessorInfo accessorInfo, Type parentType)
- public bool IsPropertyIgnoredBySettings(ContextualAccessorInfo accessorInfo)
- protected virtual bool IsPropertyIgnored(ContextualMemberInfo property, Type parentType)
public class JsonSchemaGeneratorSettings
- public IContractResolver ActualContractResolver { get; }
- public JsonSerializerSettings ActualSerializerSettings { get; }
- public IContractResolver ContractResolver { get; set; }
- public EnumHandling DefaultEnumHandling { get; set; }
- public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
- public bool ResolveExternalXmlDocumentation { get; set; }
- public object SerializerOptions { get; set; }
- public JsonSerializerSettings SerializerSettings { get; set; }
- public bool UseXmlDocumentation { get; set; }
- public XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
- public JsonContract ResolveContract(Type type)
public class JsonSchemaResolver : JsonSchemaAppender
- protected virtual string GetTypeKey(Type type, bool isIntegerEnum)
public enum PropertyNameHandling
- CamelCase = 1
- Default = 0
- SnakeCase = 2
public abstract class ReflectionServiceBase<TSettings> : IReflectionService where TSettings : JsonSchemaGeneratorSettings
public class SampleJsonDataGenerator
- public SampleJsonDataGenerator()
- public JToken Generate(JsonSchema schema)
public class SampleJsonSchemaGenerator
- public SampleJsonSchemaGenerator()
- public JsonSchema Generate(string json)
public class SchemaProcessorContext
- public ContextualType ContextualType { get; }
- public SchemaProcessorContext(ContextualType contextualType, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
- public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
public class SystemTextJsonReflectionService : ReflectionServiceBase<SystemTextJsonSchemaGeneratorSettings>
public class SystemTextJsonSchemaGeneratorSettings : JsonSchemaGeneratorSettings
public static class SystemTextJsonUtilities
- public static JsonSerializerSettings ConvertJsonOptionsToNewtonsoftSettings(object serializerOptions)
public static class XmlDocsSettingsExtensions

NJsonSchema.Infrastructure

public enum DescriptionAttributeType
- Context = 0
- Type = 1
public static class DynamicApis
- public static string[] DirectoryGetDirectories(string directory)
- public static string DirectoryGetParent(string path)
- public static string HandleSubdirectoryRelativeReferences(string fullPath, string jsonPath)
- public static Task<string> HttpGetAsync(string url, CancellationToken cancellationToken)
- public static Task<string> HttpGetAsync(string url)
- public static string PathGetFileName(string filePath)
public class JsonSchemaSerialization
- public static T FromJson<T>(Stream stream, IContractResolver contractResolver)
- public static Task<T> FromJsonAsync<T>(string json, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver, CancellationToken cancellationToken = default)
- public static Task<T> FromJsonAsync<T>(Stream stream, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver, CancellationToken cancellationToken = default)
public static class TypeExtensions
- public static string GetDescription(this CachedType type, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualAccessorInfo accessorInfo, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualParameterInfo parameter, IXmlDocsSettings xmlDocsSettings)
- public static string GetName(this ContextualAccessorInfo accessorInfo)
- public static string GetDescription(this CachedType type, DescriptionAttributeType attributeType = 0)
- public static string GetDescription(this ContextualParameterInfo parameter)

NJsonSchema.Validation

public class JsonSchemaValidator
- public JsonSchemaValidator(JsonSchemaValidatorSettings settings)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema schema, SchemaType schemaType = 0)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema schema, SchemaType schemaType = 0)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema schema, SchemaType schemaType, 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 JsonSchemaValidatorSettings
public enum ValidationErrorKind
- UuidExpected = 44

NJsonSchema.Validation.FormatValidators

public class UuidFormatValidator : IFormatValidator

NJsonSchema.Visitors

public abstract class AsyncJsonReferenceVisitorBase
- public virtual Task VisitAsync(object obj, CancellationToken cancellationToken)
- protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer, CancellationToken cancellationToken)
- protected abstract Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint, CancellationToken cancellationToken)
- 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 abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint, CancellationToken cancellationToken)
- protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint)