NJsonSchema 9.5.1 - API Reference

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

API Differences between 9.5.1 and 7.10.6235.25398

49 Additions 12 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 ITypeNameGenerator
- string Generate(JsonSchema4 schema, string typeNameHint, ICollection<string> reservedTypeNames)
- string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
public class JsonExtensionObject
- public IDictionary<string, object> ExtensionData { get; set; }
- public JsonExtensionObject()
public static class JsonPathUtilities
- public static IDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
public class JsonSchema4 : JsonExtensionObject, IDocumentPathProvider
- public IDictionary<string, object> ExtensionData { get; set; }
- public bool HasAllOfSchemaReference { get; }
- public ICollection<JsonSchema4> InheritedSchemas { get; }
- public JsonSchema4 InheritedSchema { get; }
- public bool InheritsSchema(JsonSchema4 parentSchema)
public enum PropertyNameHandling
- SnakeCase = 2

NJsonSchema.Annotations

public class NotNullAttribute : Attribute
- public NotNullAttribute()

NJsonSchema.Converters

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

NJsonSchema.Generation

public interface ISchemaProcessor
- Task ProcessAsync(SchemaProcessorContext context)
public class JsonObjectTypeDescription
- public static JsonObjectTypeDescription FromType(Type type, IEnumerable<Attribute> parentAttributes, EnumHandling defaultEnumHandling)
- public static JsonObjectTypeDescription FromType(Type type, JsonContract contract, IEnumerable<Attribute> parentAttributes, EnumHandling defaultEnumHandling)
public class JsonSchemaGenerator
- public void ApplyPropertyAnnotations(JsonSchema4 jsonProperty, Type parentType, IList<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
- public void ApplyPropertyAnnotations(JsonSchema4 jsonProperty, JsonProperty property, Type parentType, IEnumerable<Attribute> attributes, JsonObjectTypeDescription propertyTypeDescription)
- protected virtual Task GenerateObjectAsync<TSchemaType>(Type type, 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 IContractResolver ActualContractResolver { get; }
- public IContractResolver ContractResolver { get; set; }
- public bool GenerateAbstractProperties { get; set; }
- public bool IgnoreObsoleteProperties { get; set; }
- public IList<ISchemaProcessor> SchemaProcessors { get; }
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 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 ReflectionExtensions
- public static Type FindCommonBaseType(this IEnumerable<Type> types)
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)

NJsonSchema.Validation

public class ChildSchemaValidationError : ValidationError
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IDictionary<JsonSchema4, ICollection<ValidationError>> errors, JToken token)
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IDictionary<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