OryHydra.Core

OryHydraConfig

data OryHydraConfig

Constructors

OryHydraConfig

Fields

• configHost :: ByteString

  host supplied in the Request

• configUserAgent :: Text

  user-agent supplied in the Request

• configLogExecWithContext :: LogExecWithContext

  Run a block using a Logger instance

• configLogContext :: LogContext

  Configures the logger

• configAuthMethods :: [AnyAuthMethod]

  List of configured auth methods

• configValidateAuthMethods :: Bool

  throw exceptions if auth methods are not configured

• configQueryExtraUnreserved :: ByteString

  Configures additional querystring characters which must not be URI encoded, e.g. + or :

Instances

Show OryHydraConfig

display the config

Defined in OryHydra.Core

Methods

showsPrec :: Int -> OryHydraConfig -> ShowS

show :: OryHydraConfig -> String

showList :: [OryHydraConfig] -> ShowS

newConfig :: IO OryHydraConfig

constructs a default OryHydraConfig

configHost:

http://localhost

configUserAgent:

"ory-hydra-client/0.1.0.0"

addAuthMethod :: AuthMethod auth => OryHydraConfig -> auth -> OryHydraConfig

updates config use AuthMethod on matching requests

withStdoutLogging :: OryHydraConfig -> IO OryHydraConfig

updates the config to use stdout logging

withStderrLogging :: OryHydraConfig -> IO OryHydraConfig

updates the config to use stderr logging

withNoLogging :: OryHydraConfig -> OryHydraConfig

updates the config to disable logging

OryHydraRequest

data OryHydraRequest req contentType res accept

Represents a request.

Type Variables:

• req - request operation
• contentType - MimeType associated with request body
• res - response model
• accept - MimeType associated with response body

Constructors

OryHydraRequest

Fields

• rMethod :: Method

  Method of OryHydraRequest

• rUrlPath :: [ByteString]

  Endpoint of OryHydraRequest

• rParams :: Params

  params of OryHydraRequest

• rAuthTypes :: [TypeRep]

  types of auth methods

Instances

Show (OryHydraRequest req contentType res accept)

Defined in OryHydra.Core

Methods

showsPrec :: Int -> OryHydraRequest req contentType res accept -> ShowS

show :: OryHydraRequest req contentType res accept -> String

showList :: [OryHydraRequest req contentType res accept] -> ShowS

rMethodL :: Lens_' (OryHydraRequest req contentType res accept) Method

rMethod Lens

rUrlPathL :: Lens_' (OryHydraRequest req contentType res accept) [ByteString]

rUrlPath Lens

rParamsL :: Lens_' (OryHydraRequest req contentType res accept) Params

rParams Lens

rAuthTypesL :: Lens_' (OryHydraRequest req contentType res accept) [TypeRep]

rParams Lens

HasBodyParam

class HasBodyParam req param where

Designates the body parameter of a request

Minimal complete definition

Nothing

Methods

setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => OryHydraRequest req contentType res accept -> param -> OryHydraRequest req contentType res accept

Instances

HasBodyParam CreateJsonWebKeySet0 CreateJsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes CreateJsonWebKeySet0 contentType, MimeRender contentType CreateJsonWebKeySet) => OryHydraRequest CreateJsonWebKeySet0 contentType res accept -> CreateJsonWebKeySet -> OryHydraRequest CreateJsonWebKeySet0 contentType res accept

HasBodyParam SetJsonWebKey JsonWebKey

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKey contentType, MimeRender contentType JsonWebKey) => OryHydraRequest SetJsonWebKey contentType res accept -> JsonWebKey -> OryHydraRequest SetJsonWebKey contentType res accept

HasBodyParam SetJsonWebKeySet JsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKeySet contentType, MimeRender contentType JsonWebKeySet) => OryHydraRequest SetJsonWebKeySet contentType res accept -> JsonWebKeySet -> OryHydraRequest SetJsonWebKeySet contentType res accept

HasBodyParam AcceptOAuth2ConsentRequest0 AcceptOAuth2ConsentRequest

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes AcceptOAuth2ConsentRequest0 contentType, MimeRender contentType AcceptOAuth2ConsentRequest) => OryHydraRequest AcceptOAuth2ConsentRequest0 contentType res accept -> AcceptOAuth2ConsentRequest -> OryHydraRequest AcceptOAuth2ConsentRequest0 contentType res accept

HasBodyParam AcceptOAuth2LoginRequest0 AcceptOAuth2LoginRequest

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes AcceptOAuth2LoginRequest0 contentType, MimeRender contentType AcceptOAuth2LoginRequest) => OryHydraRequest AcceptOAuth2LoginRequest0 contentType res accept -> AcceptOAuth2LoginRequest -> OryHydraRequest AcceptOAuth2LoginRequest0 contentType res accept

HasBodyParam CreateOAuth2Client OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes CreateOAuth2Client contentType, MimeRender contentType OAuth2Client) => OryHydraRequest CreateOAuth2Client contentType res accept -> OAuth2Client -> OryHydraRequest CreateOAuth2Client contentType res accept

HasBodyParam PatchOAuth2Client JsonPatch2

Body Param JsonPatch - OAuth 2.0 Client JSON Patch Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes PatchOAuth2Client contentType, MimeRender contentType JsonPatch2) => OryHydraRequest PatchOAuth2Client contentType res accept -> JsonPatch2 -> OryHydraRequest PatchOAuth2Client contentType res accept

HasBodyParam RejectOAuth2ConsentRequest RejectOAuth2Request

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes RejectOAuth2ConsentRequest contentType, MimeRender contentType RejectOAuth2Request) => OryHydraRequest RejectOAuth2ConsentRequest contentType res accept -> RejectOAuth2Request -> OryHydraRequest RejectOAuth2ConsentRequest contentType res accept

HasBodyParam RejectOAuth2LoginRequest RejectOAuth2Request

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes RejectOAuth2LoginRequest contentType, MimeRender contentType RejectOAuth2Request) => OryHydraRequest RejectOAuth2LoginRequest contentType res accept -> RejectOAuth2Request -> OryHydraRequest RejectOAuth2LoginRequest contentType res accept

HasBodyParam SetOAuth2Client OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes SetOAuth2Client contentType, MimeRender contentType OAuth2Client) => OryHydraRequest SetOAuth2Client contentType res accept -> OAuth2Client -> OryHydraRequest SetOAuth2Client contentType res accept

HasBodyParam SetOAuth2ClientLifespans OAuth2ClientTokenLifespans

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes SetOAuth2ClientLifespans contentType, MimeRender contentType OAuth2ClientTokenLifespans) => OryHydraRequest SetOAuth2ClientLifespans contentType res accept -> OAuth2ClientTokenLifespans -> OryHydraRequest SetOAuth2ClientLifespans contentType res accept

HasBodyParam TrustOAuth2JwtGrantIssuer0 TrustOAuth2JwtGrantIssuer

Defined in OryHydra.API.OAuth2

Methods

setBodyParam :: (Consumes TrustOAuth2JwtGrantIssuer0 contentType, MimeRender contentType TrustOAuth2JwtGrantIssuer) => OryHydraRequest TrustOAuth2JwtGrantIssuer0 contentType res accept -> TrustOAuth2JwtGrantIssuer -> OryHydraRequest TrustOAuth2JwtGrantIssuer0 contentType res accept

HasBodyParam CreateOidcDynamicClient OAuth2Client

Body Param OAuth2Client - Dynamic Client Registration Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes CreateOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest CreateOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest CreateOidcDynamicClient contentType res accept

HasBodyParam SetOidcDynamicClient OAuth2Client

Body Param OAuth2Client - OAuth 2.0 Client Request Body

Defined in OryHydra.API.Oidc

Methods

setBodyParam :: (Consumes SetOidcDynamicClient contentType, MimeRender contentType OAuth2Client) => OryHydraRequest SetOidcDynamicClient contentType res accept -> OAuth2Client -> OryHydraRequest SetOidcDynamicClient contentType res accept

HasOptionalParam

class HasOptionalParam req param where

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: OryHydraRequest req contentType res accept -> param -> OryHydraRequest req contentType res accept

Apply an optional parameter to a request

