NJsonSchema 10.4.3

API Differences between 10.4.3 and 11.0.0-preview003

66 Additions 58 Removals

NJsonSchema

public class ConversionUtilities
- public static void Tab(string input, int tabCount, TextWriter writer)
public static class JsonFormatStrings
- public const string Duration = "duration"
- public const string ULong = "uint64"
public static class JsonPathUtilities
- public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects, IContractResolver contractResolver)
- public static IDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects, IContractResolver contractResolver)
public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public IReadOnlyDictionary<string, JsonSchemaProperty> ActualProperties { get; }
- public IDictionary<string, JsonSchemaProperty> ActualProperties { get; }
- public IReadOnlyCollection<JsonSchema> AllInheritedSchemas { get; }
- public ICollection<JsonSchema> AllInheritedSchemas { get; }
- public bool HasActualProperties { get; }
- public static Task<JsonSchema> FromJsonAsync(Stream stream, CancellationToken cancellationToken = default)
- public static Task<JsonSchema> FromJsonAsync(Stream stream, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(string jsonData, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(string jsonData, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
public static class JsonSchemaReferenceUtilities
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, CancellationToken cancellationToken = default)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
public class SampleJsonDataGeneratorSettings
public class SampleJsonSchemaGenerator

NJsonSchema.Annotations

public interface IJsonSchemaExtensionDataAttribute
- IReadOnlyDictionary<string, object> ExtensionData { get; }
- string Key { get; }
- object Value { get; }
public class JsonSchemaExtensionDataAttribute : Attribute, IJsonSchemaExtensionDataAttribute
- public IReadOnlyDictionary<string, object> ExtensionData { get; }

NJsonSchema.Converters

public class JsonInheritanceConverter<TBase> : JsonConverter<TBase>
public class JsonInheritanceConverterAttribute : JsonConverterAttribute
public class JsonInheritanceConverter : JsonConverter
- public static string DefaultDiscriminatorName { get; }
- public virtual string DiscriminatorName { get; }
- public JsonInheritanceConverter()
- public JsonInheritanceConverter(string discriminator)
- 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
- public JsonReferenceConverter()

NJsonSchema.Generation

public class DefaultReflectionService : IReflectionService
- public DefaultReflectionService()
- public JsonTypeDescription GetDescription(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
- public virtual JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings)
- protected virtual bool IsArrayType(ContextualType contextualType)
- protected virtual bool IsBinary(ContextualType contextualType)
- protected virtual bool IsDictionaryType(ContextualType contextualType)
- public virtual bool IsNullable(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
- public virtual bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
public enum EnumHandling
- CamelCaseString = 2
- Integer = 0
- String = 1
public interface IReflectionService
- string ConvertEnumValue(object value, JsonSchemaGeneratorSettings settings)
- void GenerateProperties(JsonSchema schema, ContextualType contextualType, JsonSchemaGeneratorSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
- string GetPropertyName(ContextualAccessorInfo accessorInfo, JsonSchemaGeneratorSettings settings)
- bool IsStringEnum(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
- bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
public interface IXmlDocsSettings
public class JsonSchemaGenerator
- public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
- public void AddProperty(JsonSchema parentSchema, ContextualAccessorInfo property, JsonTypeDescription propertyTypeDescription, string propertyName, Attribute requiredAttribute, bool hasRequiredAttribute, bool isNullable, object defaultValue, JsonSchemaResolver schemaResolver)
- public virtual object GenerateExample(ContextualAccessorInfo accessorInfo)
- public object GetDataMemberAttribute(ContextualAccessorInfo accessorInfo, Type parentType)
- public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
- public bool IsAbstractProperty(ContextualMemberInfo memberInfo)
- public virtual bool IsPropertyIgnored(ContextualAccessorInfo accessorInfo, Type parentType)
- public bool IsPropertyIgnoredBySettings(ContextualAccessorInfo accessorInfo)
- protected virtual bool IsPropertyIgnored(ContextualMemberInfo property, Type parentType)
public class JsonSchemaGeneratorSettings
- public IContractResolver ActualContractResolver { get; }
- public JsonSerializerSettings ActualSerializerSettings { get; }
- public IContractResolver ContractResolver { get; set; }
- public EnumHandling DefaultEnumHandling { get; set; }
- public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
- public bool ResolveExternalXmlDocumentation { get; set; }
- public object SerializerOptions { get; set; }
- public JsonSerializerSettings SerializerSettings { get; set; }
- public bool UseXmlDocumentation { get; set; }
- public XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
- public JsonContract ResolveContract(Type type)
public enum PropertyNameHandling
- CamelCase = 1
- Default = 0
- SnakeCase = 2
public abstract class ReflectionServiceBase<TSettings> : IReflectionService where TSettings : JsonSchemaGeneratorSettings
public class SampleJsonDataGenerator
- public SampleJsonDataGenerator(SampleJsonDataGeneratorSettings settings)
public class SampleJsonSchemaGenerator
- public SampleJsonSchemaGenerator()
- public JsonSchema Generate(string json)
public class SchemaProcessorContext
- public ContextualType ContextualType { get; }
- public SchemaProcessorContext(ContextualType contextualType, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
- public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
public class SystemTextJsonReflectionService : ReflectionServiceBase<SystemTextJsonSchemaGeneratorSettings>
public class SystemTextJsonSchemaGeneratorSettings : JsonSchemaGeneratorSettings
public static class SystemTextJsonUtilities
- public static JsonSerializerSettings ConvertJsonOptionsToNewtonsoftSettings(object serializerOptions)
public static class XmlDocsSettingsExtensions

NJsonSchema.Infrastructure

public enum DescriptionAttributeType
- Context = 0
- Type = 1
public class JsonSchemaSerialization
- public static T FromJson<T>(Stream stream, IContractResolver contractResolver)
- public static Task<T> FromJsonAsync<T>(Stream stream, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver, CancellationToken cancellationToken = default)
public static class TypeExtensions
- public static string GetDescription(this CachedType type, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualAccessorInfo accessorInfo, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualParameterInfo parameter, IXmlDocsSettings xmlDocsSettings)
- public static string GetName(this ContextualAccessorInfo accessorInfo)
- public static string GetDescription(this CachedType type, DescriptionAttributeType attributeType = 0)
- public static string GetDescription(this ContextualParameterInfo parameter)

NJsonSchema.Validation

public class ChildSchemaValidationError : ValidationError
- public IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonSchema, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
- public IDictionary<JsonSchema, ICollection<ValidationError>> Errors { get; }
- public ChildSchemaValidationError(ValidationErrorKind kind, string property, string path, IDictionary<JsonSchema, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
public class JsonSchemaValidator
- public JsonSchemaValidator(JsonSchemaValidatorSettings settings)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema schema, SchemaType schemaType = 0)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema schema, SchemaType schemaType = 0)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema schema, SchemaType schemaType, string propertyName, string propertyPath)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchema schema)
- public ICollection<ValidationError> Validate(JToken token, JsonSchema schema)
- protected virtual ICollection<ValidationError> Validate(JToken token, JsonSchema schema, string propertyName, string propertyPath)
public class JsonSchemaValidatorSettings
public class MultiTypeValidationError : ValidationError
- public IReadOnlyDictionary<JsonObjectType, ICollection<ValidationError>> Errors { get; }
- public MultiTypeValidationError(ValidationErrorKind kind, string property, string path, IReadOnlyDictionary<JsonObjectType, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)
- public IDictionary<JsonObjectType, ICollection<ValidationError>> Errors { get; }
- public MultiTypeValidationError(ValidationErrorKind kind, string property, string path, IDictionary<JsonObjectType, ICollection<ValidationError>> errors, JToken token, JsonSchema schema)