<PackageReference Include="NJsonSchema" Version="11.0.0-preview007" />

---

API Differences between 11.0.0-preview007 and 10.0.11

145 Additions 89 Removals

NJsonSchema

• public class ConversionUtilities
  • public static void Tab(string input, int tabCount, TextWriter writer)
• public static class JsonFormatStrings
• public enum JsonObjectType
• public static class JsonPathUtilities
  • public const string ReferenceReplaceString = "__referencePath"
• public class JsonReferenceResolver
  • public virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath)
  • public virtual Task<IJsonReference> ResolveFileReferenceAsync(string filePath)
  • public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath)
  • public Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath)
  • public virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url)
  • public virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver)
  • 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 class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
  • public string DeprecatedMessage { get; set; }
  • public Collection<string> EnumerationNamesRaw { get; set; }
  • public bool HasActualProperties { get; }
  • 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> 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> FromUrlAsync(string url)
  • public static Task<JsonSchema> FromUrlAsync(string url, 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 ICollection<ValidationError> Validate(string jsonData)
  • public ICollection<ValidationError> Validate(JToken token)
  • public JToken ToSampleJson()
  • 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 static class JsonSchemaReferenceUtilities
  • public static string ConvertJsonReferences(string data)
  • public static string ConvertPropertyReferences(string data)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver)
  • 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 class SampleJsonDataGeneratorSettings
  • public bool GenerateOptionalProperties { get; set; }
  • public int MaxRecursionLevel { get; set; }
  • public SampleJsonDataGeneratorSettings()
• public class SampleJsonSchemaGenerator
  • public SampleJsonSchemaGenerator()
  • public JsonSchema Generate(string json)
  • public JsonSchema Generate(Stream stream)

NJsonSchema.Annotations

• public class CanBeNullAttribute : Attribute
• public class ItemsCanBeNullAttribute : Attribute
• public class JsonSchemaAbstractAttribute : Attribute
• public class JsonSchemaAttribute : Attribute
• public class JsonSchemaDateAttribute : JsonSchemaAttribute
• public class JsonSchemaExtensionDataAttribute : Attribute
• public class JsonSchemaFlattenAttribute : Attribute
• public class JsonSchemaIgnoreAttribute : Attribute
• public class JsonSchemaProcessorAttribute : Attribute
• public class JsonSchemaTypeAttribute : Attribute
• public class MultipleOfAttribute : Attribute
• public class NotNullAttribute : Attribute

NJsonSchema.Converters

• public class JsonExceptionConverter : JsonConverter
• public class JsonInheritanceConverter : JsonConverter
• public class JsonReferenceConverter : JsonConverter
• public class JsonInheritanceAttribute : Attribute
  • public string Key { get; }
  • public Type Type { get; }
  • public JsonInheritanceAttribute(string key, Type type)
• public class JsonInheritanceConverter<TBase> : JsonConverter<TBase>
  • public static IDictionary<string, Type> AdditionalKnownTypes { get; }
  • public virtual string DiscriminatorName { get; }
  • public JsonInheritanceConverter()
  • public JsonInheritanceConverter(string discriminatorName)
  • protected virtual Type GetDiscriminatorType(JsonElement jObject, Type objectType, string discriminatorValue)
  • public virtual string GetDiscriminatorValue(Type type)
• public class JsonInheritanceConverterAttribute : JsonConverterAttribute
  • public static string DefaultDiscriminatorName { get; }
  • public string DiscriminatorName { get; }
  • public JsonInheritanceConverterAttribute(Type baseType, string discriminatorName = "discriminator")

NJsonSchema.Generation

• public class DefaultReflectionService : IReflectionService
• public enum EnumHandling
• public interface IReflectionService
  • void GenerateProperties(JsonSchema schema, ContextualType contextualType, JsonSchemaGeneratorSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
  • Func<object, string> GetEnumValueConverter(JsonSchemaGeneratorSettings settings)
  • string GetPropertyName(ContextualAccessorInfo accessorInfo, JsonSchemaGeneratorSettings settings)
  • bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
  • bool IsStringEnum(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
• public interface IXmlDocsSettings
  • bool ResolveExternalXmlDocumentation { get; }
  • bool UseXmlDocumentation { get; }
  • XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
• public class JsonSchemaGenerator
  • public virtual void ApplyDataAnnotations(JsonSchema schema, ContextualType contextualType, JsonTypeDescription typeDescription)
  • 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 void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription)
  • protected virtual void GenerateArray<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateDictionary<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateEnum(JsonSchema schema, CachedType type, JsonTypeDescription typeDescription)
  • protected virtual void GenerateObject(JsonSchema schema, Type type, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver)
  • 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)
  • public virtual object GenerateExample(ContextualAccessorInfo accessorInfo)
  • protected virtual void GenerateObject(JsonSchema schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver)
  • public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
  • public object GetDataMemberAttribute(ContextualAccessorInfo accessorInfo, Type parentType)
  • public bool IsAbstractProperty(ContextualMemberInfo memberInfo)
  • public virtual bool IsPropertyIgnored(ContextualAccessorInfo accessorInfo, Type parentType)
  • public bool IsPropertyIgnoredBySettings(ContextualAccessorInfo accessorInfo)
