Data.OpenApi.Internal.Schema.Validation

Validate JSON values with Swagger Schema.

Documentation

validatePrettyToJSON :: forall a. (ToJSON a, ToSchema a) => a -> Maybe String

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

validateToJSON (x :: Int) == []

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

See renderValidationErrors on how the output is structured.

validateToJSON :: forall a. (ToJSON a, ToSchema a) => a -> [ValidationError]

Variant of validatePrettyToJSON with typed output.

validateToJSONWithPatternChecker :: forall a. (ToJSON a, ToSchema a) => (Pattern -> Text -> Bool) -> a -> [ValidationError]

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.

renderValidationErrors :: forall a. (ToJSON a, ToSchema a) => (a -> [ValidationError]) -> a -> Maybe String

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 person
Validation 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"
    }
}

validateJSON :: Definitions Schema -> Schema -> Value -> [ValidationError]

Validate JSON Value against Swagger Schema.

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

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

validateJSONWithPatternChecker :: (Pattern -> Text -> Bool) -> Definitions Schema -> Schema -> Value -> [ValidationError]

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

For validation without patterns see validateJSON.

type ValidationError = String

Validation error message.

data Result a

Validation result type.

Constructors

Failed [ValidationError]

Validation failed with a list of error messages.

Passed a

Validation passed.

Instances

Monad Result

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

(>>=) :: Result a -> (a -> Result b) -> Result b

(>>) :: Result a -> Result b -> Result b

return :: a -> Result a

Functor Result

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

fmap :: (a -> b) -> Result a -> Result b

(<$) :: a -> Result b -> Result a

Applicative Result

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

pure :: a -> Result a

(<*>) :: Result (a -> b) -> Result a -> Result b

liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c

(*>) :: Result a -> Result b -> Result b

(<*) :: Result a -> Result b -> Result a

Alternative Result

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

empty :: Result a

(<|>) :: Result a -> Result a -> Result a

some :: Result a -> Result [a]

many :: Result a -> Result [a]

Eq a => Eq (Result a)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

(==) :: Result a -> Result a -> Bool

(/=) :: Result a -> Result a -> Bool

Show a => Show (Result a)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

data Config

Validation configuration.

Constructors

Config

Fields

• configPatternChecker :: Pattern -> Text -> Bool

  Pattern checker for _schemaPattern validation.

• configDefinitions :: Definitions Schema

  Schema definitions in scope to resolve references.

defaultConfig :: Config

Default Config:

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

newtype Validation s a

Value validation.

Constructors

Validation

Fields

• runValidation :: Config -> s -> Result a

Instances

Profunctor Validation

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

dimap :: (a -> b) -> (c -> d) -> Validation b c -> Validation a d

lmap :: (a -> b) -> Validation b c -> Validation a c

rmap :: (b -> c) -> Validation a b -> Validation a c

(#.) :: forall a b c q. Coercible c b => q b c -> Validation a b -> Validation a c

(.#) :: forall a b c q. Coercible b a => Validation b c -> q a b -> Validation a c

Choice Validation

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

left' :: Validation a b -> Validation (Either a c) (Either b c)

right' :: Validation a b -> Validation (Either c a) (Either c b)

Monad (Validation s)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

(>>=) :: Validation s a -> (a -> Validation s b) -> Validation s b

(>>) :: Validation s a -> Validation s b -> Validation s b

return :: a -> Validation s a

Functor (Validation s)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

fmap :: (a -> b) -> Validation s a -> Validation s b

(<$) :: a -> Validation s b -> Validation s a

Applicative (Validation schema)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

pure :: a -> Validation schema a

(<*>) :: Validation schema (a -> b) -> Validation schema a -> Validation schema b

liftA2 :: (a -> b -> c) -> Validation schema a -> Validation schema b -> Validation schema c

(*>) :: Validation schema a -> Validation schema b -> Validation schema b

(<*) :: Validation schema a -> Validation schema b -> Validation schema a

Alternative (Validation schema)

Defined in Data.OpenApi.Internal.Schema.Validation

Methods

empty :: Validation schema a

(<|>) :: Validation schema a -> Validation schema a -> Validation schema a

some :: Validation schema a -> Validation schema [a]

many :: Validation schema a -> Validation schema [a]

withConfig :: (Config -> Validation s a) -> Validation s a

withSchema :: (s -> Validation s a) -> Validation s a

invalid :: String -> Validation schema a

Issue an error message.

valid :: Validation schema ()

Validation passed.

checkMissing :: Validation s () -> Lens' s (Maybe a) -> (a -> Validation s ()) -> Validation s ()

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

check :: Lens' s (Maybe a) -> (a -> Validation s ()) -> Validation s ()

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

sub :: t -> Validation t a -> Validation s a

Validate same value with different schema.

sub_ :: Getting a s a -> Validation a r -> Validation s r

Validate same value with a part of the original schema.

withRef :: Reference -> (Schema -> Validation s a) -> Validation s a

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

validateWithSchemaRef :: Referenced Schema -> Value -> Validation s ()

validateWithSchema :: Value -> Validation Schema ()

Validate JSON Value with Swagger Schema.

validateInteger :: Scientific -> Validation Schema ()

validateNumber :: Scientific -> Validation Schema ()

validateString :: Text -> Validation Schema ()

validateArray :: Vector Value -> Validation Schema ()

validateObject :: KeyMap Value -> Validation Schema ()

validateEnum :: Value -> Validation Schema ()

inferSchemaTypes :: Schema -> [OpenApiType]

Infer schema type based on used properties.

This is like inferParamSchemaTypes, but also works for objects:

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

inferParamSchemaTypes :: Schema -> [OpenApiType]

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]

validateSchemaType :: Value -> Validation Schema ()

validateParamSchemaType :: Value -> Validation Schema ()

showType :: (Maybe OpenApiType, Value) -> String