(-&-) :: OryHydraRequest req contentType res accept -> param -> OryHydraRequest req contentType res accept infixl 2

infix operator / alias for addOptionalParam

Instances

HasOptionalParam IntrospectOAuth2Token Scope

Optional Param "scope" - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest IntrospectOAuth2Token contentType res accept -> Scope -> OryHydraRequest IntrospectOAuth2Token contentType res accept

(-&-) :: OryHydraRequest IntrospectOAuth2Token contentType res accept -> Scope -> OryHydraRequest IntrospectOAuth2Token contentType res accept

HasOptionalParam ListOAuth2Clients ClientName

Optional Param "client_name" - The name of the clients to filter by.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> ClientName -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> ClientName -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2Clients Owner

Optional Param "owner" - The owner of the clients to filter by.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> Owner -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> Owner -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2Clients PageSize

Optional Param "page_size" - Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageSize -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageSize -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2Clients PageToken

Optional Param "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageToken -> OryHydraRequest ListOAuth2Clients contentType res accept

(-&-) :: OryHydraRequest ListOAuth2Clients contentType res accept -> PageToken -> OryHydraRequest ListOAuth2Clients contentType res accept

HasOptionalParam ListOAuth2ConsentSessions LoginSessionId

Optional Param "login_session_id" - The login session id to list the consent sessions for.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> LoginSessionId -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> LoginSessionId -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

HasOptionalParam ListOAuth2ConsentSessions PageSize

Optional Param "page_size" - Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageSize -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageSize -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

HasOptionalParam ListOAuth2ConsentSessions PageToken

Optional Param "page_token" - Next Page Token The next page token. For details on pagination please head over to the pagination documentation.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageToken -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest ListOAuth2ConsentSessions contentType res accept -> PageToken -> OryHydraRequest ListOAuth2ConsentSessions contentType res accept

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers DefaultItems

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> DefaultItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> DefaultItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers Issuer

Optional Param "issuer" - If optional "issuer" is supplied, only jwt-bearer grants with this issuer will be returned.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> Issuer -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> Issuer -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

HasOptionalParam ListTrustedOAuth2JwtGrantIssuers MaxItems

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> MaxItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

(-&-) :: OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept -> MaxItems -> OryHydraRequest ListTrustedOAuth2JwtGrantIssuers contentType res accept

HasOptionalParam Oauth2TokenExchange ClientId

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> ClientId -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> ClientId -> OryHydraRequest Oauth2TokenExchange contentType res accept

HasOptionalParam Oauth2TokenExchange Code

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> Code -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> Code -> OryHydraRequest Oauth2TokenExchange contentType res accept

HasOptionalParam Oauth2TokenExchange RedirectUri

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RedirectUri -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RedirectUri -> OryHydraRequest Oauth2TokenExchange contentType res accept

HasOptionalParam Oauth2TokenExchange RefreshToken

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RefreshToken -> OryHydraRequest Oauth2TokenExchange contentType res accept

(-&-) :: OryHydraRequest Oauth2TokenExchange contentType res accept -> RefreshToken -> OryHydraRequest Oauth2TokenExchange contentType res accept

HasOptionalParam RevokeOAuth2ConsentSessions All

Optional Param "all" - Revoke All Consent Sessions If set to true deletes all consent sessions by the Subject that have been granted.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> All -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> All -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

HasOptionalParam RevokeOAuth2ConsentSessions Client

Optional Param "client" - OAuth 2.0 Client ID If set, deletes only those consent sessions that have been granted to the specified OAuth 2.0 Client ID.

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> Client -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept -> Client -> OryHydraRequest RevokeOAuth2ConsentSessions contentType res accept

HasOptionalParam RevokeOAuth2Token ClientId

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientId -> OryHydraRequest RevokeOAuth2Token contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientId -> OryHydraRequest RevokeOAuth2Token contentType res accept

HasOptionalParam RevokeOAuth2Token ClientSecret

Defined in OryHydra.API.OAuth2

Methods

applyOptionalParam :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientSecret -> OryHydraRequest RevokeOAuth2Token contentType res accept

