Data.Swagger.Internal.ParamSchema

Documentation

binaryParamSchema :: ParamSchema t

Default schema for binary data (any sequence of octets).

byteParamSchema :: ParamSchema t

Default schema for binary data (base64 encoded).

passwordParamSchema :: ParamSchema t

Default schema for password string. "password" format is used to hint UIs the input needs to be obscured.

class ToParamSchema a where

Convert a type into a plain ParamSchema.

An example type and instance:

{-# LANGUAGE OverloadedStrings #-}   -- allows to write Text literals

import Control.Lens

data Direction = Up | Down

instance ToParamSchema Direction where
  toParamSchema = mempty
     & type_ .~ SwaggerString
     & enum_ .~ [ "Up", "Down" ]

Instead of manually writing your ToParamSchema instance you can use a default generic implementation of toParamSchema.

To do that, simply add deriving Generic clause to your datatype and declare a ToParamSchema instance for your datatype without giving definition for toParamSchema.

For instance, the previous example can be simplified into this:

{-# LANGUAGE DeriveGeneric #-}

import GHC.Generics (Generic)

data Direction = Up | Down deriving Generic

instance ToParamSchema Direction

Minimal complete definition

Nothing

Methods

toParamSchema :: proxy a -> ParamSchema t

Convert a type into a plain parameter schema.

>>> encode $ toParamSchema (Proxy :: Proxy Integer)
"{\"type\":\"integer\"}"

Instances

ToParamSchema Bool

ToParamSchema Char

ToParamSchema Double

ToParamSchema Float

ToParamSchema Int

ToParamSchema Int8

ToParamSchema Int16

ToParamSchema Int32

ToParamSchema Int64

ToParamSchema Integer

ToParamSchema Word

ToParamSchema Word8

ToParamSchema Word16

ToParamSchema Word32

ToParamSchema Word64

ToParamSchema String

ToParamSchema ()

>>> encode $ toParamSchema (Proxy :: Proxy ())
"{\"type\":\"string\",\"enum\":[\"_\"]}"

ToParamSchema Scientific

ToParamSchema Text

ToParamSchema UTCTime

>>> toParamSchema (Proxy :: Proxy UTCTime) ^. format
Just "yyyy-mm-ddThh:MM:ssZ"

ToParamSchema Text

ToParamSchema All

ToParamSchema Any

ToParamSchema LocalTime

>>> toParamSchema (Proxy :: Proxy LocalTime) ^. format
Just "yyyy-mm-ddThh:MM:ss"

ToParamSchema ZonedTime

>>> toParamSchema (Proxy :: Proxy ZonedTime) ^. format
Just "yyyy-mm-ddThh:MM:ss+hhMM"

ToParamSchema NominalDiffTime

ToParamSchema Day

Format "date" corresponds to yyyy-mm-dd format.

ToParamSchema a => ToParamSchema [a]

ToParamSchema a => ToParamSchema (Dual a)

ToParamSchema a => ToParamSchema (Sum a)

ToParamSchema a => ToParamSchema (Product a)

ToParamSchema a => ToParamSchema (First a)

ToParamSchema a => ToParamSchema (Last a)

ToParamSchema a => ToParamSchema (Set a)

ToParamSchema a => ToParamSchema (Vector a)

ToParamSchema a => ToParamSchema (Vector a)

ToParamSchema a => ToParamSchema (Vector a)

ToParamSchema a => ToParamSchema (Vector a)

ToParamSchema a => ToParamSchema (HashSet a)

toParamSchemaBoundedIntegral :: forall proxy a t. (Bounded a, Integral a) => proxy a -> ParamSchema t

Default plain schema for Bounded, Integral types.

>>> encode $ toParamSchemaBoundedIntegral (Proxy :: Proxy Int8)
"{\"maximum\":127,\"minimum\":-128,\"type\":\"integer\"}"

timeParamSchema :: String -> ParamSchema t

genericToParamSchema :: forall proxy a t. (Generic a, GToParamSchema (Rep a)) => SchemaOptions -> proxy a -> ParamSchema t

A configurable generic ParamSchema creator.

>>> :set -XDeriveGeneric
>>> data Color = Red | Blue deriving Generic
>>> encode $ genericToParamSchema defaultSchemaOptions (Proxy :: Proxy Color)
"{\"type\":\"string\",\"enum\":[\"Red\",\"Blue\"]}"

class GToParamSchema f where

Methods

gtoParamSchema :: SchemaOptions -> proxy f -> ParamSchema t -> ParamSchema t

Instances

ToParamSchema c => GToParamSchema (K1 i c)

(GEnumParamSchema f, GEnumParamSchema g) => GToParamSchema ((:+:) f g)

GToParamSchema f => GToParamSchema (D1 d f)

GToParamSchema f => GToParamSchema (C1 c (S1 s f))

Constructor c => GToParamSchema (C1 c U1)

class GEnumParamSchema f where

Methods

genumParamSchema :: SchemaOptions -> proxy f -> ParamSchema t -> ParamSchema t

Instances

(GEnumParamSchema f, GEnumParamSchema g) => GEnumParamSchema ((:+:) f g)

Constructor c => GEnumParamSchema (C1 c U1)

data Proxy3 a b c

Constructors

Proxy3