Safe Haskell	None
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

type Auth = Text Source

type HeaderKey = Text Source

type QueryParameter = Text Source

type UriParameter = Text Source

type SchemaKey = Text Source

type Schema = Text Source

type Protocol = Text Source

type MediaType = Text Source

type ResourceTypeKey = Text Source

type TraitKey = Text Source

data RamlResponseBody Source

Constructors

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

Instances

Eq RamlResponseBody Source
Ord RamlResponseBody Source
Show RamlResponseBody Source
Default RamlResponseBody Source

data RamlResponse Source

Constructors

RamlResponse
Fields res_description :: Maybe Text res_headers :: Map HeaderKey RamlNamedParameters res_body :: Map ContentType RamlResponseBody

Instances

Eq RamlResponse Source
Ord RamlResponse Source
Show RamlResponse Source
Default RamlResponse Source

data RamlNamedParameters Source

Constructors

RamlNamedParameters
Fields h_displayName :: Maybe Text h_description :: Maybe Text h_type :: Maybe Text h_enum :: [Text] h_pattern :: Maybe Text h_minLength :: Maybe Int h_maxLength :: Maybe Int h_minimum :: Maybe Int h_maximum :: Maybe Int h_example :: Maybe Text h_repeat :: Maybe Bool h_required :: Maybe Bool h_default :: Maybe Text

Instances

Eq RamlNamedParameters Source
Ord RamlNamedParameters Source
Show RamlNamedParameters Source
Default RamlNamedParameters Source

data RamlRequestBody Source

Constructors

RamlRequestBody
Fields req_formParameters :: Map QueryParameter RamlNamedParameters req_schema :: Maybe Schema req_example :: Maybe Text

Instances

Eq RamlRequestBody Source
Ord RamlRequestBody Source
Show RamlRequestBody Source
Default RamlRequestBody Source

data RamlMethod Source

Constructors

RamlMethod
Fields m_responses :: Map ResponseCode RamlResponse m_description :: Maybe Text m_headers :: Map HeaderKey RamlNamedParameters m_securedBy :: [Auth] m_protocols :: [Protocol] m_queryParameters :: Map QueryParameter RamlNamedParameters m_body :: Map MediaType RamlRequestBody m_is :: [TraitKey]

Instances

Eq RamlMethod Source
Ord RamlMethod Source
Show RamlMethod Source
Default RamlMethod Source

data RamlResourceType Source

Constructors

RamlResourceType
Fields rt_usage :: Maybe Text rt_displayName :: Maybe Text rt_description :: Maybe Text rt_methods :: Map Method RamlMethod rt_paths :: Map Path RamlResource rt_uriParameters :: Map UriParameter RamlNamedParameters rt_baseUriParameters :: Map UriParameter RamlNamedParameters

Instances

Eq RamlResourceType Source
Ord RamlResourceType Source
Show RamlResourceType Source
Default RamlResourceType Source

data RamlTrait Source

Constructors

RamlTrait
Fields t_usage :: Maybe Text t_responses :: Map ResponseCode RamlResponse t_description :: Maybe Text t_headers :: Map HeaderKey RamlNamedParameters t_securedBy :: [Auth] t_protocols :: [Protocol] t_queryParameters :: Map QueryParameter RamlNamedParameters t_body :: Map MediaType RamlRequestBody

Instances

Eq RamlTrait Source
Ord RamlTrait Source
Show RamlTrait Source
Monoid RamlTrait Source
Default RamlTrait Source

data RamlResource Source

Constructors

RamlResource
Fields r_displayName :: Maybe Text r_description :: Maybe Text r_handler :: Maybe Handler This is used for Yesod Route. r_methods :: Map Method RamlMethod r_paths :: Map Path RamlResource r_uriParameters :: Map UriParameter RamlNamedParameters r_baseUriParameters :: Map UriParameter RamlNamedParameters r_type :: Maybe ResourceTypeKey r_is :: [TraitKey]

Instances

Eq RamlResource Source
Ord RamlResource Source
Show RamlResource Source
Default RamlResource Source

data RamlDocumentation Source

Constructors

RamlDocumentation
Fields doc_title :: Text doc_content :: Text

Instances

Eq RamlDocumentation Source
Ord RamlDocumentation Source
Show RamlDocumentation Source

data RamlSecuritySchemes Source

Constructors

RamlSecuritySchemes
Fields ss_description :: Maybe Text ss_type :: Maybe Text ss_describedBy :: Maybe Text ss_settings :: Maybe Text

Instances

Eq RamlSecuritySchemes Source
Ord RamlSecuritySchemes Source
Show RamlSecuritySchemes Source
Default RamlSecuritySchemes Source

data Raml Source

Constructors

Raml

Fields

title :: Text
version :: Text
baseUri :: Text
baseUriParameters :: Map UriParameter RamlNamedParameters
protocols :: [Protocol]
mediaType :: Maybe MediaType
schemas :: [Map SchemaKey Schema]
uriParameters :: Map UriParameter RamlNamedParameters
documentation :: [RamlDocumentation]
paths :: Map Path RamlResource
securitySchemes :: [Map Auth RamlSecuritySchemes]
resourceTypes :: [Map ResourceTypeKey RamlResourceType]
traits :: [Map TraitKey RamlTrait]

Instances

Eq Raml Source
Ord Raml Source
Show Raml Source

data MethodEx Source

Constructors

MethodEx
Fields me_method :: String Uppercase method name me_example :: Maybe (ContentType, Text) This is used for output of mock.

Instances

Show MethodEx Source

data RouteEx Source

Constructors

RouteEx
Fields re_pieces :: [Piece String] re_handler :: String re_methods :: [MethodEx]

Instances

Show RouteEx Source