(-&-) :: OryHydraRequest RevokeOAuth2Token contentType res accept -> ClientSecret -> OryHydraRequest RevokeOAuth2Token contentType res accept

data Params

Request Params

Constructors

Params

Fields

• paramsQuery :: Query
• paramsHeaders :: RequestHeaders
• paramsBody :: ParamBody

Instances

Show Params

Defined in OryHydra.Core

Methods

showsPrec :: Int -> Params -> ShowS

show :: Params -> String

showList :: [Params] -> ShowS

paramsQueryL :: Lens_' Params Query

paramsQuery Lens

paramsHeadersL :: Lens_' Params RequestHeaders

paramsHeaders Lens

paramsBodyL :: Lens_' Params ParamBody

paramsBody Lens

data ParamBody

Request Body

Constructors

ParamBodyNone

ParamBodyB ByteString

ParamBodyBL ByteString

ParamBodyFormUrlEncoded Form

ParamBodyMultipartFormData [Part]

Instances

Show ParamBody

Defined in OryHydra.Core

Methods

showsPrec :: Int -> ParamBody -> ShowS

show :: ParamBody -> String

showList :: [ParamBody] -> ShowS

OryHydraRequest Utils

_mkRequest

Arguments

:: Method

Method

-> [ByteString]

Endpoint

-> OryHydraRequest req contentType res accept

req: Request Type, res: Response Type

_mkParams :: Params

setHeader :: OryHydraRequest req contentType res accept -> [Header] -> OryHydraRequest req contentType res accept

addHeader :: OryHydraRequest req contentType res accept -> [Header] -> OryHydraRequest req contentType res accept

removeHeader :: OryHydraRequest req contentType res accept -> [HeaderName] -> OryHydraRequest req contentType res accept

_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => OryHydraRequest req contentType res accept -> OryHydraRequest req contentType res accept

_setAcceptHeader :: forall req contentType res accept. MimeType accept => OryHydraRequest req contentType res accept -> OryHydraRequest req contentType res accept

setQuery :: OryHydraRequest req contentType res accept -> [QueryItem] -> OryHydraRequest req contentType res accept

addQuery :: OryHydraRequest req contentType res accept -> [QueryItem] -> OryHydraRequest req contentType res accept

addForm :: OryHydraRequest req contentType res accept -> Form -> OryHydraRequest req contentType res accept

_addMultiFormPart :: OryHydraRequest req contentType res accept -> Part -> OryHydraRequest req contentType res accept

_setBodyBS :: OryHydraRequest req contentType res accept -> ByteString -> OryHydraRequest req contentType res accept

_setBodyLBS :: OryHydraRequest req contentType res accept -> ByteString -> OryHydraRequest req contentType res accept

_hasAuthType :: AuthMethod authMethod => OryHydraRequest req contentType res accept -> Proxy authMethod -> OryHydraRequest req contentType res accept

Params Utils

toPath :: ToHttpApiData a => a -> ByteString

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]

toForm :: ToHttpApiData v => (ByteString, v) -> Form

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]

toPartialEscapeQuery :: ByteString -> Query -> PartialEscapeQuery

OpenAPI CollectionFormat Utils

data CollectionFormat

Determines the format of the array if type array is used.

Constructors

CommaSeparated

CSV format for multiple parameters.

SpaceSeparated

Also called SSV

TabSeparated

Also called TSV

PipeSeparated

`value1|value2|value2`

MultiParamArray

Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (Query) or "formData" (Form)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]

AuthMethods

class Typeable a => AuthMethod a where

Provides a method to apply auth methods to requests

Methods

applyAuthMethod :: OryHydraConfig -> a -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

Instances

AuthMethod AnyAuthMethod

Defined in OryHydra.Core

Methods

applyAuthMethod :: OryHydraConfig -> AnyAuthMethod -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

AuthMethod AuthBasicBasic

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthBasicBasic -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

AuthMethod AuthBasicBearer

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthBasicBearer -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

AuthMethod AuthOAuthOauth2

Defined in OryHydra.Model

Methods

applyAuthMethod :: OryHydraConfig -> AuthOAuthOauth2 -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

data AnyAuthMethod

An existential wrapper for any AuthMethod

