Network.Wai.Middleware.Validation.Internal

Documentation

data TemplatedPathComponent

Constructors

Exact FilePath

ParameterValue

Instances

Eq TemplatedPathComponent

Defined in Network.Wai.Middleware.Validation.Internal

Methods

(==) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

(/=) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

Ord TemplatedPathComponent

Defined in Network.Wai.Middleware.Validation.Internal

Methods

compare :: TemplatedPathComponent -> TemplatedPathComponent -> Ordering

(<) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

(<=) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

(>) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

(>=) :: TemplatedPathComponent -> TemplatedPathComponent -> Bool

max :: TemplatedPathComponent -> TemplatedPathComponent -> TemplatedPathComponent

min :: TemplatedPathComponent -> TemplatedPathComponent -> TemplatedPathComponent

Show TemplatedPathComponent

Defined in Network.Wai.Middleware.Validation.Internal

Methods

showsPrec :: Int -> TemplatedPathComponent -> ShowS

show :: TemplatedPathComponent -> String

showList :: [TemplatedPathComponent] -> ShowS

toTemplatedPathComponent :: FilePath -> TemplatedPathComponent

Convert FilePath to TemplatedPathComponent.

>>> toTemplatedPathComponent "foo"
Exact "foo"
>>> toTemplatedPathComponent "{foo}"
ParameterValue

type TemplatedPath = [TemplatedPathComponent]

toTemplatedPath :: FilePath -> TemplatedPath

Convert FilePath to TemplatedPath.

>>> toTemplatedPath "/foo/{fooId}"
[Exact "/",Exact "foo",ParameterValue]
>>> toTemplatedPath "/bar/{barId}/baz/{bazId}"
[Exact "/",Exact "bar",ParameterValue,Exact "baz",ParameterValue]

type PathMap = Map TemplatedPath FilePath

makePathMap :: [FilePath] -> PathMap

Convert list of FilePath to PathMap.

>>> makePathMap ["/foo", "/foo/{fooId}"]
fromList [([Exact "/",Exact "foo"],"/foo"),([Exact "/",Exact "foo",ParameterValue],"/foo/{fooId}")]

lookupDefinedPath :: FilePath -> PathMap -> Maybe FilePath

Look up a path (including a templated path) from PathMap.

>>> lookupDefinedPath "/foo" (makePathMap ["/foo", "/foo/{fooId}"])
Just "/foo"
>>> lookupDefinedPath "/foo/1" (makePathMap ["/foo", "/foo/{fooId}"])
Just "/foo/{fooId}"
>>> lookupDefinedPath "/bar" (makePathMap ["/foo", "/foo/{fooId}"])
Nothing

data ApiDefinition

Constructors

ApiDefinition

Fields

• getOpenApi :: OpenApi
• getPathMap :: PathMap

Instances

Eq ApiDefinition

Defined in Network.Wai.Middleware.Validation.Internal

Methods

(==) :: ApiDefinition -> ApiDefinition -> Bool

(/=) :: ApiDefinition -> ApiDefinition -> Bool

Show ApiDefinition

Defined in Network.Wai.Middleware.Validation.Internal

Methods

showsPrec :: Int -> ApiDefinition -> ShowS

show :: ApiDefinition -> String

showList :: [ApiDefinition] -> ShowS

toApiDefinition :: ByteString -> Maybe ApiDefinition

Create ApiDefinition instance from API document.

newtype BodySchema

Constructors

BodySchema

Fields

• toReferencedSchema :: Referenced Schema

Instances

Eq BodySchema

Defined in Network.Wai.Middleware.Validation.Internal

Methods

(==) :: BodySchema -> BodySchema -> Bool

(/=) :: BodySchema -> BodySchema -> Bool

Show BodySchema

Defined in Network.Wai.Middleware.Validation.Internal

Methods

showsPrec :: Int -> BodySchema -> ShowS

show :: BodySchema -> String

showList :: [BodySchema] -> ShowS

getRequestBodySchema :: ApiDefinition -> StdMethod -> FilePath -> Maybe BodySchema

Get request body schema.

getRequestBodyReferencedSchema :: ApiDefinition -> (PathItem -> Maybe Operation) -> FilePath -> Maybe (Referenced Schema)

getResponseBodySchema :: ApiDefinition -> StdMethod -> FilePath -> Int -> Maybe BodySchema

Get response body schema.

getResponseBodyReferencedSchema :: ApiDefinition -> (PathItem -> Maybe Operation) -> FilePath -> Int -> Maybe (Referenced Schema)

getPathItem :: ApiDefinition -> FilePath -> Maybe PathItem

validateJsonDocument :: ApiDefinition -> BodySchema -> ByteString -> Either String [String]

Validate JSON document.

fixValidationError :: String -> String

Fix validation error message.

>>> fixValidationError "Hello, World!"
"Hello, World!"
>>> fixValidationError "expected JSON value of type OpenApiString"
"expected JSON value of type string"
>>> fixValidationError "expected JSON value of type OpenApiNumber"
"expected JSON value of type number"
>>> fixValidationError "expected JSON value of type OpenApiInteger"
"expected JSON value of type integer"
>>> fixValidationError "expected JSON value of type OpenApiBoolean"
"expected JSON value of type boolean"