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

---

API Differences between 9.13.32 and 8.0.6242.20238

310 Additions 31 Removals

NJsonSchema

• public class ConversionUtilities
  • public static string ConvertCSharpDocBreaks(string input, int tabCount)
  • public static string ConvertCSharpDocs(string input, int tabCount)
  • public static string Singularize(string word)
• public class DefaultTypeNameGenerator : ITypeNameGenerator
  • public IEnumerable<string> ReservedTypeNames { get; set; }
  • public IDictionary<string, string> TypeNameMappings { get; }
  • public virtual string Generate(JsonSchema4 schema, string typeNameHint, ICollection<string> reservedTypeNames)
  • public virtual string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
• public enum EnumHandling
  • CamelCaseString = 2
• public interface IJsonExtensionObject
  • IDictionary<string, object> ExtensionData { get; set; }
• public interface ITypeNameGenerator
  • string Generate(JsonSchema4 schema, string typeNameHint, ICollection<string> reservedTypeNames)
  • 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 Binary = "binary"
  • public const string Float = "float"
• public static class JsonPathUtilities
  • public const string ReferenceReplaceString = "__referencePath"
  • public static string GetJsonPath(object rootObject, object searchedObject, IContractResolver contractResolver)
  • public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects, IContractResolver contractResolver)
• public class JsonProperty : JsonSchema4
  • public JsonSchema4 ActualPropertySchema { get; }
  • public bool IsWriteOnly { get; set; }
• public class JsonReferenceResolver
  • public void AddDocumentReference(string documentPath, JsonSchema4 schema)
  • protected virtual JsonSchema4 ResolveDocumentReference(object rootObject, string jsonPath)
  • protected virtual Task<JsonSchema4> ResolveFileReferenceAsync(string filePath)
  • public Task<JsonSchema4> ResolveReferenceAsync(object rootObject, string jsonPath)
  • protected virtual Task<JsonSchema4> ResolveUrlReferenceAsync(string url)
  • public static Func<JsonSchema4, JsonReferenceResolver> CreateJsonReferenceResolverFactory(JsonSchemaGeneratorSettings settings)
  • 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 class JsonSchema4 : JsonReferenceBase<JsonSchema4>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
  • public string ActualDiscriminator { get; }
  • public OpenApiDiscriminator ActualDiscriminatorObject { get; }
  • public virtual JsonSchema4 ActualTypeSchema { get; }
  • public string BaseDiscriminator { get; }
  • public JsonSchema4 DictionaryKey { get; set; }
  • public string DocumentPath { get; set; }
  • 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 HasAnyOfSchemaReference { get; }
  • public bool HasOneOfSchemaReference { get; }
  • public bool HasReference { get; }
  • public bool HasTypeNameTitle { get; }
  • public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
  • public JsonSchema4 InheritedSchema { get; }
  • public JsonSchema4 InheritedTypeSchema { get; }
  • public bool IsAbstract { get; set; }
  • public bool IsArray { get; }
  • public bool IsBinary { get; }
  • public bool IsDeprecated { get; set; }
  • public bool IsFlagEnumerable { get; set; }
  • public bool? IsNullableRaw { get; set; }
  • public bool IsObject { get; }
  • public bool IsTuple { get; }
  • public virtual object Parent { get; set; }
  • public OpenApiDiscriminator ResponsibleDiscriminatorObject { get; }
  • public static JsonSchema4 FromData(string data)
  • public static PropertyRenameAndIgnoreSerializerContractResolver CreateJsonSerializerContractResolver(SchemaType schemaType)
  • public static JsonSchema4 FromSampleJson(string data)
  • public JsonSchema4 FindRootParent()
  • public virtual bool IsNullable(NullHandling nullHandling)
  • public bool InheritsSchema(JsonSchema4 parentSchema)
  • public virtual bool IsNullable(SchemaType schemaType)
  • public string ToJson(JsonSchemaGeneratorSettings settings)
  • public string ToJson(Formatting formatting)
• public static class JsonSchemaReferenceUtilities
  • public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences, IContractResolver contractResolver)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver)