Constructors

forall a.AuthMethod a => AnyAuthMethod a

Instances

AuthMethod AnyAuthMethod

Defined in OryHydra.Core

Methods

applyAuthMethod :: OryHydraConfig -> AnyAuthMethod -> OryHydraRequest req contentType res accept -> IO (OryHydraRequest req contentType res accept)

data AuthMethodException

indicates exceptions related to AuthMethods

Constructors

AuthMethodException String

Instances

Exception AuthMethodException

Defined in OryHydra.Core

Methods

toException :: AuthMethodException -> SomeException

fromException :: SomeException -> Maybe AuthMethodException

displayException :: AuthMethodException -> String

Show AuthMethodException

Defined in OryHydra.Core

Methods

showsPrec :: Int -> AuthMethodException -> ShowS

show :: AuthMethodException -> String

showList :: [AuthMethodException] -> ShowS

_applyAuthMethods :: OryHydraRequest req contentType res accept -> OryHydraConfig -> IO (OryHydraRequest req contentType res accept)

apply all matching AuthMethods in config to request

Utils

_omitNulls :: [(Key, Value)] -> Value

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text])

Encodes fields using WH.toQueryParam

_emptyToNothing :: Maybe String -> Maybe String

Collapse (Just "") to Nothing

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a

Collapse (Just mempty) to Nothing

DateTime Formatting

newtype DateTime

Constructors

DateTime

Fields

• unDateTime :: UTCTime

Instances

FromJSON DateTime

Defined in OryHydra.Core

Methods

parseJSON :: Value -> Parser DateTime

parseJSONList :: Value -> Parser [DateTime]

ToJSON DateTime

Defined in OryHydra.Core

Methods

toJSON :: DateTime -> Value

toEncoding :: DateTime -> Encoding

toJSONList :: [DateTime] -> Value

toEncodingList :: [DateTime] -> Encoding

Data DateTime

Defined in OryHydra.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateTime -> c DateTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateTime

toConstr :: DateTime -> Constr

dataTypeOf :: DateTime -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateTime)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateTime)

gmapT :: (forall b. Data b => b -> b) -> DateTime -> DateTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r

gmapQ :: (forall d. Data d => d -> u) -> DateTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DateTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

Show DateTime

Defined in OryHydra.Core

Methods

showsPrec :: Int -> DateTime -> ShowS

show :: DateTime -> String

showList :: [DateTime] -> ShowS

NFData DateTime

Defined in OryHydra.Core

Methods

rnf :: DateTime -> ()

Eq DateTime

Defined in OryHydra.Core

Methods

(==) :: DateTime -> DateTime -> Bool

(/=) :: DateTime -> DateTime -> Bool

Ord DateTime

Defined in OryHydra.Core

Methods

compare :: DateTime -> DateTime -> Ordering

(<) :: DateTime -> DateTime -> Bool

(<=) :: DateTime -> DateTime -> Bool

(>) :: DateTime -> DateTime -> Bool

(>=) :: DateTime -> DateTime -> Bool

max :: DateTime -> DateTime -> DateTime

min :: DateTime -> DateTime -> DateTime

FromHttpApiData DateTime

Defined in OryHydra.Core

Methods

parseUrlPiece :: Text -> Either Text DateTime

parseHeader :: ByteString -> Either Text DateTime

parseQueryParam :: Text -> Either Text DateTime

ToHttpApiData DateTime

Defined in OryHydra.Core

Methods

toUrlPiece :: DateTime -> Text

toEncodedUrlPiece :: DateTime -> Builder

toHeader :: DateTime -> ByteString

toQueryParam :: DateTime -> Text

MimeRender MimeMultipartFormData DateTime

Defined in OryHydra.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> DateTime -> ByteString

mimeRender' :: MimeMultipartFormData -> DateTime -> ByteString

_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t

parse an ISO8601 date-time string

Date Formatting

newtype Date

Constructors

Date

Fields

• unDate :: Day

Instances

FromJSON Date

Defined in OryHydra.Core

Methods

parseJSON :: Value -> Parser Date

parseJSONList :: Value -> Parser [Date]

ToJSON Date

