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

---

API Differences between 5.4.6138.24413 and 10.0.20

167 Additions 156 Removals

NJsonSchema

• public class ConversionUtilities
• public class DefaultTypeNameGenerator : ITypeNameGenerator
• public enum EnumHandling
  • Integer = 0
  • String = 1
• public interface IJsonExtensionObject
• 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(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • string Generate(JsonSchema4 schema, string typeNameHint)
• public class JsonExtensionObject : IJsonExtensionObject
• public static class JsonFormatStrings
  • public const string Binary = "binary"
  • public const string Float = "float"
  • 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 const string ReferenceReplaceString = "__referencePath"
  • 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 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 bool IsRequired { get; set; }
  • public string Name { get; }
  • public JsonProperty()
• public class JsonReferenceResolver
  • public JsonReferenceResolver(JsonSchemaAppender schemaAppender)
  • public static Func<JsonSchema, JsonReferenceResolver> CreateJsonReferenceResolverFactory(ITypeNameGenerator typeNameGenerator)
  • 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 JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
• public class JsonSchemaAppender
• public class JsonSchemaProperty : JsonSchema
• public class JsonSchema4 : IDocumentPathProvider
  • public static string ToolchainVersion { get; }
  • public IReadOnlyDictionary<string, JsonProperty> ActualProperties { get; }
  • public virtual JsonSchema4 ActualSchema { get; }
  • public JsonSchema4 AdditionalItemsSchema { get; set; }
  • public JsonSchema4 AdditionalPropertiesSchema { get; set; }
  • public IReadOnlyCollection<JsonSchema4> AllInheritedSchemas { get; }
  • public ICollection<JsonSchema4> AllOf { get; }
  • public bool AllowAdditionalItems { get; set; }
  • public bool AllowAdditionalProperties { get; set; }
  • public ICollection<JsonSchema4> AnyOf { get; }
  • public string BaseDiscriminator { get; }
  • public object Default { get; set; }
  • public IDictionary<string, JsonSchema4> Definitions { get; }
  • public string Description { get; set; }
  • public string Discriminator { get; set; }
  • public string DocumentPath { get; set; }
  • public ICollection<object> Enumeration { get; }
  • public Collection<string> EnumerationNames { get; set; }
  • public Collection<string> EnumerationNamesRaw { get; set; }
  • public IDictionary<string, object> ExtensionData { get; set; }
  • public string Format { get; set; }
  • public bool HasSchemaReference { get; }
  • public string Id { get; set; }
  • public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
  • public bool IsAnyType { get; }
  • public bool IsDictionary { get; }
  • public bool IsEnumeration { get; }
  • public bool IsExclusiveMaximum { get; set; }
  • public bool IsExclusiveMinimum { get; set; }
  • public JsonSchema4 Item { get; set; }
  • public ICollection<JsonSchema4> Items { get; }
  • public decimal? Maximum { get; set; }
  • public int MaxItems { get; set; }
  • public int? MaxLength { get; set; }
  • public int MaxProperties { get; set; }
  • public decimal? Minimum { get; set; }
  • public int MinItems { get; set; }
  • public int? MinLength { get; set; }
  • public int MinProperties { get; set; }
  • public decimal? MultipleOf { get; set; }
  • public JsonSchema4 Not { get; set; }
  • public ICollection<JsonSchema4> OneOf { get; }
  • public virtual JsonSchema4 ParentSchema { get; }
  • public string Pattern { get; set; }
  • public IDictionary<string, JsonSchema4> PatternProperties { get; }
  • public IDictionary<string, JsonProperty> Properties { get; }
  • public ICollection<string> RequiredProperties { get; }
  • public IDictionary<string, JsonSchema4> ResourceDefinitions { get; set; }
  • public JsonSchema4 SchemaReference { get; set; }
  • public string SchemaVersion { get; set; }
  • public string Title { get; set; }
  • public JsonObjectType Type { get; set; }
  • public string TypeNameRaw { get; set; }
  • public bool UniqueItems { get; set; }
  • public JsonSchema4()
  • public static JsonSchema4 CreateAnySchema()
  • public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema4
  • 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, string typeNameHint)
  • public bool Inherits(JsonSchema4 schema)
  • public virtual bool IsNullable(NullHandling nullHandling)
  • public string ToJson()
  • public string ToJson(ITypeNameGenerator typeNameGenerator)
  • public ICollection<ValidationError> Validate(string jsonData)
  • public ICollection<ValidationError> Validate(JToken token)
• 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, 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 static void UpdateSchemaReferences(object root, JsonReferenceResolver jsonReferenceResolver)
• public class JsonXmlObject
• public class OpenApiDiscriminator
• public enum SchemaType
• public enum NullHandling
  • JsonSchema = 0
  • Swagger = 1
• public enum PropertyNameHandling
  • CamelCase = 1
  • Default = 0
• 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 ItemsCanBeNullAttribute : Attribute
• public class JsonSchemaAbstractAttribute : Attribute
• public class JsonSchemaAttribute : Attribute
  • public string Name { get; set; }
  • public JsonSchemaAttribute(string name)
