NJsonSchema 9.8.3

API Differences between 9.8.3 and 7.0.6201.32793

149 Additions 29 Removals

NJsonSchema

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 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 Integer = "int32"
public static class JsonPathUtilities
- public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
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 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 DocumentPath { get; set; }
- public bool HasAllOfSchemaReference { get; }
- public bool HasReference { get; }
- public IReadOnlyCollection<JsonSchema4> InheritedSchemas { get; }
- public JsonSchema4 InheritedSchema { get; }
- public bool IsArray { get; }
- public bool IsTuple { get; }
- public virtual object Parent { get; set; }
- public JsonXmlObject Xml { get; set; }
- 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 static class JsonSchemaReferenceUtilities
- public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences)
public enum NullHandling
public abstract class JsonSchemaVisitor
- protected JsonSchemaVisitor()
- public virtual Task VisitAsync(object obj)
- protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
- protected virtual Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint)
- protected virtual Task<JsonSchema4> VisitSchemaAsync(JsonSchema4 schema, string path, string typeNameHint)
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 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 NotNullAttribute : Attribute
- public NotNullAttribute()

NJsonSchema.Converters

public class JsonInheritanceConverter : JsonConverter
- public JsonInheritanceConverter(string discriminator, bool readTypeProperty)

NJsonSchema.Generation

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 IsDictionaryType(Type type, IEnumerable<Attribute> parentAttributes)
- protected virtual bool IsFileType(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)
- 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 class JsonSchemaGeneratorSettings
- public IContractResolver ActualContractResolver { get; }
- public IContractResolver ContractResolver { get; set; }
- public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
- public bool GenerateAbstractProperties { get; set; }
- public NullHandling NullHandling { get; set; }
- public bool GenerateXmlObjects { get; set; }
- public bool IgnoreObsoleteProperties { get; set; }
- public IReflectionService ReflectionService { get; set; }
- public IList<ISchemaProcessor> SchemaProcessors { get; }
- public SchemaType SchemaType { get; set; }
- 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 Type Type { get; }
- public SchemaProcessorContext(Type type, JsonSchema4 schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator)

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 static class DynamicApis
- public static string XPathEvaluate(XDocument document, string path)
- public static object XPathEvaluate(XDocument document, string path)
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, string tagName)
- public static Task<string> GetXmlDocumentationAsync(this MemberInfo member)
- public static Task<string> GetXmlDocumentationAsync(this MemberInfo member, string tagName)
- public static Task<XElement> GetXmlDocumentationAsync(this MemberInfo member)
- public static Task<string> GetXmlDocumentationAsync(this Type type, string pathToXmlFile, string tagName)
- public static Task<string> GetXmlDocumentationAsync(this MemberInfo member, string pathToXmlFile, string tagName)
- public static Task<string> GetXmlDocumentationAsync(this ParameterInfo parameter, string pathToXmlFile)
- 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 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.References

public interface IJsonReference : IJsonReferenceBase
- IJsonReference ActualObject { get; }
- object PossibleRoot { get; }
public interface IJsonReferenceBase
- string DocumentPath { get; set; }
- IJsonReference Reference { get; set; }
- string ReferencePath { get; set; }
public abstract class JsonReferenceBase<T> : IJsonReferenceBase 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 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
- TimeExpected = 20
- TimeSpanExpected = 21