• public enum NullHandling
• public class OpenApiDiscriminator
  • public object JsonInheritanceConverter { get; set; }
  • public IDictionary<string, JsonSchema4> Mapping { get; }
  • public string PropertyName { get; set; }
  • public OpenApiDiscriminator()
  • public void AddMapping(Type type, JsonSchema4 schema)
• 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 ItemsCanBeNullAttribute : Attribute
  • public ItemsCanBeNullAttribute()
• public class JsonSchemaAbstractAttribute : Attribute
  • public bool IsAbstract { get; }
  • public JsonSchemaAbstractAttribute()
  • public JsonSchemaAbstractAttribute(bool isAbstract)
• public class JsonSchemaDateAttribute : JsonSchemaAttribute
  • public JsonSchemaDateAttribute()
• public class JsonSchemaExtensionDataAttribute : Attribute
  • public string Property { get; }
  • public string Key { get; }
• public class JsonSchemaFlattenAttribute : Attribute
  • public bool Flatten { get; }
  • public JsonSchemaFlattenAttribute()
  • public JsonSchemaFlattenAttribute(bool flatten)
• public class JsonSchemaIgnoreAttribute : Attribute
  • public JsonSchemaIgnoreAttribute()
• public class JsonSchemaProcessorAttribute : Attribute
  • public object[] Parameters { get; set; }
  • public Type Type { get; set; }
  • public JsonSchemaProcessorAttribute(Type type, object[] parameters)
• public class JsonSchemaTypeAttribute : Attribute
  • public bool IsNullable { get; set; }
  • public Type Type { get; }
  • public JsonSchemaTypeAttribute(Type type)
• public class NotNullAttribute : Attribute
  • public NotNullAttribute()

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
  • public JsonReferenceConverter()

NJsonSchema.Generation

