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

---

API Differences between 2.57.6037.28393 and 9.10.48

73 Additions 160 Removals

NJsonSchema

• public class ConversionUtilities
• public class DefaultSchemaNameGenerator : ISchemaNameGenerator
• public class DefaultTypeNameGenerator : ITypeNameGenerator
• public interface IDocumentPathProvider
• public interface IJsonExtensionObject
• public interface ISchemaNameGenerator
• public interface ISchemaDefinitionAppender
  • void Append(object root, JsonSchema4 objectToAppend)
• public interface ISchemaResolver
  • 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, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • string Generate(JsonSchema4 schema)
• public class JsonExtensionObject : IJsonExtensionObject
• public class JsonExceptionConverter : JsonConverter
  • public JsonExceptionConverter()
• public static class JsonFormatStrings
  • public const string Date = "date"
  • public const string Float = "float"
  • public const string Integer = "int32"
  • public const string Phone = "phone"
  • public const string Time = "time"
  • public const string Uuid = "uuid"
• public class JsonObjectTypeDescription
  • public string Format { get; }
  • public bool IsAny { get; }
  • public bool IsComplexType { get; }
  • public bool IsDictionary { get; }
  • public bool IsEnum { get; }
  • public bool IsNullable { get; }
  • public JsonObjectType Type { get; }
  • 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 rootObject, object searchedObject)
  • public static string GetJsonPath(object rootObject, object searchedObject, IContractResolver contractResolver)
  • public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects, IContractResolver contractResolver)
  • 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, PropertyNameHandling propertyNameHandling)
• public class JsonProperty : JsonSchema4
  • public JsonSchema4 ActualPropertySchema { get; }
  • public bool IsWriteOnly { get; set; }
• public class JsonReferenceResolver
• public class JsonSchema4
  • public IReadOnlyDictionary<string, JsonProperty> ActualProperties { get; }
  • public virtual JsonSchema4 ActualTypeSchema { get; }
  • public IReadOnlyCollection<JsonSchema4> AllInheritedSchemas { get; }
  • public IReadOnlyDictionary<string, JsonProperty> AllProperties { get; }
  • public OpenApiDiscriminator BaseDiscriminator { get; }
  • public string BaseDiscriminator { get; }
  • public OpenApiDiscriminator DiscriminatorObject { get; set; }
  • public object Example { get; set; }
  • public decimal? ExclusiveMaximum { get; set; }
  • public decimal? ExclusiveMinimum { get; set; }
  • public bool HasAllOfSchemaReference { get; }
  • public bool HasReference { get; }
  • public JsonSchema4 InheritedSchema { get; }
  • public bool IsAbstract { get; set; }
  • public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
  • public bool IsArray { get; }
  • public bool IsDeprecated { get; set; }
  • public bool? IsNullableRaw { get; set; }
  • public bool IsTuple { get; }
  • public decimal? Maximum { get; set; }
  • public double? Maximum { get; set; }
  • public decimal? Minimum { get; set; }
  • public double? Minimum { get; set; }
  • public decimal? MultipleOf { get; set; }
  • public double? MultipleOf { get; set; }
  • public virtual object Parent { get; set; }
  • public IDictionary<string, JsonSchema4> PatternProperties { get; }
  • public IDictionary<string, JsonProperty> PatternProperties { get; }
  • public string TypeNameRaw { get; set; }
  • public JsonXmlObject Xml { get; set; }
  • public static PropertyRenameAndIgnoreSerializerContractResolver CreateJsonSerializerContractResolver(SchemaType schemaType)
  • 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 JsonSchema4 FromSampleJson(string data)
  • 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 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 bool InheritsSchema(JsonSchema4 parentSchema)
  • public virtual bool IsNullable(SchemaType schemaType)
  • public virtual bool IsNullable(NullHandling nullHandling)
  • public string ToJson(ITypeNameGenerator typeNameGenerator)
• public class JsonSchemaDefinitionAppender : ISchemaDefinitionAppender
  • public JsonSchemaDefinitionAppender(ITypeNameGenerator typeNameGenerator)
  • public void Append(object root, JsonSchema4 objectToAppend)
• public static class JsonSchemaReferenceUtilities
  • public static void UpdateSchemaReferencePaths(object rootObject)
  • public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences, IContractResolver contractResolver)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver)
  • public static void UpdateSchemaReferencePaths(object root, ISchemaDefinitionAppender schemaDefinitionAppender)
  • public static void UpdateSchemaReferences(object root)
• public class JsonSchemaResolver
• public class JsonXmlObject
• public class OpenApiDiscriminator
• public enum NullHandling
  • JsonSchema = 0
  • Swagger = 1
• public enum PropertyNameHandling
  • SnakeCase = 2