Defined in OryHydra.Core

Methods

toJSON :: Date -> Value

toEncoding :: Date -> Encoding

toJSONList :: [Date] -> Value

toEncodingList :: [Date] -> Encoding

Data Date

Defined in OryHydra.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date

toConstr :: Date -> Constr

dataTypeOf :: Date -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date)

gmapT :: (forall b. Data b => b -> b) -> Date -> Date

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r

gmapQ :: (forall d. Data d => d -> u) -> Date -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date

Enum Date

Defined in OryHydra.Core

Methods

succ :: Date -> Date

pred :: Date -> Date

toEnum :: Int -> Date

fromEnum :: Date -> Int

enumFrom :: Date -> [Date]

enumFromThen :: Date -> Date -> [Date]

enumFromTo :: Date -> Date -> [Date]

enumFromThenTo :: Date -> Date -> Date -> [Date]

Ix Date

Defined in OryHydra.Core

Methods

range :: (Date, Date) -> [Date]

index :: (Date, Date) -> Date -> Int

unsafeIndex :: (Date, Date) -> Date -> Int

inRange :: (Date, Date) -> Date -> Bool

rangeSize :: (Date, Date) -> Int

unsafeRangeSize :: (Date, Date) -> Int

Show Date

Defined in OryHydra.Core

Methods

showsPrec :: Int -> Date -> ShowS

show :: Date -> String

showList :: [Date] -> ShowS

NFData Date

Defined in OryHydra.Core

Methods

rnf :: Date -> ()

Eq Date

Defined in OryHydra.Core

Methods

(==) :: Date -> Date -> Bool

(/=) :: Date -> Date -> Bool

Ord Date

Defined in OryHydra.Core

Methods

compare :: Date -> Date -> Ordering

(<) :: Date -> Date -> Bool

(<=) :: Date -> Date -> Bool

(>) :: Date -> Date -> Bool

(>=) :: Date -> Date -> Bool

max :: Date -> Date -> Date

min :: Date -> Date -> Date

FromHttpApiData Date

Defined in OryHydra.Core

Methods

parseUrlPiece :: Text -> Either Text Date

parseHeader :: ByteString -> Either Text Date

parseQueryParam :: Text -> Either Text Date

ToHttpApiData Date

Defined in OryHydra.Core

Methods

toUrlPiece :: Date -> Text

toEncodedUrlPiece :: Date -> Builder

toHeader :: Date -> ByteString

toQueryParam :: Date -> Text

MimeRender MimeMultipartFormData Date

Defined in OryHydra.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> Date -> ByteString

mimeRender' :: MimeMultipartFormData -> Date -> ByteString

_readDate :: MonadFail m => String -> m Date

TI.parseTimeM True TI.defaultTimeLocale "%Y-%m-%d"

_showDate :: FormatTime t => t -> String

TI.formatTime TI.defaultTimeLocale "%Y-%m-%d"

Byte/Binary Formatting

newtype ByteArray

base64 encoded characters

Constructors

ByteArray

Fields

• unByteArray :: ByteString

Instances

FromJSON ByteArray

Defined in OryHydra.Core

Methods

parseJSON :: Value -> Parser ByteArray

parseJSONList :: Value -> Parser [ByteArray]

ToJSON ByteArray

Defined in OryHydra.Core

Methods

toJSON :: ByteArray -> Value

toEncoding :: ByteArray -> Encoding

toJSONList :: [ByteArray] -> Value

toEncodingList :: [ByteArray] -> Encoding

Data ByteArray

Defined in OryHydra.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteArray -> c ByteArray

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteArray

toConstr :: ByteArray -> Constr

dataTypeOf :: ByteArray -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteArray)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteArray)

gmapT :: (forall b. Data b => b -> b) -> ByteArray -> ByteArray

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r

gmapQ :: (forall d. Data d => d -> u) -> ByteArray -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteArray -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

Show ByteArray

Defined in OryHydra.Core

Methods

showsPrec :: Int -> ByteArray -> ShowS

show :: ByteArray -> String

showList :: [ByteArray] -> ShowS

NFData ByteArray

Defined in OryHydra.Core

Methods

rnf :: ByteArray -> ()

