| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Swagger.Build.Authorisation
- basic :: Authorisation
- apiKey :: PassMethod -> Text -> Authorisation
- data PassMethod
- oauth2 :: GrantTypes -> OAuth2Builder -> Authorisation
- scope :: Text -> ScopeBuilder -> OAuth2Builder
- implicit :: Text -> ImplicitBuilder -> GrantTypes
- authCode :: TokenRequestEndpoint -> TokenEndpoint -> GrantTypes
- tokenEndpoint :: Text -> TokenEndpointBuilder -> TokenEndpoint
- tokenRequestEndpoint :: Text -> TokenReqEndpointBuilder -> TokenRequestEndpoint
- clientIdName :: Text -> TokenReqEndpointBuilder
- clientSecretName :: Text -> TokenReqEndpointBuilder
- token :: Text -> State (TokenName a) ()
- end :: Monad m => m ()
- type OAuth2Builder = State [Scope] ()
- type ScopeSt = Common `["description"]` Scope
- type ScopeBuilder = State ScopeSt ()
- type ImplicitBuilder = State (TokenName ImplicitGrant) ()
- type TokenEndpointBuilder = State (TokenName TokenEndpoint) ()
- type TokenReqEndpointBuilder = State TokenRequestEndpoint ()
basic auth
api key
apiKey :: PassMethod -> Text -> Authorisation Source
oauth2
oauth2 :: GrantTypes -> OAuth2Builder -> Authorisation Source
scope :: Text -> ScopeBuilder -> OAuth2Builder Source
Add one scope with the given name to an OAuth2 object.
implicit :: Text -> ImplicitBuilder -> GrantTypes Source
Construct an implicit grant type with the given login endpoint and some optional token name.
authCode :: TokenRequestEndpoint -> TokenEndpoint -> GrantTypes Source
Construct an authentorisation code based grant type object.
If cases where no build steps are provided but a builder is required
end can be used, e.g. defineModel "Foo" end
builder types
type OAuth2Builder = State [Scope] () Source
type ScopeBuilder = State ScopeSt () Source
type ImplicitBuilder = State (TokenName ImplicitGrant) () Source
type TokenEndpointBuilder = State (TokenName TokenEndpoint) () Source