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

---

API Differences between 4.27.6128.21479 and 9.10.1

83 Additions 132 Removals

NJsonSchema

• public class ConversionUtilities
• public class DefaultSchemaNameGenerator : ISchemaNameGenerator
• public class DefaultTypeNameGenerator : ITypeNameGenerator
• public interface IJsonExtensionObject
• public interface ISchemaNameGenerator
• public interface ISchemaDefinitionAppender
  • object RootObject { get; set; }
  • void Append(JsonSchema4 objectToAppend)
• public interface ISchemaResolver
  • 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, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • string Generate(JsonSchema4 schema)
• public class JsonExtensionObject : IJsonExtensionObject
• public static class JsonFormatStrings
  • public const string Integer = "int32"
• 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 IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
  • public static string GetJsonPath(object root, object searchedObject, ISchemaDefinitionAppender schemaDefinitionAppender = null)
  • public static string GetPropertyName(MemberInfo property, PropertyNameHandling propertyNameHandling)
• 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 Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath)
  • public virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url)
  • public JsonReferenceResolver()
  • public void AddDocumentReference(string documentPath, JsonSchema4 schema)
  • public JsonSchema4 ResolveReference(object rootObject, string jsonPath)
• public class JsonSchema4 : IDocumentPathProvider
  • public virtual JsonSchema4 ActualTypeSchema { get; }
  • public IReadOnlyCollection<JsonSchema4> AllInheritedSchemas { get; }
  • public string DocumentPath { get; set; }
  • public bool HasAllOfSchemaReference { get; }
  • public bool HasReference { get; }
  • public JsonSchema4 InheritedSchema { get; }
  • public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
  • public bool IsArray { get; }
  • 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> ResourceDefinitions { get; set; }
  • public string TypeNameRaw { get; set; }
  • public JsonXmlObject Xml { get; set; }
  • 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 FromFile(string filePath, JsonReferenceResolver jsonReferenceResolver)
  • public static JsonSchema4 FromJson(string data)
  • public static JsonSchema4 FromJson(string data, string documentPath)
  • public static JsonSchema4 FromJson(string data, string documentPath, JsonReferenceResolver jsonReferenceResolver)
  • 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 static JsonSchema4 FromUrl(string url)
  • public static JsonSchema4 FromUrl(string url, JsonReferenceResolver jsonReferenceResolver)
  • 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 object RootObject { get; set; }
  • public JsonSchemaDefinitionAppender(object rootObject, ITypeNameGenerator typeNameGenerator)
  • public void Append(JsonSchema4 objectToAppend)
• public static class JsonSchemaReferenceUtilities
  • public static void UpdateSchemaReferencePaths(object rootObject)
  • public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
  • public static void UpdateSchemaReferencePaths(object root, ISchemaDefinitionAppender schemaDefinitionAppender)
  • public static void UpdateSchemaReferences(object root)
  • public static void UpdateSchemaReferences(object root, JsonReferenceResolver jsonReferenceResolver)
• public class JsonSchemaResolver
• public class JsonXmlObject
• 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> Schemas { 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 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 JsonInheritanceConverter(string discriminator, bool readTypeProperty)
• 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)
  • 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
• public class JsonSchemaGeneratorSettings
  • public IContractResolver ActualContractResolver { get; }
  • public bool AllowReferencesWithProperties { get; set; }
  • public IContractResolver ContractResolver { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { 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 IList<ISchemaProcessor> SchemaProcessors { get; }
  • public SchemaType SchemaType { get; set; }
  • public NullHandling NullHandling { get; set; }
  • public JsonContract ResolveContract(Type type)
• public class JsonTypeDescription
• public class SampleJsonSchemaGenerator
• public class SchemaProcessorContext

NJsonSchema.Generation.TypeMappers

• public interface ITypeMapper
  • Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • TSchemaType GetSchema<TSchemaType>(JsonSchemaGenerator schemaGenerator, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
• public class ObjectTypeMapper : ITypeMapper
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, JsonSchema4> schemaFactory)
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema4>> schemaFactory)
  • public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • 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 Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • public virtual TSchemaType GetSchema<TSchemaType>(JsonSchemaGenerator schemaGenerator, ISchemaResolver schemaResolver) where TSchemaType : JsonSchema4
• public class TypeMapperContext

NJsonSchema.Infrastructure

• public static class DynamicApis
• public static class ReflectionCache
• public static class ReflectionExtensions
  • public static Type FindCommonBaseType(this IEnumerable<Type> types)
  • public static bool HasProperty(this object obj, string propertyName)
  • public static T TryGetPropertyValue<T>(this object obj, string propertyName, T defaultValue = null)
• 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 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
• public interface IJsonReferenceBase
• public abstract class JsonReferenceBase<T> : IJsonReferenceBase 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 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
  • TimeExpected = 20
  • TimeSpanExpected = 21

NJsonSchema.Visitors

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