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

---

API Differences between 9.7.1 and 2.34.6000.31959

276 Additions 45 Removals

NJsonSchema

• public class ConversionUtilities
  • public ConversionUtilities()
  • public static string ConvertCSharpDocBreaks(string input, int tabCount)
  • public static string ConvertToCamelCase(string input)
  • public static string ConvertToLowerCamelCase(string input, bool firstCharacterMustBeAlpha)
  • public static string ConvertToStringLiteral(string input)
  • public static string ConvertToUpperCamelCase(string input, bool firstCharacterMustBeAlpha)
  • public static string RemoveLineBreaks(string text)
  • public static string Tab(string input, int tabCount)
  • public static string TrimWhiteSpaces(string text)
• public class DefaultSchemaNameGenerator : ISchemaNameGenerator
  • public DefaultSchemaNameGenerator()
  • public virtual string Generate(Type type)
• public class DefaultTypeNameGenerator : ITypeNameGenerator
  • public IEnumerable<string> ReservedTypeNames { get; set; }
  • public IDictionary<string, string> TypeNameMappings { get; }
  • public DefaultTypeNameGenerator()
  • public virtual string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • protected virtual string Generate(JsonSchema4 schema, string typeNameHint)
• public interface IDocumentPathProvider
  • string DocumentPath { get; }
• public interface IJsonExtensionObject
  • IDictionary<string, object> ExtensionData { get; set; }
• public interface ISchemaDefinitionAppender
• public interface ISchemaResolver
• public interface ISchemaNameGenerator
  • string Generate(Type type)
• public interface ITypeNameGenerator
  • string Generate(JsonSchema4 schema)
  • string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
• public class JsonExtensionObject : IJsonExtensionObject
  • public IDictionary<string, object> ExtensionData { get; set; }
  • public JsonExtensionObject()
• public static class JsonFormatStrings
  • public const string Date = "date"
  • public const string Integer = "int32"
  • public const string Phone = "phone"
  • public const string Time = "time"
  • public const string Uuid = "uuid"
• public class JsonObjectTypeDescription
• public static class JsonPathUtilities
  • public static string GetJsonPath(object root, object objectToSearch, ISchemaDefinitionAppender schemaDefinitionAppender = null)
  • public static JsonSchema4 GetObjectFromJsonPath(object root, string path)
  • public static string GetPropertyName(PropertyInfo property)
  • public static string GetJsonPath(object rootObject, object searchedObject)
  • public static IDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
• public class JsonProperty : JsonSchema4
  • public bool IsInheritanceDiscriminator { get; }
• public class JsonReferenceResolver
  • public JsonReferenceResolver(JsonSchemaResolver schemaResolver)
  • public void AddDocumentReference(string documentPath, IJsonReference schema)
  • public virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath)
  • public virtual Task<IJsonReference> ResolveFileReferenceAsync(string filePath)
  • public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath)
  • public virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url)
