NJsonSchema 9.0.0

API Differences between 9.0.0 and 2.56.6036.39820

184 Additions 44 Removals

NJsonSchema

public class ConversionUtilities
- public ConversionUtilities()
- public static string ConvertCSharpDocBreaks(string input, int tabCount)
- public static string ConvertToCamelCase(string input)
- public static string ConvertToLowerCamelCase(string input, bool firstCharacterMustBeAlpha)
- public static string ConvertToStringLiteral(string input)
- public static string ConvertToUpperCamelCase(string input, bool firstCharacterMustBeAlpha)
- public static string RemoveLineBreaks(string text)
- public static string Tab(string input, int tabCount)
- public static string TrimWhiteSpaces(string text)
public class DefaultSchemaNameGenerator : ISchemaNameGenerator
- public DefaultSchemaNameGenerator()
- public virtual string Generate(Type type)
public class DefaultTypeNameGenerator : ITypeNameGenerator
- public DefaultTypeNameGenerator()
- public virtual string Generate(JsonSchema4 schema, string typeNameHint, ICollection<string> reservedTypeNames)
- protected virtual string Generate(JsonSchema4 schema, string typeNameHint)
public interface IDocumentPathProvider
- string DocumentPath { get; }
public interface ISchemaDefinitionAppender
public interface ISchemaResolver
public interface ISchemaNameGenerator
- string Generate(Type type)
public interface ITypeNameGenerator
- string Generate(JsonSchema4 schema)
- string Generate(JsonSchema4 schema, string typeNameHint, ICollection<string> reservedTypeNames)
public class JsonExceptionConverter : JsonConverter
public static class JsonFormatStrings
- public const string Date = "date"
- public const string Integer = "int32"
- public const string Phone = "phone"
- public const string Time = "time"
- public const string Uuid = "uuid"
public class JsonObjectTypeDescription
public static class JsonPathUtilities
- 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 static string GetJsonPath(object rootObject, object searchedObject)
public class JsonReferenceResolver
- public JsonReferenceResolver(JsonSchemaResolver schemaResolver)
- 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 class JsonSchema4 : IDocumentPathProvider
- public IDictionary<string, JsonProperty> ActualProperties { get; }
- public ICollection<JsonSchema4> AllInheritedSchemas { get; }
- public IReadOnlyDictionary<string, JsonProperty> AllProperties { get; }
- public string DocumentPath { get; set; }
- public bool HasAllOfSchemaReference { get; }
- public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
- public JsonSchema4 InheritedSchema { get; }
- public double? Maximum { get; set; }
- public decimal? Maximum { get; set; }
- public double? Minimum { get; set; }
- public decimal? Minimum { get; set; }
- public double? MultipleOf { get; set; }
- public decimal? MultipleOf { get; set; }
- public IDictionary<string, JsonProperty> PatternProperties { get; }
- public IDictionary<string, JsonSchema4> PatternProperties { get; }
- public string TypeNameRaw { get; set; }
- public JsonXmlObject Xml { get; set; }
- 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 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 string GetTypeName(ITypeNameGenerator typeNameGenerator)
- public bool InheritsSchema(JsonSchema4 parentSchema)
- public string ToJson(ITypeNameGenerator typeNameGenerator)
- public string ToJson(JsonSchemaGeneratorSettings settings)
public class JsonSchemaDefinitionAppender : ISchemaDefinitionAppender
public static class JsonSchemaReferenceUtilities
- public static void UpdateSchemaReferencePaths(object root, ISchemaDefinitionAppender schemaDefinitionAppender)
- public static void UpdateSchemaReferences(object root)
- public static void UpdateSchemaReferencePaths(object rootObject)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
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 bool Attribute { get; }
- public string Name { get; }
- public string Namespace { get; }
- public JsonSchema4 ParentSchema { get; }
- public string Prefix { get; }
- public bool Wrapped { get; }
- public JsonXmlObject()
public enum PropertyNameHandling
- SnakeCase = 2
public class SchemaResolver : ISchemaResolver

NJsonSchema.Annotations

public class JsonSchemaAttribute : Attribute
- public string Name { get; set; }
- public JsonSchemaAttribute(string name)
public class MultipleOfAttribute : Attribute
- public double MultipleOf { get; }
- public decimal MultipleOf { get; }
- public MultipleOfAttribute(decimal multipleOf)

NJsonSchema.Generation

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 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 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, JsonObjectContract objectContract, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
public class JsonSchemaGeneratorSettings
- public IContractResolver ActualContractResolver { get; }
- public IContractResolver ContractResolver { get; set; }
- public bool GenerateXmlObjects { get; set; }
- public ISchemaNameGenerator SchemaNameGenerator { get; set; }
- public ICollection<ITypeMapper> TypeMappers { get; set; }

NJsonSchema.Generation.TypeMappers

public interface ITypeMapper
- Type MappedType { get; }
- bool UseReference { get; }
- Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) where TSchemaType : JsonSchema4
public class ObjectTypeMapper : ITypeMapper
- public Type MappedType { get; }
- public bool UseReference { get; }
- 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 Type MappedType { get; }
- public bool UseReference { get; }
- public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema4> transformer)
- public Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) where TSchemaType : JsonSchema4

NJsonSchema.Infrastructure

public static class DynamicApis
- public static bool SupportsDirectoryApis { get; }
- public static bool SupportsFileApis { get; }
- public static bool SupportsHttpClientApis { get; }
- public static bool SupportsPathApis { get; }
- public static bool SupportsXPathApis { get; }
- 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 static Task<string> HttpGetAsync(string url)
- public static string PathCombine(string path1, string path2)
- public static string PathGetDirectoryName(string filePath)
- public static object XPathEvaluate(XDocument document, string path)
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 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 Task<string> GetDescriptionAsync(this MemberInfo memberInfo, IEnumerable<Attribute> attributes)
- 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 MemberInfo member, string tagName)
- public static Task<string> GetXmlRemarksAsync(this MemberInfo member)
- public static Task<string> GetXmlSummaryAsync(this MemberInfo member)
public static class XmlObjectExtension
- 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)

NJsonSchema.Validation

public class ChildSchemaValidationError : ValidationError
- public IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema4, ICollection<ValidationError>> errors)
- public IDictionary<JsonSchema4, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IDictionary<JsonSchema4, ICollection<ValidationError>> errors, JToken token, JsonSchema4 schema)
public class JsonSchemaValidator
- public JsonSchemaValidator()
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema4 schema)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema4 schema)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema4 schema, string propertyName, string propertyPath)
public class ValidationError
- public bool HasLineInfo { get; }
- public int LineNumber { get; }
- public int LinePosition { get; }
- public ValidationError(ValidationErrorKind kind, string property, string path)
- public JsonSchema4 Schema { get; }
- public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema4 schema)