Eq ByteArray

Defined in OryHydra.Core

Methods

(==) :: ByteArray -> ByteArray -> Bool

(/=) :: ByteArray -> ByteArray -> Bool

Ord ByteArray

Defined in OryHydra.Core

Methods

compare :: ByteArray -> ByteArray -> Ordering

(<) :: ByteArray -> ByteArray -> Bool

(<=) :: ByteArray -> ByteArray -> Bool

(>) :: ByteArray -> ByteArray -> Bool

(>=) :: ByteArray -> ByteArray -> Bool

max :: ByteArray -> ByteArray -> ByteArray

min :: ByteArray -> ByteArray -> ByteArray

FromHttpApiData ByteArray

Defined in OryHydra.Core

Methods

parseUrlPiece :: Text -> Either Text ByteArray

parseHeader :: ByteString -> Either Text ByteArray

parseQueryParam :: Text -> Either Text ByteArray

ToHttpApiData ByteArray

Defined in OryHydra.Core

Methods

toUrlPiece :: ByteArray -> Text

toEncodedUrlPiece :: ByteArray -> Builder

toHeader :: ByteArray -> ByteString

toQueryParam :: ByteArray -> Text

MimeRender MimeMultipartFormData ByteArray

Defined in OryHydra.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> ByteArray -> ByteString

mimeRender' :: MimeMultipartFormData -> ByteArray -> ByteString

_readByteArray :: MonadFail m => Text -> m ByteArray

read base64 encoded characters

_showByteArray :: ByteArray -> Text

show base64 encoded characters

newtype Binary

any sequence of octets

Constructors

Binary

Fields

• unBinary :: ByteString

Instances

FromJSON Binary

Defined in OryHydra.Core

Methods

parseJSON :: Value -> Parser Binary

parseJSONList :: Value -> Parser [Binary]

ToJSON Binary

Defined in OryHydra.Core

Methods

toJSON :: Binary -> Value

toEncoding :: Binary -> Encoding

toJSONList :: [Binary] -> Value

toEncodingList :: [Binary] -> Encoding

Data Binary

Defined in OryHydra.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binary -> c Binary

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binary

toConstr :: Binary -> Constr

dataTypeOf :: Binary -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binary)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binary)

gmapT :: (forall b. Data b => b -> b) -> Binary -> Binary

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r

gmapQ :: (forall d. Data d => d -> u) -> Binary -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Binary -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binary -> m Binary

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary

Show Binary

Defined in OryHydra.Core

Methods

showsPrec :: Int -> Binary -> ShowS

show :: Binary -> String

showList :: [Binary] -> ShowS

NFData Binary

Defined in OryHydra.Core

Methods

rnf :: Binary -> ()

Eq Binary

Defined in OryHydra.Core

Methods

(==) :: Binary -> Binary -> Bool

(/=) :: Binary -> Binary -> Bool

Ord Binary

Defined in OryHydra.Core

Methods

compare :: Binary -> Binary -> Ordering

(<) :: Binary -> Binary -> Bool

(<=) :: Binary -> Binary -> Bool

(>) :: Binary -> Binary -> Bool

(>=) :: Binary -> Binary -> Bool

max :: Binary -> Binary -> Binary

min :: Binary -> Binary -> Binary

FromHttpApiData Binary

Defined in OryHydra.Core

Methods

parseUrlPiece :: Text -> Either Text Binary

parseHeader :: ByteString -> Either Text Binary

parseQueryParam :: Text -> Either Text Binary

ToHttpApiData Binary

Defined in OryHydra.Core

Methods

toUrlPiece :: Binary -> Text

toEncodedUrlPiece :: Binary -> Builder

toHeader :: Binary -> ByteString

toQueryParam :: Binary -> Text

MimeRender MimeMultipartFormData Binary

Defined in OryHydra.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> Binary -> ByteString

mimeRender' :: MimeMultipartFormData -> Binary -> ByteString

_readBinaryBase64 :: MonadFail m => Text -> m Binary

_showBinaryBase64 :: Binary -> Text

Lens Type Aliases

type Lens_' s a = Lens_ s s a a

type Lens_ s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t