• public class JsonSchema4 : JsonReferenceBase<JsonSchema4>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
  • public IDictionary<string, JsonProperty> ActualProperties { get; }
  • public ICollection<JsonSchema4> AllInheritedSchemas { get; }
  • public string BaseDiscriminator { get; }
  • public string Discriminator { get; set; }
  • public bool HasAllOfSchemaReference { get; }
  • public bool HasReference { get; }
  • public JsonSchema4 InheritedSchema { get; }
  • public double? Maximum { get; set; }
  • public decimal? Maximum { get; set; }
  • public double? Minimum { get; set; }
  • public decimal? Minimum { get; set; }
  • public double? MultipleOf { get; set; }
  • public decimal? MultipleOf { get; set; }
  • public virtual object Parent { get; set; }
  • public IDictionary<string, JsonProperty> PatternProperties { get; }
  • public IDictionary<string, JsonSchema4> PatternProperties { get; }
  • public string TypeNameRaw { get; set; }
  • public JsonXmlObject Xml { get; set; }
  • public static JsonSchema4 CreateTypeReference(JsonSchema4 schema)
  • public static JsonSchema4 FromFile(string filePath)
  • public static JsonSchema4 FromJson(string data, string rootDirectory = null)
  • public static JsonSchema4 FromType<TType>()
  • public static JsonSchema4 FromType(Type type)
  • public static JsonSchema4 FromType<TType>(JsonSchemaGeneratorSettings settings)
  • public static JsonSchema4 FromType(Type type, JsonSchemaGeneratorSettings settings)
  • public JsonSchema4 FindRootParent()
  • public string GetTypeName(ITypeNameGenerator typeNameGenerator)
  • public virtual bool IsNullable(PropertyNullHandling propertyNullHandling)
  • public static JsonSchema4 CreateAnySchema()
  • public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema4
  • public static JsonSchema4 FromData(string data)
  • public static Task<JsonSchema4> FromFileAsync(string filePath)
  • public static Task<JsonSchema4> FromFileAsync(string filePath, Func<JsonSchema4, JsonReferenceResolver> referenceResolverFactory)
  • public static Task<JsonSchema4> FromJsonAsync(string data)
  • public static Task<JsonSchema4> FromJsonAsync(string data, string documentPath)
  • public static Task<JsonSchema4> FromJsonAsync(string data, string documentPath, Func<JsonSchema4, JsonReferenceResolver> referenceResolverFactory)
  • public static Task<JsonSchema4> FromTypeAsync<TType>()
  • public static Task<JsonSchema4> FromTypeAsync(Type type)
  • public static Task<JsonSchema4> FromTypeAsync<TType>(JsonSchemaGeneratorSettings settings)
  • public static Task<JsonSchema4> FromTypeAsync(Type type, JsonSchemaGeneratorSettings settings)
  • public static Task<JsonSchema4> FromUrlAsync(string url)
  • public static Task<JsonSchema4> FromUrlAsync(string url, Func<JsonSchema4, JsonReferenceResolver> referenceResolverFactory)
  • public bool Inherits(JsonSchema4 schema)
  • public bool InheritsSchema(JsonSchema4 parentSchema)
  • public virtual bool IsNullable(SchemaType schemaType)
  • public string ToJson(ITypeNameGenerator typeNameGenerator)
  • public string ToJson(JsonSchemaGeneratorSettings settings)
• public class JsonSchemaDefinitionAppender : ISchemaDefinitionAppender
• public static class JsonSchemaReferenceUtilities
  • public static void UpdateSchemaReferencePaths(object root, ISchemaDefinitionAppender schemaDefinitionAppender)
  • public static void UpdateSchemaReferences(object root)
  • public static void UpdateSchemaReferencePaths(object rootObject)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
• public enum PropertyNullHandling
• public class SchemaResolver : ISchemaResolver
• public class JsonSchemaResolver
  • public object RootObject { get; }
  • public IEnumerable<JsonSchema4> Schemas { get; }
  • public JsonSchemaResolver(object rootObject, JsonSchemaGeneratorSettings settings)
  • public virtual void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema4 schema)
  • public virtual void AppendSchema(JsonSchema4 schema, string typeNameHint)
  • public JsonSchema4 GetSchema(Type type, bool isIntegerEnumeration)
  • public bool HasSchema(Type type, bool isIntegerEnumeration)
• public class JsonXmlObject
  • public bool Attribute { get; }
  • public string Name { get; }
  • public string Namespace { get; }
  • public JsonSchema4 ParentSchema { get; }
  • public string Prefix { get; }
  • public bool Wrapped { get; }
  • public JsonXmlObject()
• public enum PropertyNameHandling
  • CamelCase = 1
  • Default = 0
  • SnakeCase = 2
• public enum ReferenceTypeNullHandling
  • NotNull = 1
  • Null = 0
• public enum SchemaType
  • JsonSchema = 0
  • OpenApi3 = 2
  • Swagger2 = 1

NJsonSchema.Annotations

• public class CanBeNullAttribute : Attribute
  • public CanBeNullAttribute()
• public class JsonSchemaAttribute : Attribute
  • public Type ArrayItem { get; set; }
  • public string Name { get; set; }
  • public JsonSchemaAttribute(string name)
• public class MultipleOfAttribute : Attribute
  • public double MultipleOf { get; }
  • public decimal MultipleOf { get; }
  • public MultipleOfAttribute(decimal multipleOf)
• public class NotNullAttribute : Attribute
  • public NotNullAttribute()

NJsonSchema.Converters

• public class JsonInheritanceConverter : JsonConverter
  • public JsonInheritanceConverter()
  • public JsonInheritanceConverter(string discriminator)
  • public JsonInheritanceConverter(string discriminator, bool readTypeProperty)

NJsonSchema.Generation

• public class DataToJsonSchemaGenerator
  • public DataToJsonSchemaGenerator()
  • public JsonSchema4 Generate(string json)
• public class DefaultReflectionService : IReflectionService
  • public DefaultReflectionService()
  • public virtual JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
  • protected virtual bool IsArrayType(Type type, IEnumerable<Attribute> parentAttributes)
  • protected virtual bool IsDictionaryType(Type type, IEnumerable<Attribute> parentAttributes)
  • protected virtual bool IsFileType(Type type, IEnumerable<Attribute> parentAttributes)
  • public virtual bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
• public interface IReflectionService
  • JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
  • bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
• public interface ISchemaProcessor
  • Task ProcessAsync(SchemaProcessorContext context)
• public class JsonSchemaGenerator
  • public void ApplyPropertyAnnotations(JsonSchema4 jsonProperty, IEnumerable<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
  • public JsonSchema4 Generate(Type type, ISchemaResolver schemaResolver)
  • public JsonSchema4 Generate(Type type, JsonSchema4 rootSchema, IEnumerable<Attribute> parentAttributes, ISchemaDefinitionAppender schemaDefinitionAppender, ISchemaResolver schemaResolver)
  • public TSchemaType Generate<TSchemaType>(Type type, JsonSchema4 rootSchema, IEnumerable<Attribute> parentAttributes, ISchemaDefinitionAppender schemaDefinitionAppender, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • protected virtual void GenerateObject<TSchemaType>(Type type, TSchemaType schema, JsonSchema4 rootSchema, ISchemaDefinitionAppender schemaDefinitionAppender, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • public Type[] GetGenericTypeArguments(Type type)
  • public 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<TSchemaType>(Type type, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • public Task<TSchemaType> GenerateWithReference<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
  • public Task<TSchemaType> GenerateWithReferenceAndNullability<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
  • public virtual Task<TSchemaType> GenerateWithReferenceAndNullability<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, bool isNullable, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
  • public virtual string GetPropertyName(JsonProperty property, MemberInfo memberInfo)
• public class JsonSchemaGeneratorSettings
  • public IContractResolver ActualContractResolver { get; }
  • public IContractResolver ContractResolver { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
  • public bool GenerateAbstractProperties { get; set; }
  • public PropertyNullHandling PropertyNullHandling { get; set; }
  • public bool GenerateXmlObjects { get; set; }
  • public bool IgnoreObsoleteProperties { get; set; }
  • public IReflectionService ReflectionService { get; set; }
  • public ISchemaNameGenerator SchemaNameGenerator { get; set; }
  • public IList<ISchemaProcessor> SchemaProcessors { get; }
  • public SchemaType SchemaType { get; set; }
  • public ICollection<ITypeMapper> TypeMappers { get; set; }
  • public JsonContract ResolveContract(Type type)
• public class JsonTypeDescription
  • public string Format { get; }
  • public bool IsAny { get; }
  • public bool IsArray { get; }
  • public bool IsComplexType { get; }
  • public bool IsDictionary { get; }
  • public bool IsEnum { get; }
  • public bool IsNullable { get; set; }
  • public JsonObjectType Type { 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 void ApplyType(JsonSchema4 schema)
  • public bool RequiresSchemaReference(IEnumerable<ITypeMapper> typeMappers)
• public class SchemaProcessorContext
  • public JsonSchemaGenerator Generator { get; }
  • public JsonSchemaResolver Resolver { get; }
  • public JsonSchema4 Schema { get; }
  • public Type Type { get; }
  • public SchemaProcessorContext(Type type, JsonSchema4 schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator)

NJsonSchema.Generation.TypeMappers

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

NJsonSchema.Infrastructure

• public static class DynamicApis
  • public static bool SupportsDirectoryApis { get; }
  • public static bool SupportsFileApis { get; }
  • public static bool SupportsHttpClientApis { get; }
  • public static bool SupportsPathApis { get; }
  • public static bool SupportsXPathApis { get; }
  • 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 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 class ReflectionCache
  • public class CustomAttributes
  • public class PropertyOrField
  • public static Attribute GetDataContractAttribute(Type type)
  • public static IEnumerable<PropertyOrField> GetPropertiesAndFields(Type type)
• public static class ReflectionExtensions
  • public static Type FindCommonBaseType(this IEnumerable<Type> types)
  • public static Type GetEnumerableItemType(this Type type)
  • public static Type[] GetGenericTypeArguments(this Type type)
  • public static bool HasProperty(this object obj, string propertyName)
  • public static bool InheritsFrom(this Type type, string typeName, TypeNameStyle typeNameStyle)
  • public static bool IsAssignableTo(this Type type, string typeName, TypeNameStyle typeNameStyle)
  • public static T TryGetByObjectType<T>(this IEnumerable<T> attributes, string typeName, TypeNameStyle typeNameStyle = 1)
  • public static T TryGetIfAssignableTo<T>(this IEnumerable<T> attributes, string typeName, TypeNameStyle typeNameStyle = 1)
  • public static T TryGetPropertyValue<T>(this object obj, string propertyName, T defaultValue = null)
• public enum TypeNameStyle
  • FullName = 1
  • Name = 0
• public static class XmlDocumentationExtensions
  • public static string GetXmlDocumentation(this Type type)
  • public static string GetXmlDocumentation(this MemberInfo member)
  • public static string GetXmlDocumentation(this ParameterInfo parameter)
  • public static string GetXmlDocumentation(this Type type, string pathToXmlFile)
  • public static string GetXmlDocumentation(this MemberInfo member, string pathToXmlFile)
  • public static string GetXmlDocumentation(this ParameterInfo parameter, string pathToXmlFile)
  • public static Task<string> GetDescriptionAsync(this MemberInfo memberInfo, IEnumerable<Attribute> attributes)
  • public static Task<string> GetDescriptionAsync(this ParameterInfo parameter, IEnumerable<Attribute> attributes)
  • public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member)
  • public static Task<string> GetXmlDocumentationAsync(this ParameterInfo parameter)
  • public static Task<XElement> GetXmlDocumentationAsync(this Type type, string pathToXmlFile)
  • public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member, string pathToXmlFile)
  • public static Task<XElement> GetXmlDocumentationAsync(this ParameterInfo parameter, string pathToXmlFile)
  • public static Task<string> GetXmlDocumentationTagAsync(this MemberInfo member, string tagName)
  • public static Task<string> GetXmlRemarksAsync(this MemberInfo member)
  • public static Task<string> GetXmlSummaryAsync(this MemberInfo member)
• public static class XmlObjectExtension
  • 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)

NJsonSchema.References

• public interface IJsonReference : IJsonReferenceBase
  • IJsonReference ActualObject { get; }
  • object PossibleRoot { get; }
• public interface IJsonReferenceBase
  • string DocumentPath { get; set; }
  • IJsonReference Reference { get; set; }
  • string ReferencePath { get; set; }
• public abstract class JsonReferenceBase<T> : IJsonReferenceBase where T : IJsonReference
  • public string DocumentPath { get; set; }
  • public virtual T Reference { get; set; }
  • public string ReferencePath { get; set; }
  • protected JsonReferenceBase()
• public static class JsonReferenceExtensions
  • public static object FindRootParent(this IJsonReference obj)

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)
  • public IDictionary<JsonSchema4, ICollection<ValidationError>> Errors { get; }
  • public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IDictionary<JsonSchema4, ICollection<ValidationError>> errors, JToken token, JsonSchema4 schema)
• public class JsonSchemaValidator
  • public 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 class ValidationError
  • public bool HasLineInfo { get; }
  • public int LineNumber { get; }
  • public int LinePosition { get; }
  • public ValidationError(ValidationErrorKind kind, string property, string path)
  • public JsonSchema4 Schema { get; }
  • public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema4 schema)
• public enum ValidationErrorKind
  • DateExpected = 19
  • TimeExpected = 20
  • TimeSpanExpected = 21