NJsonSchema 9.1.13

API Differences between 9.1.13 and 10.0.8

203 Additions 153 Removals

NJsonSchema

public class ConversionUtilities
- public static string ConvertCSharpDocs(string input, int tabCount)
- public static string ConvertCSharpDocBreaks(string input, int tabCount)
- public static string Singularize(string word)
public class DefaultSchemaNameGenerator : ISchemaNameGenerator
- public DefaultSchemaNameGenerator()
- public virtual string Generate(Type type)
public class DefaultTypeNameGenerator : ITypeNameGenerator
- public virtual string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- protected virtual string Generate(JsonSchema schema, string typeNameHint)
- public virtual string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- protected virtual string Generate(JsonSchema4 schema, string typeNameHint)
public enum EnumHandling
- Integer = 0
- String = 1
public interface IJsonExtensionObject
public interface ISchemaNameGenerator
- string Generate(Type type)
public interface ITypeNameGenerator
- string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
- string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
public class JsonExtensionObject : IJsonExtensionObject
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 static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
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(JsonSchemaResolver schemaResolver)
- public void AddDocumentReference(string documentPath, JsonSchema4 schema)
- public virtual JsonSchema4 ResolveDocumentReference(object rootObject, string jsonPath)
- public virtual Task<JsonSchema4> ResolveFileReferenceAsync(string filePath)
- public Task<JsonSchema4> ResolveReferenceAsync(object rootObject, string jsonPath)
- public virtual Task<JsonSchema4> ResolveUrlReferenceAsync(string url)
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 HasAllOfSchemaReference { get; }
- public bool HasSchemaReference { get; }
- public string Id { get; set; }
- public JsonSchema4 InheritedSchema { 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 JsonSchema4 SchemaReference { get; set; }
- public string SchemaVersion { get; set; }
- public string Title { get; set; }
- public JsonObjectType Type { get; set; }
- public bool UniqueItems { get; set; }
- public JsonXmlObject Xml { get; set; }
- public JsonSchema4()
- public static JsonSchema4 CreateAnySchema()
- public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema4
- public static JsonSchema4 FromData(string data)
- 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 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 JsonSchema4 FindRootParent()
- public bool Inherits(JsonSchema4 schema)
- public bool InheritsSchema(JsonSchema4 parentSchema)
- public virtual bool IsNullable(NullHandling nullHandling)
- public string ToJson()
- public string ToJson(JsonSchemaGeneratorSettings settings)
- public ICollection<ValidationError> Validate(string jsonData)
- public ICollection<ValidationError> Validate(JToken token)
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 class JsonSchemaResolver
- public object RootObject { get; }
- public IEnumerable<JsonSchema4> Schemas { get; }
- public JsonSchemaResolver(object rootObject, JsonSchemaGeneratorSettings settings)
- public virtual void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema4 schema)
- public virtual void AppendSchema(JsonSchema4 schema, string typeNameHint)
- public JsonSchema4 GetSchema(Type type, bool isIntegerEnumeration)
- public bool HasSchema(Type type, bool isIntegerEnumeration)
public class JsonXmlObject
- public JsonSchema ParentSchema { get; }
- public JsonSchema4 ParentSchema { get; }
public class OpenApiDiscriminator
public enum SchemaType
public enum NullHandling
- JsonSchema = 0
- Swagger = 1
public enum PropertyNameHandling
- CamelCase = 1
- Default = 0
- SnakeCase = 2

NJsonSchema.Annotations

public class CanBeNullAttribute : Attribute
public class ItemsCanBeNullAttribute : Attribute
public class JsonSchemaAbstractAttribute : Attribute
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 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 DataToJsonSchemaGenerator
- public DataToJsonSchemaGenerator()
- public JsonSchema4 Generate(string json)
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, JsonContract contract, IEnumerable<Attribute> parentAttributes, EnumHandling defaultEnumHandling)
- public static bool IsStringEnum(Type classType, IEnumerable<Attribute> propertyAttributes, EnumHandling defaultEnumHandling)
- public void ApplyType(JsonSchema4 schema)
public static class JsonReflectionUtilities
- public static string GetPropertyName(MemberInfo property, PropertyNameHandling propertyNameHandling)
public class JsonSchemaGenerator
- public virtual void ApplyDataAnnotations(JsonSchema schema, ContextualType contextualType, 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, ContextualType contextualType, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual void GenerateDictionary<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
- protected virtual void GenerateEnum(JsonSchema schema, CachedType type, JsonTypeDescription typeDescription)
- protected virtual void GenerateObject(JsonSchema schema, Type type, 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, JsonProperty property, Type parentType, IEnumerable<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
- 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, JsonContract contract, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
public class JsonSchemaGeneratorSettings
- public JsonSerializerSettings ActualSerializerSettings { get; }
- public bool AllowReferencesWithProperties { 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 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 ISchemaNameGenerator SchemaNameGenerator { 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)
- Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) 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, JsonSchemaResolver, JsonSchema4> schemaFactory)
- public Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) 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 Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) 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 static void DirectoryCreateDirectory(string directory)
- public static bool DirectoryExists(string filePath)
- public static string DirectoryGetCurrentDirectory()
- public static string[] DirectoryGetFiles(string directory, string filter)
- public static bool FileExists(string filePath)
- public static string FileReadAllText(string filePath)
- public static void FileWriteAllText(string filePath, string text)
- public static string GetFullPath(string path)
- public static Task DirectoryCreateDirectoryAsync(string directory)
- public static Task<bool> DirectoryExistsAsync(string filePath)
- public static Task<string> DirectoryGetCurrentDirectoryAsync()
- public static Task<string[]> DirectoryGetFilesAsync(string directory, string filter)
- public static Task<bool> FileExistsAsync(string filePath)
- public static Task<string> FileReadAllTextAsync(string filePath)
- public static Task FileWriteAllTextAsync(string filePath, string text)
public class JsonSchemaSerialization
public class PropertyRenameAndIgnoreSerializerContractResolver : DefaultContractResolver
public static class TypeExtensions
public static class ReflectionCache
- public class CustomAttributes
- public class PropertyOrField
- public static Attribute GetDataContractAttribute(Type type)
- public static IEnumerable<PropertyOrField> GetPropertiesAndFields(Type type)
public static class ReflectionExtensions
- public static Type FindCommonBaseType(this IEnumerable<Type> types)
- 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 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 class XmlObjectExtension
- public static void GenerateXmlObjectForArrayType(this JsonSchema schema)
- public static void GenerateXmlObjectForItemType(this JsonSchema schema, CachedType type)
- public static void GenerateXmlObjectForProperty(this JsonSchemaProperty propertySchema, ContextualType type, string propertyName)
- public static void GenerateXmlObjectForType(this JsonSchema schema, Type type)
- public static void GenerateXmlObjectForItemType(this JsonSchema4 schema, Type type)
- public static void GenerateXmlObjectForProperty(this JsonProperty propertySchema, Type type, string propertyName, IEnumerable<Attribute> attributes)
- public static void GenerateXmlObjectForType(this JsonSchema4 schema, Type type)

API Differences between 9.1.13 and 10.0.8

NJsonSchema

NJsonSchema.Annotations

NJsonSchema.Converters

NJsonSchema.Generation

NJsonSchema.Generation.SchemaProcessors

NJsonSchema.Generation.TypeMappers

NJsonSchema.Infrastructure

NJsonSchema.References

NJsonSchema.Validation

NJsonSchema.Validation.FormatValidators

NJsonSchema.Visitors