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

---

API Differences between 5.0.6130.17623 and 1.4.5731.36729

167 Additions 19 Removals

NJsonSchema

• public enum EnumHandling
  • Integer = 0
  • String = 1
• public interface IDocumentPathProvider
  • string DocumentPath { get; }
• public interface ISchemaDefinitionAppender
  • object RootObject { get; set; }
  • void Append(JsonSchema4 objectToAppend)
• public interface ISchemaResolver
  • void AddSchema(Type type, JsonSchema4 schema)
  • JsonSchema4 GetSchema(Type type)
  • bool HasSchema(Type type)
  • IEnumerable<JsonSchema4> Schemas { get; }
  • void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema4 schema)
  • JsonSchema4 GetSchema(Type type, bool isIntegerEnumeration)
  • bool HasSchema(Type type, bool isIntegerEnumeration)
• public interface ITypeNameGenerator
  • string Generate(JsonSchema4 schema)
• public static class JsonFormatStrings
  • public const string Base64 = "base64"
  • public const string Byte = "byte"
  • public const string Date = "date"
  • public const string Decimal = "decimal"
  • public const string Double = "double"
  • public const string Guid = "guid"
  • public const string Hostname = "hostname"
  • public const string IpV4 = "ipv4"
  • public const string IpV6 = "ipv6"
  • public const string Long = "long"
  • public const string Phone = "phone"
  • public const string Time = "time"
  • public const string TimeSpan = "time-span"
  • public const string Uuid = "uuid"
• public enum JsonObjectType
  • File = 128
• public class JsonObjectTypeDescription
  • public bool IsAlwaysRequired { get; }
  • public bool IsAny { get; }
  • public bool IsComplexType { get; }
  • public bool IsEnum { get; }
  • public bool IsNullable { get; }
  • public static JsonObjectTypeDescription FromType(Type type)
  • public static JsonObjectTypeDescription FromType(Type type, IEnumerable<Attribute> parentAttributes, EnumHandling defaultEnumHandling)
  • public static bool IsStringEnum(Type classType, IEnumerable<Attribute> propertyAttributes, EnumHandling defaultEnumHandling)
  • public void ApplyType(JsonSchema4 schema)
• public static class JsonPathUtilities
  • public static string GetJsonPath(object obj, object objectToSearch)
  • public static JsonSchema4 GetObjectFromJsonPath(object obj, string path)
  • public static string GetJsonPath(object root, object searchedObject, ISchemaDefinitionAppender schemaDefinitionAppender = null)
  • public static string GetPropertyName(MemberInfo property, PropertyNameHandling propertyNameHandling)
• public class JsonProperty : JsonSchema4
  • public JsonSchema4 ActualPropertySchema { get; }
  • public bool IsInheritanceDiscriminator { get; }
  • public bool IsReadOnly { get; set; }
• public class JsonReferenceResolver
  • public JsonReferenceResolver()
  • public void AddDocumentReference(string documentPath, JsonSchema4 schema)
  • public JsonSchema4 ResolveReference(object rootObject, string jsonPath)
• public class JsonSchema4 : IDocumentPathProvider
  • public static string ToolchainVersion { get; }
  • public IReadOnlyDictionary<string, JsonProperty> ActualProperties { get; }
  • public string BaseDiscriminator { get; }
  • public string Discriminator { get; set; }
  • public string DocumentPath { get; set; }
  • public Collection<string> EnumerationNames { get; set; }
  • public Collection<string> EnumerationNamesRaw { get; set; }
  • public IDictionary<string, object> ExtensionData { get; set; }
  • public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
  • public bool IsAnyType { get; }
  • public bool IsEnumeration { 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 IDictionary<string, JsonProperty> PatternProperties { get; }
  • public IDictionary<string, JsonSchema4> PatternProperties { get; }
  • public IDictionary<string, JsonSchema4> ResourceDefinitions { get; set; }
  • public string TypeName { get; set; }
  • public string TypeNameRaw { get; set; }
  • public static JsonSchema4 CreateAnySchema()
  • public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema4
  • public static JsonSchema4 FromFile(string filePath)
  • public static JsonSchema4 FromFile(string filePath, JsonReferenceResolver jsonReferenceResolver)
  • public static JsonSchema4 FromJson(string data, string documentPath)
  • public static JsonSchema4 FromJson(string data, string documentPath, JsonReferenceResolver jsonReferenceResolver)
  • public static JsonSchema4 FromType<TType>(JsonSchemaGeneratorSettings settings)
  • public static JsonSchema4 FromType(Type type, JsonSchemaGeneratorSettings settings)
  • public static JsonSchema4 FromUrl(string url)
  • public static JsonSchema4 FromUrl(string url, JsonReferenceResolver jsonReferenceResolver)
  • public string GetTypeName(ITypeNameGenerator typeNameGenerator)
  • public bool Inherits(JsonSchema4 schema)
  • public virtual bool IsNullable(NullHandling nullHandling)
  • public string ToJson(ITypeNameGenerator typeNameGenerator)
  • public ICollection<ValidationError> Validate(string jsonData)
• public class JsonSchemaGenerator
• public class JsonSchemaDefinitionAppender : ISchemaDefinitionAppender
  • public object RootObject { get; set; }
  • public JsonSchemaDefinitionAppender(object rootObject, ITypeNameGenerator typeNameGenerator)
  • public void Append(JsonSchema4 objectToAppend)
• public static class JsonSchemaReferenceUtilities
  • public static void UpdateAllTypeReferences(object root)
  • public static void UpdateSchemaReferencePaths(object root, ISchemaDefinitionAppender schemaDefinitionAppender)
  • public static void UpdateSchemaReferences(object root)
  • public static void UpdateSchemaReferences(object root, JsonReferenceResolver jsonReferenceResolver)
• public enum NullHandling
  • JsonSchema = 0
  • Swagger = 1
• public enum PropertyNameHandling
  • CamelCase = 1
  • Default = 0
• public class SchemaResolver : ISchemaResolver
  • public IEnumerable<JsonSchema4> Schemes { get; }
  • public IEnumerable<JsonSchema4> Schemas { get; }
  • public void AddSchema(Type type, JsonSchema4 schema)
  • public JsonSchema4 GetSchema(Type type)
  • public bool HasSchema(Type type)
  • public void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema4 schema)
  • public JsonSchema4 GetSchema(Type type, bool isIntegerEnumeration)
  • public bool HasSchema(Type type, bool isIntegerEnumeration)

NJsonSchema.Annotations

• public class JsonSchemaAttribute : Attribute
  • public Type ArrayItem { get; set; }
  • public string Format { get; set; }
  • public JsonObjectType Type { get; }
  • public JsonSchemaAttribute()
  • public JsonSchemaAttribute(JsonObjectType type)
• public class JsonSchemaExtensionDataAttribute : Attribute
  • public string Property { get; }
  • public object Value { get; }
  • public JsonSchemaExtensionDataAttribute(string property, object value)
• public class MultipleOfAttribute : Attribute
  • public decimal MultipleOf { get; }
  • public MultipleOfAttribute(double multipleOf)
  • public MultipleOfAttribute(decimal multipleOf)

NJsonSchema.Converters

• public class JsonInheritanceConverter : JsonConverter
  • public JsonInheritanceConverter()
  • public JsonInheritanceConverter(string discriminator)

NJsonSchema.Generation

• public class JsonSchemaGenerator
  • public JsonSchemaGeneratorSettings Settings { get; }
  • public JsonSchemaGenerator(JsonSchemaGeneratorSettings settings)
  • public void ApplyPropertyAnnotations(JsonSchema4 jsonProperty, Type parentType, IList<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
  • public JsonSchema4 Generate(Type type)
  • public JsonSchema4 Generate(Type type, ISchemaResolver schemaResolver, ISchemaDefinitionAppender schemaDefinitionAppender)
  • public virtual TSchemaType Generate<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, ISchemaResolver schemaResolver, ISchemaDefinitionAppender schemaDefinitionAppender) where TSchemaType : JsonSchema4
  • protected virtual void GenerateObject<TSchemaType>(Type type, TSchemaType schema, ISchemaResolver schemaResolver, ISchemaDefinitionAppender schemaDefinitionAppender) where TSchemaType : JsonSchema4
  • protected virtual string[] GetTypeProperties(Type type)
• public class JsonSchemaGeneratorSettings
  • public EnumHandling DefaultEnumHandling { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public bool FlattenInheritanceHierarchy { get; set; }
  • public bool GenerateKnownTypes { get; set; }
  • public NullHandling NullHandling { get; set; }
  • public ICollection<ITypeMapper> TypeMappers { get; set; }
  • public ITypeNameGenerator TypeNameGenerator { get; set; }
  • public JsonSchemaGeneratorSettings()

NJsonSchema.Generation.TypeMappers

• public interface ITypeMapper
  • Type MappedType { get; }
  • bool UseReference { get; }
  • TSchemaType GetSchema<TSchemaType>(JsonSchemaGenerator schemaGenerator, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
• public class ObjectTypeMapper : ITypeMapper
  • public Type MappedType { get; }
  • public bool UseReference { get; }
  • public ObjectTypeMapper(Type mappedType, JsonSchema4 schema)
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, ISchemaResolver, JsonSchema4> schemaFactory)
  • public virtual TSchemaType GetSchema<TSchemaType>(JsonSchemaGenerator schemaGenerator, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
• public class PrimitiveTypeMapper : ITypeMapper
  • public Type MappedType { get; }
  • public bool UseReference { get; }
  • public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema4> transformer)
  • public virtual TSchemaType GetSchema<TSchemaType>(JsonSchemaGenerator schemaGenerator, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4

NJsonSchema.Infrastructure

• public static class ReflectionExtensions
  • public static Type GetEnumerableItemType(this Type type)
  • public static Type[] GetGenericTypeArguments(this Type type)
  • 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 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)

NJsonSchema.Validation

• public enum ValidationErrorKind
  • Base64Expected = 39
  • GuidExpected = 22
  • HostnameExpected = 31
  • IpV4Expected = 20
  • IpV6Expected = 21
  • NoAdditionalPropertiesAllowed = 36
  • TooManyPropertiesInTuple = 32