• public class DataToJsonSchemaGenerator
• public class JsonObjectTypeDescription
• public static class JsonReflectionUtilities
• 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 IsBinary(Type type, IEnumerable<Attribute> parentAttributes)
  • protected virtual bool IsDictionaryType(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, Type parentType, IList<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
  • public virtual void ApplyDataAnnotations(JsonSchema4 schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
  • protected virtual Task GenerateObjectAsync<TSchemaType>(Type type, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • protected virtual Task GenerateObjectAsync(Type type, JsonTypeDescription typeDescription, JsonSchema4 schema, JsonSchemaResolver schemaResolver)
  • public Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
  • public virtual Task<TSchemaType> GenerateWithReferenceAndNullabilityAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, bool isNullable, JsonSchemaResolver schemaResolver, Func<TSchemaType, JsonSchema4, Task> transformation = null) where TSchemaType : JsonSchema4
  • public Task<TSchemaType> GenerateWithReferenceAsync<TSchemaType>(Type type, IEnumerable<Attribute> parentAttributes, 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 JsonSerializerSettings ActualSerializerSettings { 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 GenerateAbstractSchemas { get; set; }
  • public bool GenerateCustomNullableProperties { get; set; }
  • public bool GenerateEnumMappingDescription { get; set; }
  • public NullHandling NullHandling { get; set; }
  • public bool IgnoreObsoleteProperties { get; set; }
  • public IReflectionService ReflectionService { get; set; }
  • public ICollection<ISchemaProcessor> SchemaProcessors { get; }
  • public SchemaType SchemaType { get; set; }
  • public JsonSerializerSettings SerializerSettings { get; set; }
  • public bool GetActualFlattenInheritanceHierarchy(Type type)
  • public bool GetActualGenerateAbstractSchema(Type type)
  • public JsonContract ResolveContract(Type type)
• public class JsonTypeDescription
  • public string Format { get; }
  • public bool IsAny { 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 SampleJsonSchemaGenerator
  • public SampleJsonSchemaGenerator()
  • public JsonSchema4 Generate(string json)
• public class SchemaProcessorContext
  • public JsonSchemaGenerator Generator { get; }
  • public JsonSchemaResolver Resolver { get; }
  • public JsonSchema4 Schema { get; }
  • public JsonSchemaGeneratorSettings Settings { get; }
  • public Type Type { get; }
  • public SchemaProcessorContext(Type type, JsonSchema4 schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)

NJsonSchema.Generation.SchemaProcessors

• public class DiscriminatorSchemaProcessor : ISchemaProcessor
  • public Type BaseType { get; }
  • public string Discriminator { get; }
  • public DiscriminatorSchemaProcessor(Type baseType)
  • public DiscriminatorSchemaProcessor(Type baseType, string discriminator)
  • public Task ProcessAsync(SchemaProcessorContext context)

NJsonSchema.Generation.TypeMappers

• public interface ITypeMapper
  • void GenerateSchema<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
• public class ObjectTypeMapper : ITypeMapper
  • public void GenerateSchema<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema4>> schemaFactory)
  • public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
• public class PrimitiveTypeMapper : ITypeMapper
  • public void GenerateSchema<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
  • 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 class CollectionProxy<TInterface, TImplementation> : ICollection<TInterface>, IEnumerable<TInterface>, IEnumerable where TImplementation : TInterface
  • public int Count { get; }
  • public bool IsReadOnly { get; }
  • public CollectionProxy(ICollection<TImplementation> collection)
  • public void Add(TInterface item)
  • public void Clear()
  • public bool Contains(TInterface item)
  • public void CopyTo(TInterface[] array, int arrayIndex)
  • public IEnumerator<TInterface> GetEnumerator()
  • public bool Remove(TInterface item)
• public static class DynamicApis
  • public static string GetFullPath(string path)
• public class JsonSchemaSerialization
  • public static SchemaType CurrentSchemaType { get; }
  • public static JsonSerializerSettings CurrentSerializerSettings { get; }
  • public static bool IsWriting { get; }
  • public JsonSchemaSerialization()
  • public static string FromJson(object obj, IContractResolver contractResolver, Formatting formatting)
  • public static T FromJson<T>(string json, IContractResolver contractResolver)
  • public static Task<T> FromJsonAsync<T>(string json, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver)
  • public static string ToJson(object obj, SchemaType schemaType, IContractResolver contractResolver)
  • public static string ToJson(object obj, SchemaType schemaType, IContractResolver contractResolver, Formatting formatting)
• public class PropertyRenameAndIgnoreSerializerContractResolver : DefaultContractResolver
  • public PropertyRenameAndIgnoreSerializerContractResolver()
  • public void IgnoreProperty(Type type, string[] jsonPropertyNames)
  • public void RenameProperty(Type type, string propertyName, string newJsonPropertyName)
• 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 ClearCacheAsync()
  • 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<XElement> GetXmlDocumentationAsync(this MemberInfo member, string pathToXmlFile)
  • public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member)
  • public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member, string pathToXmlFile)
  • public static string GetXmlDocumentationText(this XElement element)
• public static class XmlObjectExtension
  • public static void GenerateXmlObjectForArrayType(this JsonSchema4 schema, Type type)

NJsonSchema.References

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

NJsonSchema.Validation

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

NJsonSchema.Validation.FormatValidators

• public class Base64FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public Base64FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class ByteFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public ByteFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class DateFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public DateFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class DateTimeFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public DateTimeFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class EmailFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public EmailFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class GuidFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public GuidFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class HostnameFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public HostnameFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public interface IFormatValidator
  • string Format { get; }
  • ValidationErrorKind ValidationErrorKind { get; }
  • bool IsValid(string value, JTokenType tokenType)
• public class IpV4FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public IpV4FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class IpV6FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public IpV6FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class TimeFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public TimeFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class TimeSpanFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public TimeSpanFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class UriFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public UriFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)

NJsonSchema.Visitors

• public abstract class JsonReferenceVisitorBase
  • protected JsonReferenceVisitorBase()
  • protected JsonReferenceVisitorBase(IContractResolver contractResolver)
  • public virtual Task VisitAsync(object obj)
  • 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 abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase
  • protected JsonSchemaVisitorBase()
  • protected abstract Task<JsonSchema4> VisitSchemaAsync(JsonSchema4 schema, string path, string typeNameHint)