NJsonSchema
Indicates that the value of the marked element is nullable.
Annotation to specify that array items or dictionary values are nullable.
Annotation to merge all inherited properties into this class/schema.
Initializes a new instance of the class.
Initializes a new instance of the class.
The explicit flag to override the global setting (i.e. disable the generation for a type).
Gets or sets a value indicating whether to set the x-abstract property for given type.
Annotation to specify the JSON Schema type for the given class.
Initializes a new instance of the class.
Initializes a new instance of the class.
The identifier of the schema which is used as key in the 'definitions' list.
Initializes a new instance of the class.
The JSON Schema type.
Gets or sets the name identifier of the schema which is used as key in the 'definitions' list.
Gets the JSON Schema type (default: , i.e. derived from ).
Gets or sets the JSON format type (default: null, i.e. derived from ).
Gets or sets the array item type.
Annotation to mark a property or class as string type with format 'date'.
Initializes a new instance of the class.
Adds an extension data property to a class or property.
Initializes a new instance of the class.
The key.
The value.
Gets the property name.
Gets the value.
Annotation to merge all inherited properties into this class/schema.
Initializes a new instance of the class.
Initializes a new instance of the class.
The explicit flag to override the global setting (i.e. disable the generation for a type).
Gets or sets a value indicating whether to flatten the given type.
Indicates that the marked class is ignored during the JSON Schema generation.
Annotation to specify the JSON Schema pattern properties.
Initializes a new instance of the class.
The pattern property regular expression.
Initializes a new instance of the class.
The pattern property regular expression.
The pattern properties type.
Gets the pattern properties regular expression.
Gets the pattern properties type.
Registers an schema processor for the given class.
Initializes a new instance of the class.
The schema processor type (must implement ISchemaProcessor).
The parameters.
Gets or sets the type of the operation processor (must implement ISchemaProcessor).
Gets or sets the type of the constructor parameters.
Specifies the type to use for JSON Schema generation.
Initializes a new instance of the class.
The type of the schema.
Gets or sets the response type.
Gets or sets a value indicating whether the schema can be null (default: null = unchanged).
Gets the raw nullable information.
Attribute to set the multipleOf parameter of a JSON Schema.
Initializes a new instance of the class.
The multipleOf value.
Initializes a new instance of the class.
The multipleOf value.
Gets the value whose modulo the the JSON value must be zero.
Indicates that the value of the marked element could never be null.
An implementation of an observable dictionary.
The type of the key.
The type of the value.
Initializes a new instance of the class.
Initializes a new instance of the class.
The dictionary to initialize this dictionary.
Initializes a new instance of the class.
The comparer.
Initializes a new instance of the class.
The capacity.
Initializes a new instance of the class.
The dictionary to initialize this dictionary.
The comparer.
Initializes a new instance of the class.
The capacity.
The comparer.
Gets the underlying dictonary.
Adds multiple key-value pairs the the dictionary.
The key-value pairs.
Inserts a key-value pair into the dictionary.
The key.
The value.
If true and key already exists then an exception is thrown.
Provides name conversion utility methods.
Converts the first letter to lower case and dashes to camel case.
The input.
Specifies whether to add an _ when the first character is not alpha.
The converted input.
Converts the first letter to upper case and dashes to camel case.
The input.
Specifies whether to add an _ when the first character is not alpha.
The converted input.
Converts the string to a string literal which can be used in C# or TypeScript code.
The input.
The literal.
Converts the input to a camel case identifier.
The input.
The converted input.
Trims white spaces from the text.
The text.
The updated text.
Removes the line breaks from the text.
The text.
The updated text.
Singularizes the given noun in plural.
The plural noun.
The singular noun.
Add tabs to the given string.
The input.
The tab count.
The output.
Converts all line breaks in a string into '\n' and removes white spaces.
The input.
The tab count.
The output.
A converter to correctly serialize exception objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
If set to true the serializer hides stack trace (i.e. sets the StackTrace to 'HIDDEN').
The namespaces to search for exception types.
Gets a value indicating whether this can write JSON.
Writes the JSON representation of the object.
The to write to.
The value.
The calling serializer.
Determines whether this instance can convert the specified object type.
Type of the object.
true if this instance can convert the specified object type; otherwise, false.
Reads the JSON representation of the object.
The to read from.
Type of the object.
The existing value of object being read.
The calling serializer.
The object value.
Defines the class as inheritance base class and adds a discriminator property to the serialized object.
Gets the default discriminiator name.
Initializes a new instance of the class.
Initializes a new instance of the class.
The discriminator.
Initializes a new instance of the class.
The discriminator.
Read the $type property to determine the type (fallback).
Initializes a new instance of the class which only applies for the given base type.
Use this constructor for global registered converters (not defined on class).
The base type.
Initializes a new instance of the class which only applies for the given base type.
Use this constructor for global registered converters (not defined on class).
The base type.
The discriminator.
Gets the discriminator property name.
Writes the JSON representation of the object.
The to write to.
The value.
The calling serializer.
Gets a value indicating whether this can write JSON.
Gets a value indicating whether this can read JSON.
Determines whether this instance can convert the specified object type.
Type of the object.
true if this instance can convert the specified object type; otherwise, false.
Reads the JSON representation of the object.
The to read from.
Type of the object.
The existing value of object being read.
The calling serializer.
The object value.
Gets the discriminator value for the given type.
The object type.
The discriminator value.
Gets the type for the given discriminator value.
The JSON object.
The object (base) type.
The discriminator value.
Regenerates reference paths and correctly generates $ref properties.
Gets a value indicating whether this can write JSON.
Determines whether this instance can convert the specified object type.
Type of the object.
true if this instance can convert the specified object type; otherwise, false.
Reads the JSON representation of the object.
The to read from.
Type of the object.
The existing value of object being read.
The calling serializer.
The object value.
Writes the JSON representation of the object.
The to write to.
The value.
The calling serializer.
Converts the last part of the full type name to upper case.
Gets or sets the reserved names.
Gets the name mappings.
Generates the type name for the given schema respecting the reserved type names.
The schema.
The type name hint.
The reserved type names.
The type name.
Generates the type name for the given schema.
The schema.
The type name hint.
The type name.
The default reflection service implementation.
Creates a from a .
The type.
The settings.
The .
Creates a from a .
The type.
The default reference type null handling used when no nullability information is available.
The settings.
The .
Checks whether a type is nullable.
The type.
The default reference type null handling used when no nullability information is available.
true if the type can be null.
Checks whether the give type is a string enum.
The type.
The serializer settings.
The result.
Checks whether the given type is a file/binary type.
The type.
true or false.
Checks whether the given type is an array type.
The type.
true or false.
Checks whether the given type is a dictionary type.
The type.
true or false.
The default schema name generator implementation.
Generates the name of the JSON Schema.
The type.
The new name.
Defines the enum handling.
Generates an integer field without enumeration (except when using StringEnumConverter).
Generates a string field with JSON Schema enumeration.
Generates a camel-cased string field with JSON Schema enumeration.
Provides methods to reflect on types.
Creates a from a .
The type.
The default reference type null handling.
The settings.
The .
Creates a from a .
The type.
The settings.
The .
Checks whether a type is nullable.
The type.
The default reference type null handling used when no nullability information is available.
true if the type can be null.
Checks whether the give type is a string enum.
The type.
The serializer settings.
The result.
The schema name generator.
Generates the name of the JSON Schema for the given type.
The type.
The new name.
The schema processor interface.
Processes the specified JSON Schema.
The schema context.
Generates a object for a given type.
Initializes a new instance of the class.
The settings.
Gets the settings.
Generates a object for the given type and adds the mapping to the given resolver.
The type.
The schema.
Could not find value type of dictionary type.
Generates a object for the given type and adds the mapping to the given resolver.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generates a object for the given type and adds the mapping to the given resolver.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generates a object for the given type and adds the mapping to the given resolver.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generates a object for the given type and adds the mapping to the given resolver.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generates into the given object for the given type and adds the mapping to the given resolver.
The type of the schema.
The schema.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generates into the given object for the given type and adds the mapping to the given resolver.
The type of the schema.
The schema.
The type.
The schema resolver.
The schema.
Could not find value type of dictionary type.
Generetes a schema directly or referenced for the requested schema type;
does NOT change nullability.
The resulted schema type which may reference the actual schema.
The type of the schema to generate.
The schema resolver.
An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).
The requested schema object.
Generetes a schema directly or referenced for the requested schema type;
also adds nullability if required by looking at the type's .
The resulted schema type which may reference the actual schema.
The type of the schema to generate.
The schema resolver.
An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).
The requested schema object.
Generetes a schema directly or referenced for the requested schema type; also adds nullability if required.
The resulted schema type which may reference the actual schema.
The type of the schema to generate.
Specifies whether the property, parameter or requested schema type is nullable.
The schema resolver.
An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).
The requested schema object.
Gets the converted property name.
The property.
The contextual member info.
The property name.
Applies the property annotations to the JSON property.
The schema.
The property type description.
Gets the actual default value for the given object (e.g. correctly converts enums).
The value type.
The default value.
The converted default value.
Generates the example from the type's xml docs.
The type.
The JToken or null.
Generates the properties for the given type and schema.
The properties
The type description.
The schema resolver.
The task.
Gets the properties of the given type or null to take all properties.
The type.
The property names or null for all.
Generates an array in the given schema.
The schema type.
The schema.
The type description.
The schema resolver.
Generates an array in the given schema.
The schema type.
The schema.
The type description.
The schema resolver.
Could not find value type of dictionary type.
Generates an enumeration in the given schema.
The schema.
The type description.
The JSON Schema generator settings.
Initializes a new instance of the class.
Gets or sets the default reference type null handling when no nullability information is available (default: Null).
Gets or sets the default reference type null handling of dictionary value types when no nullability information is available (default: NotNull).
Gets or sets a value indicating whether to generate abstract properties (i.e. interface and abstract properties. Properties may defined multiple times in a inheritance hierarchy, default: false).
Gets or sets a value indicating whether to flatten the inheritance hierarchy instead of using allOf to describe inheritance (default: false).
Gets or sets a value indicating whether to generate the x-abstract flag on schemas (default: true).
Gets or sets a value indicating whether to generate schemas for types in attributes (default: true).
Gets or sets a value indicating whether to generate xmlObject representation for definitions (default: false).
Gets or sets a value indicating whether to ignore properties with the .
Gets or sets a value indicating whether to use $ref references even if additional properties are
defined on the object (otherwise allOf/oneOf with $ref is used, default: false).
Gets or sets a value indicating whether to generate a description with number to enum name mappings (for integer enums only, default: false).
Will set `additionalProperties` on all added schema definitions and references(default: false).
Gets or sets a value indicating whether tho generate the example property of the schemas based on the the <example> xml docs entry as JSON.
Gets or sets the schema type to generate (default: JsonSchema).
Gets or sets the serializer settings.
, and will be ignored.
Gets or sets the excluded type names (same as ).
Gets or sets the type name generator.
Gets or sets the schema name generator.
Gets or sets the reflection service.
Gets or sets the type mappings.
Gets or sets the schema processors.
Gets or sets a value indicating whether to generate x-nullable properties (Swagger 2 only).
Gets or sets the contract resolver.
will be ignored.
Gets or sets the default property name handling (default: Default).
Gets or sets the default enum handling (default: Integer).
Gets the contract resolver.
The contract resolver.
A setting is misconfigured.
Gets the serializer settings.
A setting is misconfigured.
Gets the contract for the given type.
The type.
The contract.
Gets the actual computed setting based on the global setting and the JsonSchemaAbstractAttribute attribute.
The type.
The result.
Gets the actual computed setting based on the global setting and the JsonSchemaFlattenAttribute attribute.
The type.
The result.
Manager which resolves types to schemas and appends missing schemas to the root object.
Initializes a new instance of the class.
The root schema.
The settings.
Determines whether the specified type has a schema.
The type.
Specifies whether the type is an integer enum.
true when the mapping exists.
Gets the schema for a given type.
The type.
Specifies whether the type is an integer enum.
The schema.
Adds a schema to type mapping.
The type.
Specifies whether the type is an integer enum.
The schema.
Added schema is not a JsonSchema4 instance.
Gets all the schemas.
Gets JSON information about a .NET type.
Creates a description for a primitive type or object.
The type.
The JSON type.
Specifies whether the type is nullable.
The format string (may be null).
The description.
Creates a description for a dictionary.
The type.
The JSON type.
Specifies whether the type is nullable.
The description.
Creates a description for an enumeration.
The type.
The JSON type.
Specifies whether the type is nullable.
The description.
Gets the actual contextual type.
Gets the type.
Gets a value indicating whether the object is a generic dictionary.
Gets a value indicating whether the type is an enum.
Gets the format string.
Gets or sets a value indicating whether the type is nullable.
Gets a value indicating whether this is a complex type (i.e. object, dictionary or array).
Gets a value indicating whether this is an any type (e.g. object).
Specifices whether the type requires a reference.
The type mappers.
true or false.
Applies the type and format to the given schema.
The JSON schema.
Defines the property name handling.
Generates property name using reflection (respecting the and ).
Generates lower camel cased property names using .
Generates snake cased property names using .
Specifies the default null handling for reference types when no nullability information is available.
Reference types are nullable by default (C# default).
Reference types cannot be null by default.
Generates a JSON Schema from sample JSON data.
Generates the JSON Schema for the given JSON data.
The JSON data.
The JSON Schema.
The schema processor context.
Initializes a new instance of the class.
The source type.
The JSON Schema.
The resolver.
The generator.
The settings.
The source type.
The JSON Schema to process.
The JSON Schema resolver.
Gets the JSON Schema generator.
Gets the settings.
Maps .NET type to a generated JSON Schema.
Gets the mapped type.
Gets a value indicating whether to use a JSON Schema reference for the type.
Gets the schema for the mapped type.
The schema.
The context.
Maps .NET type to a generated JSON Schema describing an object.
Initializes a new instance of the class.
Type of the mapped.
The schema.
Initializes a new instance of the class.
Type of the mapped.
The schema factory.
Gets the mapped type.
Gets a value indicating whether to use a JSON Schema reference for the type.
Gets the schema for the mapped type.
The schema.
The context.
Maps .NET type to a generated JSON Schema describing a primitive value.
Initializes a new instance of the class.
Type of the mapped.
The transformer.
Gets the mapped type.
Gets a value indicating whether to use a JSON Schema reference for the type.
Gets the schema for the mapped type.
The schema.
The context.
The context object for the interface.
Initializes a new instance of the class.
The source type.
The .
The .
The parent properties (e.g. the attributes on the property).
Provides a property to get a documents path or base URI.
Gets the document path (URI or file path).
The base JSON interface with extension data.
Gets or sets the extension data (i.e. additional properties which are not directly defined by the JSON object).
Specifies what attribute types to use to resolve the description.
The context attributes.
The type attributes.
Provides dynamic access to framework APIs.
Gets a value indicating whether file APIs are available.
Gets a value indicating whether path APIs are available.
Gets a value indicating whether path APIs are available.
Gets a value indicating whether XPath APIs are available.
Gets a value indicating whether WebClient APIs are available.
Request the given URL via HTTP.
The URL.
The content.
The HttpClient.GetAsync API is not available on this platform.
Gets the current working directory.
The directory path.
The System.IO.Directory API is not available on this platform.
Gets the files of the given directory.
The directory.
The filter.
The file paths.
The System.IO.Directory API is not available on this platform.
Creates a directory.
The directory.
The System.IO.Directory API is not available on this platform.
Checks whether a directory exists.
The file path.
true or false
The System.IO.Directory API is not available on this platform.
Checks whether a file exists.
The file path.
true or false
The System.IO.File API is not available on this platform.
Reads all content of a file (UTF8).
The file path.
The file content.
The System.IO.File API is not available on this platform.
Writes text to a file (UTF8).
The file path.
The text.
The System.IO.File API is not available on this platform.
Combines two paths.
The path1.
The path2.
The combined path.
The System.IO.Path API is not available on this platform.
Gets the full path from a given path
The path
The full path
The System.IO.Path API is not available on this platform.
Gets the directory path of a file path.
The file path.
The directory name.
The System.IO.Path API is not available on this platform.
Evaluates the XPath for a given XML document.
The document.
The path.
The value.
The System.Xml.XPath.Extensions API is not available on this platform.
The JSON Schema serialization context holding information about the current serialization.
Gets or sets the current schema type.
Gets the current serializer settings.
Gets or sets a value indicating whether the object is currently converted to JSON.
Serializes an object to a JSON string with reference handling.
The object to serialize.
The schema type.
The contract resolver.
The formatting.
The JSON.
Deserializes JSON data to a schema with reference handling.
The JSON data.
The schema type.
The document path.
The reference resolver factory.
The contract resolver.
The deserialized schema.
Deserializes JSON data with the given contract resolver.
The JSON data.
The contract resolver.
The deserialized schema.
JsonConvert resolver that allows to ignore and rename properties for given types.
Initializes a new instance of the class.
Ignore the given property/properties of the given type.
The type.
One or more JSON properties to ignore.
Rename a property of the given type.
The type.
The JSON property name to rename.
The new JSON property name.
Creates a JsonProperty for the given System.Reflection.MemberInfo.
The member's parent Newtonsoft.Json.MemberSerialization.
The member to create a JsonProperty for.
A created JsonProperty for the given System.Reflection.MemberInfo.
Provides extension methods for reading contextual type names and descriptions.
Gets the name of the property for JSON serialization.
The name.
Gets the description of the given member (based on the DescriptionAttribute, DisplayAttribute or XML Documentation).
The member info
The attribute type to check.
The description or null if no description is available.
Gets the description of the given member (based on the DescriptionAttribute, DisplayAttribute or XML Documentation).
The parameter.
The description or null if no description is available.
Extension methods to help out generating XMLObject structure to schema.
Generate XML object for a JSON Schema definition.
The JSON Schema.
The type of the JSON Schema.
Generates an XML object for a JSON Schema definition.
The JSON Schema
Generates XMLObject structure for an array with primitive types
The JSON Schema of the item.
The item type.
Generates XMLObject structure for a property.
The JSON Schema for the property
The type.
The property name.
type.Name is used int will return Int32, string will return String etc.
These are not valid with how the XMLSerializer performs.
Generates the type name for a given .
Generates the type name.
The property.
The type name hint (the property name or definition key).
The reserved type names.
The new name.
The base JSON class with extension data.
Gets or sets the extension data (i.e. additional properties which are not directly defined by the JSON object).
Deserializes all JSON Schemas in the extension data property.
Transforms the extension data so that contained schemas are correctly deserialized.
The extension object.
The serializer.
Class containing the constants available as format string.
Format for a .
Format for a .
Format for an email.
Format for an URI.
Format for an GUID.
Format for an UUID (same as GUID).
Format for an integer.
Format for a long integer.
Format for a double number.
Format for a float number.
Format for a decimal number.
Format for an IP v4 address.
Format for an IP v6 address.
Format for binary data encoded with Base64.
Should not be used. Prefer using Byte property of
Format for a byte if used with numeric type or for base64 encoded value otherwise.
Format for a binary value.
Format for a hostname (DNS name).
Format for a phone number.
Format for a full date per RFC3339 Section 5.6.
Format for a full time per RFC3339 Section 5.6.
Enumeration of the possible object types.
No object type.
An array.
A boolean value.
An integer value.
A null.
An number value.
An object.
A string.
A file (used in Swagger specifications).
Utilities to work with JSON paths.
Gets the $ref replacement string.
Gets the JSON path of the given object.
The root object.
The object to search.
The path or null when the object could not be found.
Could not find the JSON path of a child object.
is
Gets the JSON path of the given object.
The root object.
The object to search.
The contract resolver.
The path or null when the object could not be found.
Could not find the JSON path of a child object.
is
Gets the JSON path of the given object.
The root object.
The objects to search.
The contract resolver.
The path or null when the object could not be found.
Could not find the JSON path of a child object.
is
Resolves JSON Pointer references.
Initializes a new instance of the class.
The schema appender.
Creates the factory to be used in the FromJsonAsync method.
The type name generator.
The factory.
Adds a document reference.
The document path.
The referenced schema.
Gets the object from the given JSON path.
The root object.
The JSON path.
The JSON Schema or null when the object could not be found.
Could not resolve the JSON path.
Could not resolve the JSON path.
Gets the object from the given JSON path.
The root object.
The JSON path.
The JSON Schema or null when the object could not be found.
Could not resolve the JSON path.
Could not resolve the JSON path.
Resolves a document reference.
The root object.
The JSON path to resolve.
The resolved JSON Schema.
Could not resolve the JSON path.
Resolves a file reference.
The file path.
The resolved JSON Schema.
The System.IO.File API is not available on this platform.
Resolves an URL reference.
The URL.
The HttpClient.GetAsync API is not available on this platform.
A base class for describing a JSON schema.
Initializes a new instance of the class.
Creates a schema which matches any data.
The any schema.
Creates a schema which matches any data.
The any schema.
Gets the NJsonSchema toolchain version.
Creates a from a given type.
The type to create the schema for.
The .
Creates a from a given type.
The type to create the schema for.
The .
Creates a from a given type.
The type to create the schema for.
The settings.
The .
Creates a from a given type.
The type to create the schema for.
The settings.
The .
Creates a from sample JSON data.
The JSON Schema.
Loads a JSON Schema from a given file path (only available in .NET 4.x).
The file path.
The JSON Schema.
Loads a JSON Schema from a given file path (only available in .NET 4.x).
The file path.
The JSON reference resolver factory.
The JSON Schema.
The System.IO.File API is not available on this platform.
Loads a JSON Schema from a given URL (only available in .NET 4.x).
The URL to the document.
The JSON Schema.
The HttpClient.GetAsync API is not available on this platform.
Loads a JSON Schema from a given URL (only available in .NET 4.x).
The URL to the document.
The JSON reference resolver factory.
The JSON Schema.
The HttpClient.GetAsync API is not available on this platform.
Deserializes a JSON string to a .
The JSON string.
The JSON Schema.
Deserializes a JSON string to a .
The JSON string.
The document path (URL or file path) for resolving relative document references.
The JSON Schema.
Deserializes a JSON string to a .
The JSON string.
The document path (URL or file path) for resolving relative document references.
The JSON reference resolver factory.
The JSON Schema.
Gets a value indicating whether the schema is binary (file or binary format).
Gets the inherited/parent schema (most probable base schema in allOf).
Used for code generation.
Gets the inherited/parent schema which may also be inlined
(the schema itself if it is a dictionary or array, otherwise ).
Used for code generation.
Gets the list of all inherited/parent schemas.
Used for code generation.
Determines whether the given schema is the parent schema of this schema (i.e. super/base class).
The possible subtype schema.
true or false
Gets the discriminator or discriminator of an inherited schema (or null).
Gets all properties of this schema (i.e. all direct properties and properties from the schemas in allOf which do not have a type).
Used for code generation.
Some properties are defined multiple times.
Gets or sets the schema.
Gets or sets the id.
Gets or sets the title.
Gets a value indicating whether the schema title can be used as type name.
Gets or sets the description.
Gets the object types (as enum flags).
Gets the parent schema of this schema.
Gets the parent schema of this schema.
Gets or sets the format string.
Gets or sets the default value.
Gets or sets the required multiple of for the number value.
Gets or sets the maximum allowed value.
Gets or sets the exclusive maximum value (v6).
Gets or sets a value indicating whether the minimum value is excluded (v4).
Gets or sets the minimum allowed value.
Gets or sets the exclusive minimum value (v6).
Gets or sets a value indicating whether the minimum value is excluded (v4).
Gets or sets the maximum length of the value string.
Gets or sets the minimum length of the value string.
Gets or sets the validation pattern as regular expression.
Gets or sets the maximum length of the array.
Gets or sets the minimum length of the array.
Gets or sets a value indicating whether the items in the array must be unique.
Gets or sets the maximal number of allowed properties in an object.
Gets or sets the minimal number of allowed properties in an object.
Gets or sets a value indicating whether the schema is deprecated (Swagger and Open API only).
Gets or sets a value indicating whether the type is abstract, i.e. cannot be instantiated directly (x-abstract).
Gets or sets a value indicating whether the schema is nullable (native in Open API 'nullable', custom in Swagger 'x-nullable').
Gets or sets the example (Swagger and Open API only).
Gets or sets a value indicating this is an bit flag enum (custom extension, sets 'x-enumFlags', default: false).
Gets the collection of required properties.
Gets a value indicating whether this is enumeration.
Gets the collection of required properties.
This collection can also be changed through the property. >
Gets or sets the dictionary key schema (x-key, only enum schemas are allowed).
Gets the properties of the type.
Gets the xml object of the schema (used in Swagger specifications).
Gets the pattern properties of the type.
Gets or sets the schema of an array item.
Gets or sets the schemas of the array's tuple values.
Gets or sets the schema which must not be valid.
Gets the other schema definitions of this schema.
Gets the collection of schemas where each schema must be valid.
Gets the collection of schemas where at least one must be valid.
Gets the collection of schemas where exactly one must be valid.
Gets or sets a value indicating whether additional items are allowed (default: true).
If this property is set to false, then is set to null.
Gets or sets the schema for the additional items.
If this property has a schema, then is set to true.
Gets or sets a value indicating whether additional properties are allowed (default: true).
If this property is set to false, then is set to null.
Gets or sets the schema for the additional properties.
If this property has a schema, then is set to true.
Gets a value indicating whether the schema describes an object.
Gets a value indicating whether the schema represents an array type (an array where each item has the same type).
Gets a value indicating whether the schema represents an tuple type (an array where each item may have a different type).
Gets a value indicating whether the schema represents a dictionary type (no properties and AdditionalProperties or PatternProperties contain a schema).
Gets a value indicating whether this is any type (e.g. any in TypeScript or object in CSharp).
Gets a value indicating whether the validated data can be null.
The schema type.
true if the type can be null.
Serializes the to a JSON string.
The JSON string.
Serializes the to a JSON string.
The formatting.
The JSON string.
Gets a value indicating whether this schema inherits from the given parent schema.
The parent schema.
true or false.
Validates the given JSON data against this schema.
The JSON data to validate.
Custom validators to validate the JSON.
Could not deserialize the JSON data.
The collection of validation errors.
Validates the given JSON token against this schema.
The token to validate.
Custom validators to validate the token.
The collection of validation errors.
Gets the actual schema, either this or the referenced schema.
Cyclic references detected.
The schema reference path has not been resolved.
Gets the type actual schema (e.g. the shared schema of a property, parameter, etc.).
Cyclic references detected.
The schema reference path has not been resolved.
Gets a value indicating whether this is a schema reference ($ref, , or ).
Gets a value indicating whether this is an allOf schema reference.
Gets a value indicating whether this is an oneOf schema reference.
Gets a value indicating whether this is an anyOf schema reference.
Cyclic references detected.
The schema reference path has not been resolved.
Gets the actual referenced object, either this or the reference object.
Gets the parent object of this object.
Gets or sets the referenced object.
Creates the serializer contract resolver based on the .
The schema type.
The settings.
Gets or sets the extension data (i.e. additional properties which are not directly defined by JSON Schema).
Gets the discriminator property (Swagger only).
Gets or sets the discriminator property (Swagger only, should not be used in internal tooling).
Gets the actual resolved discriminator of this schema (no inheritance, OpenApi only).
Gets or sets the discriminator of this schema (OpenApi only).
Gets or sets the discriminator.
Gets or sets the enumeration names (optional, draft v5).
Gets or sets a value indicating whether the maximum value is excluded.
Gets or sets a value indicating whether the minimum value is excluded.
Gets or sets the enumeration names (optional, draft v5).
Appends a schema to a document (i.e. another schema).
Initializes a new instance of the class.
The root schema.
The type name generator.
Gets the root object.
Gets the root schema.
Appends the schema to the root object.
The schema to append.
The type name hint.
is
The root schema cannot be appended.
A description of a JSON property of a JSON schema.
Gets or sets the name of the property.
Gets the parent schema of this property schema.
Gets or sets a value indicating whether the property is required.
Value used to set property even if parent is not set yet.
Gets or sets a value indicating whether the property is read only (Swagger and Open API only).
Gets or sets a value indicating whether the property is write only (Open API only).
Gets a value indicating whether the property is an inheritance discriminator.
Determines whether the specified property null handling is nullable.
The schema type.
true if the type can be null.
Provides utilities to resolve and set JSON schema references.
Updates all properties from the
available properties.
The JSON document resolver.
The root object.
Updates all properties from the
available properties.
The JSON document resolver.
The root object.
The contract resolver.
Converts JSON references ($ref) to property references.
The data.
The data.
Converts property references to JSON references ($ref).
The data.
Updates the properties
from the available properties with inlining external references.
The root object.
Updates the properties
from the available properties.
The root object.
Specifies whether to remove external references (otherwise they are inlined).
The contract resolver.
A description of a JSON property of a JSON object (used in Swagger specifications).
Gets the parent schema of the XML object schema.
Gets or sets the name of the xml object.
Gets or sets if the array elements are going to be wrapped or not.
Gets or sets the URL of the namespace definition.
Gets or sets the prefix for the name.
Gets or sets if the property definition translates into an attribute instead of an element.
Describes a schema discriminator.
Gets or sets the discriminator property name.
Gets or sets the discriminator mappings.
The currently used .
Adds a discriminator mapping for the given type and schema based on the used .
The type.
The schema.
Used to convert from Dictionary{string, JsonSchema4} (NJsonSchema model) to Dictionary{string, string} (OpenAPI).
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#discriminator-object and
issue https://github.com/RicoSuter/NSwag/issues/1684
A JSON object which may reference other objects with $ref.
The methods should be implemented explicitly to hide them from the API.
Gets the actual referenced object, either this or the reference object.
Gets the parent object which may be the root.
A JSON object which may reference other objects with $ref.
Gets or sets the type reference path ($ref).
Gets or sets the referenced object.
A base class which may reference another object.
The referenced object type.
Gets the document path (URI or file path) for resolving relative references.
Gets or sets the type reference path ($ref).
Gets or sets the referenced object.
Gets or sets the referenced object.
Extensions to work with .
Finds the root parent of this schema.
The parent schema or this when this is the root.
Defines how to express the nullability of a property.
Uses oneOf with null schema and null type to express the nullability of a property (valid JSON Schema draft v4).
Uses required to express the nullability of a property (not valid in JSON Schema draft v4).
Uses null handling of Open API 3.
A subschema validation error.
Initializes a new instance of the class.
The error kind.
The property name.
The property path.
The error list.
The token that failed to validate.
The schema that contains the validation rule.
Gets the errors for each validated subschema.
Returns a string that represents the current object.
A string that represents the current object.
2
Validator for "Base64" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Byte" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Date" format.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Gets the format attribute's value.
Returns validation error kind.
Validator for DateTime format.
Gets the format attribute's value.
Gets the validation error kind.
Validates if a string is valid DateTime.
String value.
Type of token holding the value.
Validator for "Email" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Guid" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Hostname" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Provides a method to verify if value is of valid format.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Gets the kind of error produced by validator.
Gets the format attribute's value.
Validator for "IpV4" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "IpV6" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Time" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "TimeSpan" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Validator for "Uri" format.
Gets the format attribute's value.
Gets the kind of error produced by validator.
Validates format of given value.
String value.
Type of token holding the value.
True if value is correct for given format, False - if not.
Class to validate a JSON schema against a given .
Initializes JsonSchemaValidator
Validates the given JSON data.
The json data.
The schema.
Could not deserialize the JSON data.
The list of validation errors.
Validates the given JSON token.
The token.
The schema.
The list of validation errors.
Validates the given JSON token.
The token.
The schema.
The current property name.
The current property path.
The list of validation errors.
A multi type validation error.
Initializes a new instance of the class.
The error kind.
The property name.
The property path.
The error list.
The token that failed to validate.
The schema that contains the validation rule.
Gets the errors for each validated type.
Returns a string that represents the current object.
A string that represents the current object.
2
A validation error.
Initializes a new instance of the class.
The error kind.
The property name.
The property path.
The token that failed to validate.
The schema that contains the validation rule.
Gets the error kind.
Gets the property name.
Gets the property path.
Indicates whether or not the error contains line information.
Gets the line number the validation failed on.
Gets the line position the validation failed on.
Gets the schema element that contains the validation rule.
Returns a string that represents the current object.
A string that represents the current object.
2
Enumeration of the possible error kinds.
An unknown error.
A string is expected.
A number is expected.
An integer is expected.
A boolean is expected.
An object is expected.
The property is required but not found.
An array is expected.
An array is expected.
The Regex pattern does not match.
The string is too short.
The string is too long.
The number is too small.
The number is too big.
The integer is too big.
The array contains too many items.
The array contains too few items.
The items in the array are not unique.
A date time is expected.
A date is expected.
A time is expected.
A time-span is expected.
An URI is expected.
An IP v4 address is expected.
An IP v6 address is expected.
A valid GUID is expected.
The object is not any of the given schemas.
The object is not all of the given schemas.
The object is not one of the given schemas.
The object matches the not allowed schema.
The number is not a multiple of the given number.
The integer is not a multiple of the given integer.
The value is not one of the allowed enumerations.
An Email is expected.
An hostname is expected.
The array tuple contains too many items.
An array item is not valid.
The item is not valid with the AdditionalItems schema.
The additional properties are not valid.
Additional/unspecified properties are not allowed.
There are too many properties in the object.
There are too few properties in the tuple.
A Base64 string is expected.
No type of the types does validate (check error details in ).
Visitor to transform an object with objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
The contract resolver.
Processes an object.
The object to process.
The task.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.
Processes an object.
The object to process.
The path
The type name hint.
The checked objects.
The replacer.
The task.
Visitor to transform an object with objects.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.
Visitor to transform an object with objects.
Initializes a new instance of the class.
Initializes a new instance of the class.
The contract resolver.
Processes an object.
The object to process.
The task.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.
Processes an object.
The object to process.
The path
The type name hint.
The checked objects.
The replacer.
The task.
Visitor to transform an object with objects.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.
Called when a is visited.
The visited schema.
The path.
The type name hint.
The task.