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

---

API Differences between 10.4.6 and 9.10.7

422 Additions 94 Removals

NJsonSchema

• public class ConversionUtilities
  • public static string ConvertCSharpDocBreaks(string input, int tabCount)
  • public static string ConvertCSharpDocs(string input, int tabCount)
  • public static string Singularize(string word)
• public class DefaultSchemaNameGenerator : ISchemaNameGenerator
• public class DefaultTypeNameGenerator : ITypeNameGenerator
  • public virtual string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • protected virtual string Generate(JsonSchema4 schema, string typeNameHint)
  • public virtual string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • protected virtual string Generate(JsonSchema schema, string typeNameHint)
• public enum EnumHandling
• public interface ISchemaNameGenerator
• public interface ITypeNameGenerator
  • string Generate(JsonSchema4 schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
  • string Generate(JsonSchema schema, string typeNameHint, IEnumerable<string> reservedTypeNames)
• public static class JsonFormatStrings
  • public const string Binary = "binary"
  • public const string Float = "float"
• public static class JsonPathUtilities
  • public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects)
  • public static string GetJsonPath(object rootObject, object searchedObject, IContractResolver contractResolver)
  • public static IReadOnlyDictionary<object, string> GetJsonPaths(object rootObject, IEnumerable<object> searchedObjects, IContractResolver contractResolver)
• public class JsonProperty : JsonSchema4
• public class JsonReferenceResolver
  • public JsonReferenceResolver(JsonSchemaResolver schemaResolver)
  • public JsonReferenceResolver(JsonSchemaAppender schemaAppender)
  • public static Func<JsonSchema, JsonReferenceResolver> CreateJsonReferenceResolverFactory(ITypeNameGenerator typeNameGenerator)
  • 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 virtual IJsonReference ResolveDocumentReference(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver)
  • public virtual string ResolveFilePath(string documentPath, string jsonPath)
  • public virtual Task<IJsonReference> ResolveFileReferenceAsync(string filePath, CancellationToken cancellationToken = default)
  • public Task<IJsonReference> ResolveReferenceAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver, CancellationToken cancellationToken = default)
  • public Task<IJsonReference> ResolveReferenceWithoutAppendAsync(object rootObject, string jsonPath, Type targetType, IContractResolver contractResolver, CancellationToken cancellationToken = default)
  • public virtual Task<IJsonReference> ResolveUrlReferenceAsync(string url, CancellationToken cancellationToken = default)
• public class JsonSchema4 : JsonReferenceBase<JsonSchema4>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
• public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
  • public static string ToolchainVersion { get; }
  • public string ActualDiscriminator { get; }
  • public OpenApiDiscriminator ActualDiscriminatorObject { get; }
  • public IReadOnlyDictionary<string, JsonSchemaProperty> ActualProperties { get; }
  • public virtual JsonSchema ActualSchema { get; }
  • public virtual JsonSchema ActualTypeSchema { get; }
  • public JsonSchema AdditionalItemsSchema { get; set; }
  • public JsonSchema AdditionalPropertiesSchema { get; set; }
  • public IReadOnlyCollection<JsonSchema> AllInheritedSchemas { get; }
  • public ICollection<JsonSchema> AllOf { get; }
  • public bool AllowAdditionalItems { get; set; }
  • public bool AllowAdditionalProperties { get; set; }
  • public ICollection<JsonSchema> AnyOf { get; }
  • public object Default { get; set; }
  • public IDictionary<string, JsonSchema> Definitions { get; }
  • public string DeprecatedMessage { get; set; }
  • public virtual string Description { get; set; }
  • public JsonSchema DictionaryKey { get; set; }
  • public string Discriminator { get; set; }
  • public OpenApiDiscriminator DiscriminatorObject { get; set; }
  • public ICollection<object> Enumeration { get; }
  • public Collection<string> EnumerationNames { get; set; }
  • public object Example { get; set; }
  • public decimal? ExclusiveMaximum { get; set; }
  • public decimal? ExclusiveMinimum { get; set; }
  • public IDictionary<string, object> ExtensionData { get; set; }
  • public string Format { get; set; }
  • public bool HasAllOfSchemaReference { get; }
  • public bool HasAnyOfSchemaReference { get; }
  • public bool HasOneOfSchemaReference { get; }
  • public bool HasReference { get; }
  • public bool HasTypeNameTitle { get; }
  • public string Id { get; set; }
  • public JsonSchema InheritedSchema { get; }
  • public JsonSchema InheritedTypeSchema { get; }
  • public bool IsAbstract { get; set; }
  • public bool IsAnyType { get; }
  • public bool IsArray { get; }
  • public bool IsBinary { get; }
  • public bool IsDeprecated { get; set; }
  • public bool IsDictionary { get; }
  • public bool IsEnumeration { get; }
  • public bool IsExclusiveMaximum { get; set; }
  • public bool IsExclusiveMinimum { get; set; }
  • public bool IsFlagEnumerable { get; set; }
  • public bool? IsNullableRaw { get; set; }
  • public bool IsObject { get; }
  • public bool IsTuple { get; }
  • public JsonSchema Item { get; set; }
  • public ICollection<JsonSchema> Items { get; }
  • public decimal? Maximum { get; set; }
  • public int MaxItems { get; set; }
  • public int? MaxLength { get; set; }
  • public int MaxProperties { get; set; }
  • public decimal? Minimum { get; set; }
  • public int MinItems { get; set; }
  • public int? MinLength { get; set; }
  • public int MinProperties { get; set; }
  • public decimal? MultipleOf { get; set; }
  • public JsonSchema Not { get; set; }
  • public ICollection<JsonSchema> OneOf { get; }
  • public virtual object Parent { get; set; }
  • public JsonSchema ParentSchema { get; }
  • public string Pattern { get; set; }
  • public IDictionary<string, JsonSchemaProperty> PatternProperties { get; }
  • public IDictionary<string, JsonSchemaProperty> Properties { get; }
  • public ICollection<string> RequiredProperties { get; }
  • public OpenApiDiscriminator ResponsibleDiscriminatorObject { get; }
  • public string SchemaVersion { get; set; }
  • public string Title { get; set; }
  • public JsonObjectType Type { get; set; }
  • public bool UniqueItems { get; set; }
  • public JsonXmlObject Xml { get; set; }
  • public JsonSchema()
  • public static JsonSchema CreateAnySchema()
  • public static TSchemaType CreateAnySchema<TSchemaType>() where TSchemaType : JsonSchema
  • public static PropertyRenameAndIgnoreSerializerContractResolver CreateJsonSerializerContractResolver(SchemaType schemaType)
  • public static Task<JsonSchema> FromFileAsync(string filePath, CancellationToken cancellationToken = default)
  • public static Task<JsonSchema> FromFileAsync(string filePath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
  • public static Task<JsonSchema> FromJsonAsync(string data, CancellationToken cancellationToken = default)
  • public static Task<JsonSchema> FromJsonAsync(string data, string documentPath, CancellationToken cancellationToken = default)
  • public static Task<JsonSchema> FromJsonAsync(string data, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
  • public static JsonSchema FromSampleJson(string data)
  • public static JsonSchema FromType<TType>()
  • public static JsonSchema FromType(Type type)
  • public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
  • public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
  • public static Task<JsonSchema> FromUrlAsync(string url, CancellationToken cancellationToken = default)
  • public static Task<JsonSchema> FromUrlAsync(string url, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
  • public bool Inherits(JsonSchema schema)
  • public bool InheritsSchema(JsonSchema parentSchema)
  • public virtual bool IsNullable(SchemaType schemaType)
  • public string ToJson()
  • public string ToJson(Formatting formatting)
  • public JToken ToSampleJson()
  • public ICollection<ValidationError> Validate(string jsonData, IFormatValidator[] customValidators)
  • public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
• public class JsonSchemaAppender
  • public object RootObject { get; }
  • protected JsonSchema RootSchema { get; }
  • public JsonSchemaAppender(object rootObject, ITypeNameGenerator typeNameGenerator)
  • public virtual void AppendSchema(JsonSchema schema, string typeNameHint)
• public class JsonSchemaProperty : JsonSchema
  • public bool IsInheritanceDiscriminator { get; }
  • public bool IsReadOnly { get; set; }
  • public bool IsRequired { get; set; }
  • public bool IsWriteOnly { get; set; }
  • public string Name { get; }
  • public JsonSchemaProperty()
• public static class JsonSchemaReferenceUtilities
  • public static string ConvertJsonReferences(string data)
  • public static string ConvertPropertyReferences(string data)
  • public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences)
  • public static void UpdateSchemaReferencePaths(object rootObject, bool removeExternalReferences, IContractResolver contractResolver)
  • public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, IContractResolver contractResolver, CancellationToken cancellationToken = default)
• public class JsonSchemaResolver
• public class JsonXmlObject
  • public JsonSchema4 ParentSchema { get; }
  • public JsonSchema ParentSchema { get; }
• public enum PropertyNameHandling
• public class OpenApiDiscriminator
  • public object JsonInheritanceConverter { get; set; }
  • public IDictionary<string, JsonSchema> Mapping { get; }
  • public string PropertyName { get; set; }
  • public OpenApiDiscriminator()
  • public void AddMapping(Type type, JsonSchema schema)
• public enum ReferenceTypeNullHandling

NJsonSchema.Annotations

• public interface IJsonSchemaExtensionDataAttribute
  • string Key { get; }
  • object Value { get; }
• public class ItemsCanBeNullAttribute : Attribute
  • public ItemsCanBeNullAttribute()
• public class JsonSchemaAbstractAttribute : Attribute
  • public bool IsAbstract { get; }
  • public JsonSchemaAbstractAttribute()
  • public JsonSchemaAbstractAttribute(bool isAbstract)
• public class JsonSchemaExtensionDataAttribute : Attribute, IJsonSchemaExtensionDataAttribute
  • public string Property { get; }
  • public string Key { get; }
• public class JsonSchemaFlattenAttribute : Attribute
  • public bool Flatten { get; }
  • public JsonSchemaFlattenAttribute()
  • public JsonSchemaFlattenAttribute(bool flatten)
• public class JsonSchemaIgnoreAttribute : Attribute
  • public JsonSchemaIgnoreAttribute()
• public class JsonSchemaPatternPropertiesAttribute : Attribute
  • public string RegularExpression { get; }
  • public Type Type { get; }
  • public JsonSchemaPatternPropertiesAttribute(string regularExpression)
  • public JsonSchemaPatternPropertiesAttribute(string regularExpression, Type type)
• public class JsonSchemaProcessorAttribute : Attribute
  • public object[] Parameters { get; set; }
  • public Type Type { get; set; }
  • public JsonSchemaProcessorAttribute(Type type, object[] parameters)
• public class JsonSchemaTypeAttribute : Attribute
  • public bool IsNullable { get; set; }
  • public bool? IsNullableRaw { get; }
  • public Type Type { get; }
  • public JsonSchemaTypeAttribute(Type type)

NJsonSchema.Converters

• public class JsonExceptionConverter : JsonConverter
  • public JsonExceptionConverter()
  • public JsonExceptionConverter(bool hideStackTrace, IDictionary<string, Assembly> searchedNamespaces)
• public class JsonInheritanceAttribute : Attribute
  • public string Key { get; }
  • public Type Type { get; }
  • public JsonInheritanceAttribute(string key, Type type)
• public class JsonInheritanceConverter : JsonConverter
  • public static string DefaultDiscriminatorName { get; }
  • public virtual string DiscriminatorName { get; }
  • 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)

NJsonSchema.Generation

• public class DefaultReflectionService : IReflectionService
  • 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 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 class DefaultSchemaNameGenerator : ISchemaNameGenerator
  • public DefaultSchemaNameGenerator()
  • public virtual string Generate(Type type)
• public enum EnumHandling
  • CamelCaseString = 2
  • Integer = 0
  • String = 1
• public interface IReflectionService
  • JsonTypeDescription GetDescription(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
  • bool IsNullable(Type type, IEnumerable<Attribute> parentAttributes, JsonSchemaGeneratorSettings settings)
  • JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, JsonSchemaGeneratorSettings settings)
  • JsonTypeDescription GetDescription(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
  • bool IsNullable(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
  • bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
• public interface ISchemaNameGenerator
  • string Generate(Type type)
• public interface ISchemaProcessor
  • Task ProcessAsync(SchemaProcessorContext context)
  • void Process(SchemaProcessorContext context)
• public class JsonSchemaGenerator
  • public virtual void ApplyDataAnnotations(JsonSchema4 schema, JsonTypeDescription typeDescription, IEnumerable<Attribute> parentAttributes)
  • 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, 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 virtual void ApplyDataAnnotations(JsonSchema schema, JsonTypeDescription typeDescription)
  • public virtual object ConvertDefaultValue(ContextualType type, object defaultValue)
  • public JsonSchema Generate(Type type)
  • public JsonSchema Generate(Type type, JsonSchemaResolver schemaResolver)
  • public TSchemaType Generate<TSchemaType>(Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public JsonSchema Generate(ContextualType contextualType, JsonSchemaResolver schemaResolver)
  • public TSchemaType Generate<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public void Generate<TSchemaType>(TSchemaType schema, Type type, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • public virtual void Generate<TSchemaType>(TSchemaType schema, ContextualType contextualType, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateArray<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateDictionary<TSchemaType>(TSchemaType schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver) where TSchemaType : JsonSchema
  • protected virtual void GenerateEnum(JsonSchema schema, JsonTypeDescription typeDescription)
  • public virtual object GenerateExample(ContextualType type)
  • protected virtual void GenerateObject(JsonSchema schema, JsonTypeDescription typeDescription, JsonSchemaResolver schemaResolver)
  • public TSchemaType GenerateWithReference<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public virtual TSchemaType GenerateWithReferenceAndNullability<TSchemaType>(ContextualType contextualType, bool isNullable, JsonSchemaResolver schemaResolver, Action<TSchemaType, JsonSchema> transformation = null) where TSchemaType : JsonSchema
  • public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualMemberInfo contextualMember)
  • protected virtual bool IsPropertyIgnored(ContextualMemberInfo property, Type parentType)
• public class JsonSchemaGeneratorSettings
  • public JsonSerializerSettings ActualSerializerSettings { get; }
  • public bool AlwaysAllowAdditionalObjectProperties { get; set; }
  • public EnumHandling DefaultEnumHandling { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
  • public ReferenceTypeNullHandling DefaultDictionaryValueReferenceTypeNullHandling { get; set; }
  • public EnumHandling DefaultEnumHandling { get; set; }
  • public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
  • public ReferenceTypeNullHandling DefaultReferenceTypeNullHandling { get; set; }
  • public string[] ExcludedTypeNames { get; set; }
  • public bool GenerateAbstractSchemas { get; set; }
  • public bool GenerateCustomNullableProperties { get; set; }
  • public bool GenerateEnumMappingDescription { get; set; }
  • public bool GenerateExamples { get; set; }
  • public ISchemaNameGenerator SchemaNameGenerator { get; set; }
  • public IList<ISchemaProcessor> SchemaProcessors { get; }
  • public ISchemaNameGenerator SchemaNameGenerator { get; set; }
  • public ICollection<ISchemaProcessor> SchemaProcessors { get; }
  • public object SerializerOptions { get; set; }
  • public JsonSerializerSettings SerializerSettings { get; set; }
  • public bool GetActualFlattenInheritanceHierarchy(Type type)
  • public bool GetActualGenerateAbstractSchema(Type type)
• public class JsonSchemaResolver : JsonSchemaAppender
  • public IEnumerable<JsonSchema> Schemas { get; }
  • public JsonSchemaResolver(object rootObject, JsonSchemaGeneratorSettings settings)
  • public virtual void AddSchema(Type type, bool isIntegerEnumeration, JsonSchema schema)
  • public JsonSchema GetSchema(Type type, bool isIntegerEnumeration)
  • protected virtual string GetTypeKey(Type type, bool isIntegerEnum)
  • public bool HasSchema(Type type, bool isIntegerEnumeration)
• public class JsonTypeDescription
  • public ContextualType ContextualType { 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 static JsonTypeDescription Create(ContextualType type, JsonObjectType jsonType, bool isNullable, string format)
  • public static JsonTypeDescription CreateForDictionary(ContextualType type, JsonObjectType jsonType, bool isNullable)
  • public static JsonTypeDescription CreateForEnumeration(ContextualType type, JsonObjectType jsonType, bool isNullable)
  • public void ApplyType(JsonSchema schema)
• public enum PropertyNameHandling
  • CamelCase = 1
  • Default = 0
  • SnakeCase = 2
• public enum ReferenceTypeNullHandling
  • NotNull = 1
  • Null = 0
• public class SampleJsonDataGenerator
  • public SampleJsonDataGenerator()
  • public JToken Generate(JsonSchema schema)
• public class SampleJsonSchemaGenerator
  • public JsonSchema4 Generate(string json)
  • public JsonSchema Generate(string json)
• public class SchemaProcessorContext
  • public JsonSchemaResolver Resolver { get; }
  • public JsonSchema4 Schema { get; }
  • public JsonSchemaResolver Resolver { get; }
  • public JsonSchema Schema { get; }
  • public JsonSchemaGeneratorSettings Settings { get; }
  • public SchemaProcessorContext(Type type, JsonSchema4 schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator)
  • public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
• public static class SystemTextJsonUtilities
  • public static JsonSerializerSettings ConvertJsonOptionsToNewtonsoftSettings(object serializerOptions)

NJsonSchema.Generation.SchemaProcessors

• public class DiscriminatorSchemaProcessor : ISchemaProcessor
  • public Type BaseType { get; }
  • public string Discriminator { get; }
  • public DiscriminatorSchemaProcessor(Type baseType)
  • public DiscriminatorSchemaProcessor(Type baseType, string discriminator)
  • public void Process(SchemaProcessorContext context)

NJsonSchema.Generation.TypeMappers

• public interface ITypeMapper
  • Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • void GenerateSchema(JsonSchema schema, TypeMapperContext context)
• public class ObjectTypeMapper : ITypeMapper
  • public ObjectTypeMapper(Type mappedType, JsonSchema4 schema)
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, JsonSchema4> schemaFactory)
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, Task<JsonSchema4>> schemaFactory)
  • public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • public ObjectTypeMapper(Type mappedType, JsonSchema schema)
  • public ObjectTypeMapper(Type mappedType, Func<JsonSchemaGenerator, JsonSchemaResolver, JsonSchema> schemaFactory)
  • public void GenerateSchema(JsonSchema schema, TypeMapperContext context)
• public class PrimitiveTypeMapper : ITypeMapper
  • public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema4> transformer)
  • public Task GenerateSchemaAsync(JsonSchema4 schema, TypeMapperContext context)
  • public PrimitiveTypeMapper(Type mappedType, Action<JsonSchema> transformer)
  • public void GenerateSchema(JsonSchema schema, TypeMapperContext context)
• public class TypeMapperContext
  • public JsonSchemaResolver JsonSchemaResolver { get; }
  • public JsonSchemaResolver JsonSchemaResolver { get; }
  • public TypeMapperContext(Type type, JsonSchemaGenerator jsonSchemaGenerator, JsonSchemaResolver jsonSchemaResolver, IEnumerable<Attribute> parentAttributes)
  • public TypeMapperContext(Type type, JsonSchemaGenerator jsonSchemaGenerator, JsonSchemaResolver jsonSchemaResolver, IEnumerable<Attribute> parentAttributes)

NJsonSchema.Infrastructure

• public class CollectionProxy<TInterface, TImplementation> : ICollection<TInterface>, IEnumerable<TInterface>, IEnumerable where TImplementation : TInterface
  • public int Count { get; }
  • public bool IsReadOnly { get; }
  • public CollectionProxy(ICollection<TImplementation> collection)
  • public void Add(TInterface item)
  • public void Clear()
  • public bool Contains(TInterface item)
  • public void CopyTo(TInterface[] array, int arrayIndex)
  • public IEnumerator<TInterface> GetEnumerator()
  • public bool Remove(TInterface item)
• public enum DescriptionAttributeType
  • Context = 0
  • Type = 1
• public static class DynamicApis
  • 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 void DirectoryCreateDirectory(string directory)
  • public static bool DirectoryExists(string filePath)
  • public static string DirectoryGetCurrentDirectory()
  • public static string[] DirectoryGetDirectories(string directory)
  • public static string[] DirectoryGetFiles(string directory, string filter)
  • public static string DirectoryGetParent(string path)
  • public static bool FileExists(string filePath)
  • public static string FileReadAllText(string filePath)
  • public static void FileWriteAllText(string filePath, string text)
  • public static string GetFullPath(string path)
  • public static string HandleSubdirectoryRelativeReferences(string fullPath, string jsonPath)
  • public static Task<string> HttpGetAsync(string url, CancellationToken cancellationToken)
  • public static string PathGetFileName(string filePath)
• public static class ReflectionCache
• public static class ReflectionExtensions
• public enum TypeNameStyle
• public static class XmlDocumentationExtensions
• public class JsonSchemaSerialization
  • public static SchemaType CurrentSchemaType { get; }
  • public static JsonSerializerSettings CurrentSerializerSettings { get; }
  • public static bool IsWriting { get; }
  • public JsonSchemaSerialization()
  • public static T FromJson<T>(string json, IContractResolver contractResolver)
  • public static Task<T> FromJsonAsync<T>(string json, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver)
  • public static Task<T> FromJsonAsync<T>(string json, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver, CancellationToken cancellationToken = default)
  • public static string ToJson(object obj, SchemaType schemaType, IContractResolver contractResolver, Formatting formatting)
• public class PropertyRenameAndIgnoreSerializerContractResolver : DefaultContractResolver
  • public PropertyRenameAndIgnoreSerializerContractResolver()
  • public void IgnoreProperty(Type type, string[] jsonPropertyNames)
  • public void RenameProperty(Type type, string propertyName, string newJsonPropertyName)
• public static class TypeExtensions
  • public static string GetDescription(this CachedType type, DescriptionAttributeType attributeType = 0)
  • public static string GetDescription(this ContextualParameterInfo parameter)
• 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)
  • public static void GenerateXmlObjectForArrayType(this JsonSchema schema)
  • public static void GenerateXmlObjectForItemType(this JsonSchema schema, CachedType type)
  • public static void GenerateXmlObjectForProperty(this JsonSchemaProperty propertySchema, ContextualType type, string propertyName)
  • public static void GenerateXmlObjectForType(this JsonSchema schema, Type type)

NJsonSchema.References

• public interface IJsonReferenceBase : IDocumentPathProvider
  • string DocumentPath { get; set; }

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, JToken token, JsonSchema4 schema)
  • 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 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 JsonSchemaValidator(IFormatValidator[] customValidators)
  • 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 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 class ValidationError
  • public JsonSchema4 Schema { get; }
  • public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema4 schema)
  • public JsonSchema Schema { get; }
  • public ValidationError(ValidationErrorKind errorKind, string propertyName, string propertyPath, JToken token, JsonSchema schema)
