Data.OpenApi.Internal.Schema.Validation

Validate ToJSON instance matches ToSchema for a given value. This can be used with QuickCheck to ensure those instances are coherent:

prop> validateToJSON (x :: Int) == []

NOTE: validateToJSON does not perform string pattern validation. See validateToJSONWithPatternChecker.

See renderValidationErrors on how the output is structured.

Variant of validatePrettyToJSON with typed output.

Validate ToJSON instance matches ToSchema for a given value and pattern checker. This can be used with QuickCheck to ensure those instances are coherent.

For validation without patterns see validateToJSON. See also: renderValidationErrors.

Pretty print validation errors together with actual JSON and Swagger Schema (using encodePretty).

>>> import Data.Aeson as Aeson>>> import Data.Foldable (traverse_)>>> import GHC.Generics>>> data Phone = Phone { value :: String } deriving (Generic)>>> data Person = Person { name :: String, phone :: Phone } deriving (Generic)>>> instance ToJSON Person where toJSON p = object [ "name" Aeson..= name p ]>>> instance ToSchema Phone>>> instance ToSchema Person>>> let person = Person { name = "John", phone = Phone "123456" }>>> traverse_ putStrLn $ renderValidationErrors validateToJSON personValidation against the schema fails:  * property "phone" is required, but not found in "{\"name\":\"John\"}"JSON value:{    "name": "John"}Swagger Schema:{    "properties": {        "name": {            "type": "string"        },        "phone": {            "$ref": "#/components/schemas/Phone"        }    },    "required": [        "name",        "phone"    ],    "type": "object"}Swagger Description Context:{    "Phone": {        "properties": {            "value": {                "type": "string"            }        },        "required": [            "value"        ],        "type": "object"    }}

Validate JSON Value against Swagger Schema.

prop> validateJSON mempty (toSchema (Proxy :: Proxy Int)) (toJSON (x :: Int)) == []

NOTE: validateJSON does not perform string pattern validation. See validateJSONWithPatternChecker.

Validate JSON Value agains Swagger ToSchema for a given value and pattern checker.

For validation without patterns see validateJSON.

Validation error message.

Validation result type.

Validation configuration.

Default Config:

defaultConfig = Config
  { configPatternChecker = \_pattern _str -> True
  , configDefinitions    = mempty
  }

Value validation.

Issue an error message.

Validation passed.

Validate schema's property given a lens into that property and property checker.

Validate schema's property given a lens into that property and property checker. If property is missing in schema, consider it valid.

Validate same value with different schema.

Validate same value with a part of the original schema.

Validate value against a schema given schema reference and validation function.

Validate JSON Value with Swagger Schema.

Infer schema type based on used properties.

This is like inferParamSchemaTypes, but also works for objects:

>>> inferSchemaTypes <$> decode "{\"minProperties\": 1}"Just [OpenApiObject]

Infer schema type based on used properties.

>>> inferSchemaTypes <$> decode "{\"minLength\": 2}"Just [OpenApiString]

>>> inferSchemaTypes <$> decode "{\"maxItems\": 0}"Just [OpenApiArray]

From numeric properties OpenApiInteger type is inferred. If you want OpenApiNumber instead, you must specify it explicitly.

>>> inferSchemaTypes <$> decode "{\"minimum\": 1}"Just [OpenApiInteger]