• public class JsonSchemaDateAttribute : JsonSchemaAttribute
• public class JsonSchemaExtensionDataAttribute : Attribute
  • public string Key { get; }
  • public string Property { get; }
• public class JsonSchemaFlattenAttribute : Attribute
• public class JsonSchemaIgnoreAttribute : Attribute
• public class JsonSchemaPatternPropertiesAttribute : Attribute
• public class JsonSchemaProcessorAttribute : Attribute
• public class JsonSchemaTypeAttribute : Attribute
• public class NotNullAttribute : Attribute

NJsonSchema.Converters

• public class JsonExceptionConverter : JsonConverter
• public class JsonInheritanceConverter : JsonConverter
  • public static string DefaultDiscriminatorName { get; }
  • 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 class DefaultSchemaNameGenerator : ISchemaNameGenerator
• public enum EnumHandling
• public interface IReflectionService
• public interface ISchemaNameGenerator
• public interface ISchemaProcessor
• public class JsonSchemaGenerator
  • public virtual void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription)
  • public virtual object ConvertDefaultValue(ContextualType type, object defaultValue)
  • public JsonSchema Generate(Type type)
  • public JsonSchema Generate(Type type, JsonSchemaResolver schemaResolver)
  • public TSchemaType Generate<TSchemaType>(Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public JsonSchema Generate(ContextualType contextualType, JsonSchemaResolver schemaResolver)
  • public TSchemaType Generate<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public void Generate<TSchemaType>(TSchemaType schema, Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public virtual void Generate<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateArray<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateDictionary<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateEnum(JsonSchema schema, JsonTypeDescription typeDescription)
  • public virtual object GenerateExample(ContextualType type)
  • protected virtual void GenerateObject(JsonSchema schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver)
  • public TSchemaType GenerateWithReference<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public virtual TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, bool isNullable, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
  • 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 JsonSerializerSettings ActualSerializerSettings { get; }
  • public bool AllowReferencesWithProperties { get; set; }
  • public bool AlwaysAllowAdditionalObjectProperties { get; set; }
  • public IContractResolver ContractResolver { get; set; }
  • public ReferenceTypeNullHandling DefaultDictionaryValueReferenceTypeNullHandling { get; set; }
  • public EnumHandling DefaultEnumHandling { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
  • public string[] ExcludedTypeNames { get; set; }
  • public EnumHandling DefaultEnumHandling { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public bool GenerateAbstractProperties { get; set; }
  • public bool GenerateAbstractSchemas { get; set; }
  • public bool GenerateCustomNullableProperties { get; set; }
  • public bool GenerateEnumMappingDescription { get; set; }
  • public bool GenerateExamples { 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 JsonSerializerSettings SerializerSettings { get; set; }
  • public NullHandling NullHandling { get; set; }
  • public bool GetActualFlattenInheritanceHierarchy(Type type)
  • public bool GetActualGenerateAbstractSchema(Type type)
  • public JsonContract ResolveContract(Type type)
• public class JsonSchemaResolver : JsonSchemaAppender
• public class JsonTypeDescription
• public enum PropertyNameHandling
• public enum ReferenceTypeNullHandling
• public class SampleJsonSchemaGenerator
• public class SchemaProcessorContext

NJsonSchema.Generation.SchemaProcessors

• public class DiscriminatorSchemaProcessor : ISchemaProcessor

NJsonSchema.Generation.TypeMappers

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

NJsonSchema.Infrastructure

• public class CollectionProxy<TInterface, TImplementation> : ICollection<TInterface>, IEnumerable<TInterface>, IEnumerable where TImplementation : TInterface
• public enum DescriptionAttributeType
• public static class DynamicApis
• public class JsonSchemaSerialization
• public class PropertyRenameAndIgnoreSerializerContractResolver : DefaultContractResolver
• public static class TypeExtensions
• public static class XmlObjectExtension
• 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.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 IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> Errors { get; }
  • public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
  • public IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> Errors { get; }
  • 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 JsonSchema Schema { get; }
  • public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema schema)
  • public ValidationError(ValidationErrorKind kind, string property, string path)
• public enum ValidationErrorKind
  • DateExpected = 19
  • NoTypeValidates = 43
  • TimeExpected = 20
  • TimeSpanExpected = 21

NJsonSchema.Validation.FormatValidators

• public class Base64FormatValidator : IFormatValidator
• public class ByteFormatValidator : IFormatValidator
• public class DateFormatValidator : IFormatValidator
• public class DateTimeFormatValidator : IFormatValidator
• public class EmailFormatValidator : IFormatValidator
• public class GuidFormatValidator : IFormatValidator
• public class HostnameFormatValidator : IFormatValidator
• public interface IFormatValidator
• public class IpV4FormatValidator : IFormatValidator
• public class IpV6FormatValidator : IFormatValidator
• public class TimeFormatValidator : IFormatValidator
• public class TimeSpanFormatValidator : IFormatValidator
• public class UriFormatValidator : IFormatValidator

NJsonSchema.Visitors

• public abstract class AsyncJsonReferenceVisitorBase
• public abstract class AsyncJsonSchemaVisitorBase : AsyncJsonReferenceVisitorBase
• public abstract class JsonReferenceVisitorBase
• public abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase