yesod-raml-0.1.0: RAML style route definitions for Yesod

Safe Haskell	Safe-Inferred
Language	Haskell2010

Yesod.Raml.Type

Documentation

type HandlerHint = Text Source

type Handler = Text Source

type Path = Text Source

type Method = Text Source

type ResponseCode = Text Source

type ContentType = Text Source

data RamlResponseBody Source

Constructors

RamlResponseBody
Fields res_schema :: Maybe Text res_example :: Maybe Text

Instances

Eq RamlResponseBody
Ord RamlResponseBody
Show RamlResponseBody
FromJSON RamlResponseBody

data RamlResponse Source

Constructors

RamlResponse
Fields res_description :: Maybe Text res_body :: Map ContentType RamlResponseBody

Instances

Eq RamlResponse
Ord RamlResponse
Show RamlResponse
FromJSON RamlResponse

data RamlMethod Source

Constructors

RamlMethod
Fields m_responses :: Map ResponseCode RamlResponse

Instances

Eq RamlMethod
Ord RamlMethod
Show RamlMethod
FromJSON RamlMethod

data RamlResource Source

Constructors

RamlResource
Fields r_displayName :: Maybe Text r_description :: Maybe Text r_handler :: Maybe Handler r_methods :: Map Method RamlMethod r_paths :: Map Path RamlResource

Instances

Eq RamlResource
Ord RamlResource
Show RamlResource
FromJSON RamlResource

data RamlDocumentation Source

Constructors

RamlDocumentation
Fields doc_title :: Text doc_content :: Text

Instances

Eq RamlDocumentation
Ord RamlDocumentation
Show RamlDocumentation
FromJSON RamlDocumentation

data Raml Source

Constructors

Raml
Fields title :: Text version :: Text baseUri :: Text documentation :: Maybe [RamlDocumentation] paths :: Map Path RamlResource

Instances

Eq Raml
Ord Raml
Show Raml
FromJSON Raml

data RamlRoute Source

Constructors

RamlRoute
Fields rr_pieces :: [Path] rr_handler :: Text rr_methods :: [Method]

Instances

Eq RamlRoute
Ord RamlRoute
Show RamlRoute