NJsonSchema 9.7.2

API Differences between 9.7.2 and 9.2.1

97 Additions 17 Removals

NJsonSchema

public interface IJsonExtensionObject
- IDictionary<string, object> ExtensionData { get; set; }
public class JsonReferenceResolver
- 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 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 virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url)
public class JsonSchema4 : JsonReferenceBase<JsonSchema4>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public string DocumentPath { get; set; }
- public IDictionary<string, object> ExtensionData { get; set; }
- public bool HasReference { get; }
- public bool IsArray { get; }
- public bool IsTuple { get; }
- public virtual object Parent { get; set; }
- public JsonSchema4 FindRootParent()
- public virtual bool IsNullable(NullHandling nullHandling)
- public virtual bool IsNullable(SchemaType schemaType)
public enum NullHandling
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, JsonProperty property, Type parentType, IEnumerable<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
- public void ApplyDataAnnotations(JsonSchema4 schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
- protected virtual Task GenerateObjectAsync<TSchemaType>(Type type, JsonContract contract, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
- protected virtual Task GenerateObjectAsync<TSchemaType>(Type type, TSchemaType schema, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema4
- 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 ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
- public bool GenerateAbstractProperties { get; set; }
- public NullHandling NullHandling { 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 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
- Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) where TSchemaType : JsonSchema4
- Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
public class ObjectTypeMapper : ITypeMapper
- public Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) where TSchemaType : JsonSchema4
- public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
public class PrimitiveTypeMapper : ITypeMapper
- public Task GenerateSchemaAsync<TSchemaType>(TSchemaType schema, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver, IEnumerable<Attribute> parentAttributes) 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 ReflectionExtensions
- public static bool HasProperty(this object obj, string propertyName)
- public static T TryGetPropertyValue<T>(this object obj, string propertyName, T defaultValue = null)

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; }
- public string ReferencePath { get; set; }
- protected JsonReferenceBase()
public static class JsonReferenceExtensions
- public static object FindRootParent(this IJsonReference obj)

NJsonSchema.Validation

public enum ValidationErrorKind
- DateExpected = 19
- TimeExpected = 20
- TimeSpanExpected = 21