• public enum ReferenceTypeNullHandling
• public enum SchemaType
• public class SchemaResolver : ISchemaResolver
  • public IEnumerable<JsonSchema4> Schemes { get; }
  • public SchemaResolver()
  • 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 CanBeNullAttribute : Attribute
• public class JsonSchemaAttribute : Attribute
  • public string Name { get; set; }
  • public JsonSchemaAttribute(string name)
• public class JsonSchemaDateAttribute : JsonSchemaAttribute
• public class JsonSchemaIgnoreAttribute : Attribute
• public class JsonSchemaProcessorAttribute : Attribute
• public class MultipleOfAttribute : Attribute
  • public decimal MultipleOf { get; }
  • public double MultipleOf { get; }
  • public MultipleOfAttribute(decimal multipleOf)
• public class NotNullAttribute : Attribute

NJsonSchema.Converters

• public class JsonInheritanceConverter : JsonConverter
  • public virtual string DiscriminatorName { get; }
  • 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

NJsonSchema.Generation

• public class DefaultReflectionService : IReflectionService
• public interface IReflectionService
• public interface ISchemaProcessor
• public class JsonSchemaGenerator
  • public virtual 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 void ApplyPropertyAnnotations(JsonSchema4 jsonProperty, Type parentType, IList<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 class JsonSchemaGeneratorSettings
  • public IContractResolver ActualContractResolver { get; }
  • public bool AllowReferencesWithProperties { get; set; }
  • public IContractResolver ContractResolver { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
  • public string[] ExcludedTypeNames { get; set; }
  • public bool GenerateAbstractProperties { get; set; }
  • public bool GenerateXmlObjects { get; set; }
  • public bool IgnoreObsoleteProperties { get; set; }
  • public IReflectionService ReflectionService { get; set; }
  • public ISchemaNameGenerator SchemaNameGenerator { get; set; }
  • public ICollection<ISchemaProcessor> SchemaProcessors { get; }
  • public SchemaType SchemaType { get; set; }
  • public ICollection<ITypeMapper> TypeMappers { get; set; }
  • public NullHandling NullHandling { get; set; }
  • public JsonContract ResolveContract(Type type)
• public class JsonTypeDescription
• public class SampleJsonSchemaGenerator
• public class SchemaProcessorContext

NJsonSchema.Generation.SchemaProcessors

• public class DiscriminatorSchemaProcessor : ISchemaProcessor

NJsonSchema.Generation.TypeMappers

• public interface ITypeMapper
• public class ObjectTypeMapper : ITypeMapper
• public class PrimitiveTypeMapper : ITypeMapper
• public class TypeMapperContext

NJsonSchema.Infrastructure

• public class CollectionProxy<TInterface, TImplementation> : ICollection<TInterface>, IEnumerable<TInterface>, IEnumerable where TImplementation : TInterface
• public static class DynamicApis
• public class JsonSchemaSerialization
• public class PropertyRenameAndIgnoreSerializerContractResolver : DefaultContractResolver
• public static class ReflectionCache
• public static class ReflectionExtensions
• public enum TypeNameStyle
• public static class XmlDocumentationExtensions
  • 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<string> GetXmlDocumentationAsync(this Type type)
  • 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 Type type, string tagName)
  • public static Task<string> GetXmlDocumentationTagAsync(this MemberInfo member, string tagName)
  • public static string GetXmlDocumentationText(this XElement element)
  • public static Task<string> GetXmlRemarksAsync(this Type type)
  • public static Task<string> GetXmlRemarksAsync(this MemberInfo member)
  • public static Task<string> GetXmlSummaryAsync(this Type type)
  • public static Task<string> GetXmlSummaryAsync(this MemberInfo member)
  • 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 class XmlObjectExtension

NJsonSchema.References

• public interface IJsonReference : IJsonReferenceBase, IDocumentPathProvider
• public interface IJsonReferenceBase : IDocumentPathProvider
• public abstract class JsonReferenceBase<T> : IJsonReferenceBase, IDocumentPathProvider where T : IJsonReference
• public static class JsonReferenceExtensions

NJsonSchema.Validation

• public class ChildSchemaValidationError : ValidationError
  • public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> errors, JToken token, JsonSchema4 schema)
  • public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> errors)
• public class JsonSchemaValidator
• public class MultiTypeValidationError : ValidationError
• public class ValidationError
  • public bool HasLineInfo { get; }
  • public int LineNumber { get; }
  • public int LinePosition { get; }
  • public JsonSchema4 Schema { get; }
  • public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema4 schema)
  • public ValidationError(ValidationErrorKind kind, string property, string path)
• public enum ValidationErrorKind
  • DateExpected = 19
  • NoTypeValidates = 43
  • TimeExpected = 20
  • TimeSpanExpected = 21

NJsonSchema.Visitors

• public abstract class JsonReferenceVisitorBase
• public abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase