Header menu logo FSharp.Data

JsonSchema Module

Module that handles JSON Schema parsing and type inference

Types

Type Description

JsonSchemaDefinition

Represents a parsed JSON Schema

JsonSchemaType

Represents basic JSON Schema types

JsonSchemaValidator

Represents a JSON Schema validator function

ValidationResult

Represents the result of validating a JSON value against a schema

Functions and values

Function or value Description

createBooleanType optional

Full Usage: createBooleanType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createDateTimeType optional

Full Usage: createDateTimeType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createDecimalType optional

Full Usage: createDecimalType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createGuidType optional

Full Usage: createGuidType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createIntType optional

Full Usage: createIntType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createStringType optional

Full Usage: createStringType optional

Parameters:
    optional : bool

Returns: InferedType
optional : bool
Returns: InferedType

createValidator schema jsonValue

Full Usage: createValidator schema jsonValue

Parameters:
Returns: ValidationResult

Create a validator function from a schema

schema : JsonSchemaDefinition
jsonValue : JsonValue
Returns: ValidationResult

empty

Full Usage: empty

Returns: JsonSchemaDefinition

Default empty schema definition

Returns: JsonSchemaDefinition

formatToType format

Full Usage: formatToType format

Parameters:
    format : string

Returns: Type

Convert JSON Schema format to .NET type

format : string
Returns: Type

parseSchema schemaJson

Full Usage: parseSchema schemaJson

Parameters:
Returns: JsonSchemaDefinition

Parse a JSON Schema from a JsonValue

schemaJson : JsonValue
Returns: JsonSchemaDefinition

parseSchemaFromString schemaString

Full Usage: parseSchemaFromString schemaString

Parameters:
    schemaString : string

Returns: JsonSchemaDefinition

Parse a JSON Schema from a string

schemaString : string
Returns: JsonSchemaDefinition

parseSchemaFromTextReader resolutionFolder reader

Full Usage: parseSchemaFromTextReader resolutionFolder reader

Parameters:
Returns: JsonSchemaDefinition

Parse a JSON Schema from a TextReader

resolutionFolder : string
reader : TextReader
Returns: JsonSchemaDefinition

resolveReferences schema rootSchema

Full Usage: resolveReferences schema rootSchema

Parameters:
Returns: JsonSchemaDefinition

Resolve references in a schema (simple implementation)

schema : JsonSchemaDefinition
rootSchema : JsonValue
Returns: JsonSchemaDefinition

schemaToInferedType umps schema

Full Usage: schemaToInferedType umps schema

Parameters:
Returns: InferedType

Convert a JSON Schema type to an InferedType for the type provider

umps : IUnitsOfMeasureProvider
schema : JsonSchemaDefinition
Returns: InferedType

validate schema value

Full Usage: validate schema value

Parameters:
Returns: ValidationResult

Validate a JSON value against a schema

schema : JsonSchemaDefinition
value : JsonValue
Returns: ValidationResult

Type something to start searching.