<PackageReference Include="NJsonSchema" Version="10.6.7" />

---

API Differences between 10.6.7 and 10.0.15

91 Additions 40 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 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 JsonSchema FromSampleJson(Stream stream)
  • 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, IFormatValidator[] customValidators)
  • public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
  • public ICollection<ValidationError> Validate(string jsonData, SchemaType schemaType, IFormatValidator[] customValidators)
  • public ICollection<ValidationError> Validate(JToken token, SchemaType schemaType, IFormatValidator[] customValidators)
• 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)

NJsonSchema.Annotations

• public interface IJsonSchemaExtensionDataAttribute
  • string Key { get; }
  • object Value { get; }

NJsonSchema.Converters

• public class JsonInheritanceAttribute : Attribute
  • public string Key { get; }
  • public Type Type { get; }
  • public JsonInheritanceAttribute(string key, Type type)
• public class JsonInheritanceConverter : JsonConverter
  • public JsonInheritanceConverter(Type baseType, string discriminatorName, bool readTypeProperty)

NJsonSchema.Generation

• public interface IXmlDocsSettings
  • bool ResolveExternalXmlDocumentation { get; }
  • bool UseXmlDocumentation { get; }
• public class JsonSchemaGenerator
  • public virtual void ApplyDataAnnotations(JsonSchema schema, ContextualType contextualType, JsonTypeDescription typeDescription)
  • 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 virtual string GetPropertyName(JsonProperty jsonProperty, ContextualAccessorInfo accessorInfo)
  • protected virtual bool IsPropertyIgnored(ContextualAccessorInfo accessorInfo, Type parentType)
• public class JsonSchemaGeneratorSettings : IXmlDocsSettings
  • public bool GenerateExamples { get; set; }
  • public bool ResolveExternalXmlDocumentation { get; set; }
  • public object SerializerOptions { get; set; }
  • public bool UseXmlDocumentation { get; set; }
• 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 class SampleJsonDataGenerator
  • public SampleJsonDataGenerator()
  • public SampleJsonDataGenerator(SampleJsonDataGeneratorSettings settings)
  • public JToken Generate(JsonSchema schema)
• public class SampleJsonDataGeneratorSettings
  • public bool GenerateOptionalProperties { get; set; }
  • public SampleJsonDataGeneratorSettings()
• public class SampleJsonSchemaGenerator
  • public JsonSchema Generate(Stream stream)
• public static class SystemTextJsonUtilities
  • public static JsonSerializerSettings ConvertJsonOptionsToNewtonsoftSettings(object serializerOptions)

NJsonSchema.Infrastructure

• public enum DescriptionAttributeType
• public static class DynamicApis
  • public static string[] DirectoryGetDirectories(string directory)
  • public static string DirectoryGetParent(string path)
  • public static Task<string> HttpGetAsync(string url)
  • public static string HandleSubdirectoryRelativeReferences(string fullPath, string jsonPath)
  • public static Task<string> HttpGetAsync(string url, CancellationToken cancellationToken)
  • 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, 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)

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 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 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
  • 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)