• public enum ValidationErrorKind
  • NoTypeValidates = 43
  • UuidExpected = 44

NJsonSchema.Validation.FormatValidators

• public class Base64FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public Base64FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class ByteFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public ByteFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class DateFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public DateFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class DateTimeFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public DateTimeFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class EmailFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public EmailFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class GuidFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public GuidFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class HostnameFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public HostnameFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public interface IFormatValidator
  • string Format { get; }
  • ValidationErrorKind ValidationErrorKind { get; }
  • bool IsValid(string value, JTokenType tokenType)
• public class IpV4FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public IpV4FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class IpV6FormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public IpV6FormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class TimeFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public TimeFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class TimeSpanFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public TimeSpanFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class UriFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public UriFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)
• public class UuidFormatValidator : IFormatValidator
  • public string Format { get; }
  • public ValidationErrorKind ValidationErrorKind { get; }
  • public UuidFormatValidator()
  • public bool IsValid(string value, JTokenType tokenType)

NJsonSchema.Visitors

• public abstract class AsyncJsonReferenceVisitorBase
  • protected AsyncJsonReferenceVisitorBase()
  • protected AsyncJsonReferenceVisitorBase(IContractResolver contractResolver)
  • public virtual Task VisitAsync(object obj)
  • public virtual Task VisitAsync(object obj, CancellationToken cancellationToken)
  • protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer, CancellationToken cancellationToken)
  • protected abstract Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint, CancellationToken cancellationToken)
• public abstract class AsyncJsonSchemaVisitorBase : AsyncJsonReferenceVisitorBase
  • protected AsyncJsonSchemaVisitorBase()
  • protected abstract Task<JsonSchema> VisitSchemaAsync(JsonSchema schema, string path, string typeNameHint, CancellationToken cancellationToken)
• public abstract class JsonReferenceVisitorBase
  • public virtual Task VisitAsync(object obj)
  • protected virtual Task VisitAsync(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
  • protected abstract Task<IJsonReference> VisitJsonReferenceAsync(IJsonReference reference, string path, string typeNameHint)
  • protected JsonReferenceVisitorBase(IContractResolver contractResolver)
  • public virtual void Visit(object obj)
  • protected virtual void Visit(object obj, string path, string typeNameHint, ISet<object> checkedObjects, Action<object> replacer)
  • protected abstract IJsonReference VisitJsonReference(IJsonReference reference, string path, string typeNameHint)
• public abstract class JsonSchemaVisitorBase : JsonReferenceVisitorBase
  • protected abstract Task<JsonSchema4> VisitSchemaAsync(JsonSchema4 schema, string path, string typeNameHint)
  • protected abstract JsonSchema VisitSchema(JsonSchema schema, string path, string typeNameHint)