raml-0.1.0: RESTful API Modeling Language (RAML) library for Haskell

Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Raml.Types

Documentation

type Error = String Source

type Uri = Text Source

type Path = Text Source

data RamlProtocol Source

Constructors

HTTP
HTTPS

Instances

Eq RamlProtocol
Ord RamlProtocol
Show RamlProtocol
FromJSON RamlProtocol

data RamlParameterType Source

Constructors

RamlParameterString
Fields paramEnum :: Maybe [Text] paramPattern :: Maybe Text paramMaxLength :: Maybe Int paramMinLength :: Maybe Int paramExampleS :: Maybe Text paramDefaultS :: Maybe Text
RamlParameterInteger
Fields paramMaximumI :: Maybe Int paramMinimumI :: Maybe Int paramExampleI :: Maybe Int paramDefaultI :: Maybe Int
RamlParameterNumber
Fields paramMaximumN :: Maybe Double paramMinimumN :: Maybe Double paramExampleN :: Maybe Double paramDefaultN :: Maybe Double
RamlParameterDate
Fields paramExampleD :: Maybe Text paramDefaultD :: Maybe Text
RamlParameterBoolean
Fields paramExampleB :: Maybe Bool paramDefaultB :: Maybe Bool
RamlParameterFile
Fields paramExample :: Maybe Text paramDefault :: Maybe Text

Instances

Eq RamlParameterType
Show RamlParameterType

data RamlParameter Source

Constructors

RamlParameter
Fields paramDisplayName :: Maybe Text paramDescription :: Maybe Text paramRepeat :: Maybe Bool paramRequired :: Maybe Bool paramType :: RamlParameterType

Instances

Eq RamlParameter
Show RamlParameter
FromJSON RamlParameter

data RamlTrait Source

Constructors

Instances

Eq RamlTrait
Show RamlTrait
FromJSON RamlTrait

data RamlSecurityScheme Source

Constructors

RamlSecurityScheme

Instances

Eq RamlSecurityScheme
Show RamlSecurityScheme
FromJSON RamlSecurityScheme

data RamlBody Source

Constructors

RamlBody
Fields bodySchema :: Maybe Text bodyExample :: Maybe Text bodyFormParameters :: Maybe (HashMap Text RamlParameter)

Instances

Eq RamlBody
Show RamlBody
FromJSON RamlBody

data RamlResponse Source

Constructors

RamlResponse
Fields respBody :: Maybe (HashMap Text RamlBody) respDescription :: Maybe Text respHeaders :: Maybe (HashMap Text RamlParameter)

Instances

Eq RamlResponse
Show RamlResponse
FromJSON RamlResponse

data RamlMethod Source

Constructors

RamlMethod
Fields methDescription :: Maybe Text methHeaders :: Maybe (HashMap Text RamlParameter) methProtocols :: Maybe [RamlProtocol] methQueryParameters :: Maybe (HashMap Text RamlParameter) methBody :: Maybe (HashMap Text RamlBody) methResponses :: Maybe (HashMap Text RamlResponse) methIs :: Maybe [RamlTrait]

Instances

Eq RamlMethod
Show RamlMethod
FromJSON RamlMethod

data RamlResource Source

Constructors

RamlResource
Fields resDisplayName :: Maybe Text resDescription :: Maybe Text resUriParameters :: Maybe (HashMap Text RamlParameter) resBaseUriParameters :: Maybe (HashMap Text RamlParameter) resPost :: Maybe RamlMethod resGet :: Maybe RamlMethod resPut :: Maybe RamlMethod resDelete :: Maybe RamlMethod resResources :: HashMap Path RamlResource resIs :: Maybe [RamlTrait]

Instances

Eq RamlResource
Show RamlResource
FromJSON RamlResource

data RamlDocumentation Source

Constructors

RamlDocumentation
Fields docTitle :: Text docContent :: Text

Instances

Eq RamlDocumentation
Ord RamlDocumentation
Show RamlDocumentation
FromJSON RamlDocumentation

data Raml Source

Constructors

Raml
Fields ramlTitle :: Text ramlVersion :: Maybe Text ramlBaseUri :: Maybe Uri baseUriParameters :: Maybe (HashMap Text RamlParameter) ramlProtocols :: Maybe [RamlProtocol] ramlMediaType :: Maybe Text ramlDocumentation :: Maybe [RamlDocumentation] ramlResources :: HashMap Path RamlResource

Instances

Eq Raml
Show Raml
FromJSON Raml