• public abstract class JsonSchemaGeneratorSettings : IXmlDocsSettings
  • 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 AlwaysAllowAdditionalObjectProperties { get; set; }
  • public ReferenceTypeNullHandling DefaultDictionaryValueReferenceTypeNullHandling { get; set; }
  • public bool GenerateExamples { get; set; }
  • public bool ResolveExternalXmlDocumentation { get; set; }
  • public JsonSerializerSettings SerializerSettings { get; set; }
  • public JsonSchemaGeneratorSettings()
  • public bool UseXmlDocumentation { get; set; }
  • public XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
  • public JsonSchemaGeneratorSettings(IReflectionService reflectionService)
  • public JsonContract ResolveContract(Type type)
• public class JsonSchemaResolver : JsonSchemaAppender
  • protected virtual string GetTypeKey(Type type, bool isIntegerEnum)
• 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 PropertyNameHandling
• public enum ReferenceTypeNullHandling
  • Default = 0
• public class SampleJsonSchemaGenerator
• public abstract class ReflectionServiceBase<TSettings> : IReflectionService where TSettings : JsonSchemaGeneratorSettings
  • protected ReflectionServiceBase()
  • public abstract void GenerateProperties(JsonSchema schema, ContextualType contextualType, TSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
  • public JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, TSettings settings)
  • protected virtual JsonTypeDescription GetDescription(ContextualType contextualType, TSettings settings, Type originalType, bool isNullable, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
  • public abstract Func<object, string> GetEnumValueConverter(TSettings settings)
  • public abstract string GetPropertyName(ContextualAccessorInfo accessorInfo, 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, TSettings settings)
• public class SampleJsonDataGenerator
  • public SampleJsonDataGenerator()
  • public SampleJsonDataGenerator(SampleJsonDataGeneratorSettings settings)
  • public JToken Generate(JsonSchema schema)
• public class SchemaProcessorContext
  • public ContextualType ContextualType { get; }
  • public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
  • public SchemaProcessorContext(ContextualType contextualType, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
• public class SystemTextJsonReflectionService : ReflectionServiceBase<SystemTextJsonSchemaGeneratorSettings>
  • public SystemTextJsonReflectionService()
• public class SystemTextJsonSchemaGeneratorSettings : JsonSchemaGeneratorSettings
  • public JsonSerializerOptions SerializerOptions { get; set; }
  • public SystemTextJsonSchemaGeneratorSettings()
• public static class XmlDocsSettingsExtensions
  • public static XmlDocsOptions GetXmlDocsOptions(this IXmlDocsSettings settings)

NJsonSchema.Infrastructure

• public class CollectionProxy<TInterface, TImplementation> : ICollection<TInterface>, IEnumerable<TInterface>, IEnumerable where TImplementation : TInterface
• public enum DescriptionAttributeType
• public static class DynamicApis
  • public static bool SupportsDirectoryApis { get; }
  • public static bool SupportsFileApis { get; }
  • public static bool SupportsPathApis { get; }
  • public static bool SupportsXPathApis { get; }
  • 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 string GetFullPath(string path)
  • public static Task<string> HttpGetAsync(string url)
  • public static string PathCombine(string path1, string path2)
  • public static string PathGetDirectoryName(string filePath)
  • public static object XPathEvaluate(XDocument document, string path)
  • public static string HandleSubdirectoryRelativeReferences(string fullPath, string jsonPath)
  • public static Task<string> HttpGetAsync(string url, CancellationToken cancellationToken)
• 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, DescriptionAttributeType attributeType = 0)
  • public static string GetDescription(this ContextualParameterInfo parameter)
  • 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)

NJsonSchema.Validation

• public class JsonSchemaValidator
  • public JsonSchemaValidator()
  • 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 JsonSchemaValidator(IFormatValidator[] customValidators)
  • 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 class JsonSchemaValidatorSettings
  • public IEnumerable<IFormatValidator> FormatValidators { get; set; }
  • public StringComparer PropertyStringComparer { get; set; }
  • public JsonSchemaValidatorSettings()
  • public void AddCustomFormatValidator(IFormatValidator formatValidator)
• public enum ValidationErrorKind
  • UuidExpected = 44

NJsonSchema.Validation.FormatValidators

• public class UuidFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public UuidFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)

NJsonSchema.Visitors

• public abstract class AsyncJsonReferenceVisitorBase
  • 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 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)
• public abstract class AsyncJsonSchemaVisitorBase : AsyncJsonReferenceVisitorBase
  • protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint)
  • protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint, CancellationToken cancellationToken)

System.Runtime.CompilerServices

• public sealed class CompilerFeatureRequiredAttribute : Attribute
  • public const string RefStructs = "RefStructs"
  • public const string RequiredMembers = "RequiredMembers"
  • public string FeatureName { get; }
  • public bool IsOptional { get; set; }
  • public CompilerFeatureRequiredAttribute(string featureName)
• public static class IsExternalInit
• public sealed class RequiredMemberAttribute : Attribute
  • public RequiredMemberAttribute()