Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Core.Types.Info

Contents

api updates
checks

Description

Types that describe route info. We use it to derive OpenApi schema or clients.

Synopsis

data RouteInfo = RouteInfo {
- method :: Maybe Method
- inputs :: [Describe RouteInput]
- output :: RouteOutput
- tags :: [Text]
- description :: Text
- summary :: Text
}
data RouteInput
- = ReqBodyInput MediaType SchemaDefs
- | RawBodyInput
- | CaptureInput Text Schema
- | QueryInput IsRequired Text Schema
- | QueryFlagInput Text
- | HeaderInput IsRequired Text Schema
data Describe a = Describe {
- description :: Maybe Text
- content :: a
}
noDescription :: a -> Describe a
getInputType :: RouteInfo -> Maybe MediaType
data RouteOutput = RouteOutput {
- status :: Status
- media :: MediaType
- schema :: OutputSchema
}
newtype IsRequired = IsRequired Bool
type OutputSchema = SchemaDefs
type InputSchema = SchemaDefs
data SchemaDefs = SchemaDefs {
- defs :: Definitions Schema
- ref :: Maybe (Referenced Schema)
}
emptySchemaDefs :: SchemaDefs
toSchemaDefs :: forall a. ToSchema a => SchemaDefs
addRouteInput :: RouteInput -> RouteInfo -> RouteInfo
setOutputMedia :: MediaType -> RouteInfo -> RouteInfo
setMethod :: Method -> MediaType -> RouteInfo -> RouteInfo
emptyRouteInfo :: RouteInfo
describeInfoInputs :: [(Text, Text)] -> RouteInfo -> RouteInfo
addBodyInfo :: forall ty a. (ToMediaType ty, ToSchema a) => RouteInfo -> RouteInfo
addHeaderInfo :: forall sym a. (KnownSymbol sym, ToParamSchema a) => RouteInfo -> RouteInfo
addOptionalHeaderInfo :: forall sym a. (KnownSymbol sym, ToParamSchema a) => RouteInfo -> RouteInfo
addQueryInfo :: forall sym a. (KnownSymbol sym, ToParamSchema a) => RouteInfo -> RouteInfo
addQueryFlagInfo :: forall sym. KnownSymbol sym => RouteInfo -> RouteInfo
addOptionalInfo :: forall sym a. (KnownSymbol sym, ToParamSchema a) => RouteInfo -> RouteInfo
addCaptureInfo :: forall sym a. (KnownSymbol sym, ToParamSchema a) => RouteInfo -> RouteInfo
routeHasQuery :: Text -> RouteInfo -> Bool
routeHasOptionalQuery :: Text -> RouteInfo -> Bool
routeHasQueryFlag :: Text -> RouteInfo -> Bool
routeHasCapture :: Text -> RouteInfo -> Bool

Documentation

data RouteInfo Source #

Information on route

Constructors

RouteInfo
Fields method :: Maybe Method http method inputs :: [Describe RouteInput] route inputs output :: RouteOutput route outputs tags :: [Text] open-api tags description :: Text open-api description summary :: Text open-api summary

Instances

Instances details

Show RouteInfo Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> RouteInfo -> ShowS # show :: RouteInfo -> String # showList :: [RouteInfo] -> ShowS #
Eq RouteInfo Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: RouteInfo -> RouteInfo -> Bool # (/=) :: RouteInfo -> RouteInfo -> Bool #

data RouteInput Source #

Route inputs

Constructors

ReqBodyInput MediaType SchemaDefs
RawBodyInput
CaptureInput Text Schema
QueryInput IsRequired Text Schema
QueryFlagInput Text
HeaderInput IsRequired Text Schema

Instances

Instances details

Show RouteInput Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> RouteInput -> ShowS # show :: RouteInput -> String # showList :: [RouteInput] -> ShowS #
Eq RouteInput Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: RouteInput -> RouteInput -> Bool # (/=) :: RouteInput -> RouteInput -> Bool #

data Describe a Source #

Values which have human-readable description.

Constructors

Describe
Fields description :: Maybe Text content :: a

Instances

Instances details

Show a => Show (Describe a) Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> Describe a -> ShowS # show :: Describe a -> String # showList :: [Describe a] -> ShowS #
Eq a => Eq (Describe a) Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: Describe a -> Describe a -> Bool # (/=) :: Describe a -> Describe a -> Bool #

noDescription :: a -> Describe a Source #

no description provided

getInputType :: RouteInfo -> Maybe MediaType Source #

Get input media-type

data RouteOutput Source #

Route output

Constructors

RouteOutput
Fields status :: Status http status media :: MediaType media type schema :: OutputSchema open-api schema

Instances

Instances details

Show RouteOutput Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> RouteOutput -> ShowS # show :: RouteOutput -> String # showList :: [RouteOutput] -> ShowS #
Eq RouteOutput Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: RouteOutput -> RouteOutput -> Bool # (/=) :: RouteOutput -> RouteOutput -> Bool #

newtype IsRequired Source #

Constructors

IsRequired Bool

Instances

Instances details

Show IsRequired Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> IsRequired -> ShowS # show :: IsRequired -> String # showList :: [IsRequired] -> ShowS #
Eq IsRequired Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: IsRequired -> IsRequired -> Bool # (/=) :: IsRequired -> IsRequired -> Bool #

type OutputSchema = SchemaDefs Source #

Output schema

type InputSchema = SchemaDefs Source #

Input schema

data SchemaDefs Source #

Schem definition with references to the used sub-values

Constructors

SchemaDefs
Fields defs :: Definitions Schema ref :: Maybe (Referenced Schema)

Instances

Instances details

Show SchemaDefs Source #
Instance details Defined in Mig.Core.Types.Info Methods showsPrec :: Int -> SchemaDefs -> ShowS # show :: SchemaDefs -> String # showList :: [SchemaDefs] -> ShowS #
Eq SchemaDefs Source #
Instance details Defined in Mig.Core.Types.Info Methods (==) :: SchemaDefs -> SchemaDefs -> Bool # (/=) :: SchemaDefs -> SchemaDefs -> Bool #