Safe Haskell	None
Language	Haskell2010

OpenAPI.Common

Description

This module serves the purpose of defining common functionality which remains the same across all OpenAPI specifications.

Synopsis

data Configuration s = Configuration {
- configBaseURL :: Text
- configSecurityScheme :: s
}
doCallWithConfiguration :: (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Text -> [(Text, Maybe String)] -> m (Either HttpException (Response ByteString))
doCallWithConfigurationM :: (MonadHTTP m, SecurityScheme s) => Text -> Text -> [(Text, Maybe String)] -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
doBodyCallWithConfiguration :: (MonadHTTP m, SecurityScheme s, ToJSON body) => Configuration s -> Text -> Text -> [(Text, Maybe String)] -> Maybe body -> RequestBodyEncoding -> m (Either HttpException (Response ByteString))
doBodyCallWithConfigurationM :: (MonadHTTP m, SecurityScheme s, ToJSON body) => Text -> Text -> [(Text, Maybe String)] -> Maybe body -> RequestBodyEncoding -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
runWithConfiguration :: SecurityScheme s => Configuration s -> ReaderT (Configuration s) m a -> m a
class Monad m => MonadHTTP m where
- httpBS :: Request -> m (Either HttpException (Response ByteString))
stringifyModel :: StringifyModel a => a -> String
class Show a => StringifyModel a
class SecurityScheme s where
- authenticateRequest :: s -> Request -> Request
data AnonymousSecurityScheme = AnonymousSecurityScheme
textToByte :: Text -> ByteString
newtype JsonByteString = JsonByteString ByteString
newtype JsonDateTime = JsonDateTime ZonedTime
data RequestBodyEncoding
- = RequestBodyEncodingJSON
- | RequestBodyEncodingFormData

Documentation

data Configuration s Source #

An operation can and must be configured with data, which may be common for many operations.

This configuration consists of information about the server URL and the used security scheme.

In OpenAPI these information can be defined

Root level
Path level
Operation level

To get started, the defaultConfiguration can be used and changed accordingly.

Note that it is possible that BearerAuthenticationSecurityScheme is not available because it is not a security scheme in the OpenAPI specification.

defaultConfiguration
  { configSecurityScheme = BearerAuthenticationSecurityScheme "token" }

Constructors

Configuration
Fields configBaseURL :: Text configSecurityScheme :: s

Instances

Eq s => Eq (Configuration s) Source #
Instance details Defined in OpenAPI.Common Methods (==) :: Configuration s -> Configuration s -> Bool # (/=) :: Configuration s -> Configuration s -> Bool #
Ord s => Ord (Configuration s) Source #
Instance details Defined in OpenAPI.Common Methods compare :: Configuration s -> Configuration s -> Ordering # (<) :: Configuration s -> Configuration s -> Bool # (<=) :: Configuration s -> Configuration s -> Bool # (>) :: Configuration s -> Configuration s -> Bool # (>=) :: Configuration s -> Configuration s -> Bool # max :: Configuration s -> Configuration s -> Configuration s # min :: Configuration s -> Configuration s -> Configuration s #
Show s => Show (Configuration s) Source #
Instance details Defined in OpenAPI.Common Methods showsPrec :: Int -> Configuration s -> ShowS # show :: Configuration s -> String # showList :: [Configuration s] -> ShowS #
Generic (Configuration s) Source #
Instance details Defined in OpenAPI.Common Associated Types type Rep (Configuration s) :: Type -> Type # Methods from :: Configuration s -> Rep (Configuration s) x # to :: Rep (Configuration s) x -> Configuration s #
type Rep (Configuration s) Source #
Instance details Defined in OpenAPI.Common type Rep (Configuration s) = D1 (MetaData "Configuration" "OpenAPI.Common" "openapi3-code-generator-0.1.0.6-6iC1yCYlehZL3mtXad2QKS" False) (C1 (MetaCons "Configuration" PrefixI True) (S1 (MetaSel (Just "configBaseURL") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "configSecurityScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 s)))

doCallWithConfiguration Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	Configuration options like base URL and security scheme
-> Text	HTTP method (GET, POST, etc.)
-> Text	Path to append to the base URL (path parameters should already be replaced)
-> [(Text, Maybe String)]	Query parameters
-> m (Either HttpException (Response ByteString))	The raw response from the server

This is the main functionality of this module

It makes a concrete Call to a Server without a body

doCallWithConfigurationM :: (MonadHTTP m, SecurityScheme s) => Text -> Text -> [(Text, Maybe String)] -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

Same as doCallWithConfiguration but run in a ReaderT environment which contains the configuration. This is useful if multiple calls have to be executed with the same configuration.

doBodyCallWithConfiguration Source #

Arguments

:: (MonadHTTP m, SecurityScheme s, ToJSON body)
=> Configuration s	Configuration options like base URL and security scheme
-> Text	HTTP method (GET, POST, etc.)
-> Text	Path to append to the base URL (path parameters should already be replaced)
-> [(Text, Maybe String)]	Query parameters
-> Maybe body	Request body
-> RequestBodyEncoding	JSON or form data deepobjects
-> m (Either HttpException (Response ByteString))	The raw response from the server

This is the main functionality of this module

It makes a concrete Call to a Server with a body

doBodyCallWithConfigurationM :: (MonadHTTP m, SecurityScheme s, ToJSON body) => Text -> Text -> [(Text, Maybe String)] -> Maybe body -> RequestBodyEncoding -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

Same as doBodyCallWithConfiguration but run in a ReaderT environment which contains the configuration. This is useful if multiple calls have to be executed with the same configuration.

runWithConfiguration :: SecurityScheme s => Configuration s -> ReaderT (Configuration s) m a -> m a Source #

Run the ReaderT monad with a specified configuration

Note: This is just flip runReaderT.

class Monad m => MonadHTTP m where Source #

Abstracts the usage of httpBS away, so that it can be used for testing

Methods

httpBS :: Request -> m (Either HttpException (Response ByteString)) Source #

Instances

MonadHTTP IO Source #	This instance is the default instance used for production code
Instance details Defined in OpenAPI.Common Methods httpBS :: Request -> IO (Either HttpException (Response ByteString)) Source #
MonadHTTP m => MonadHTTP (ReaderT r m) Source #
Instance details Defined in OpenAPI.Common Methods httpBS :: Request -> ReaderT r m (Either HttpException (Response ByteString)) Source #

stringifyModel :: StringifyModel a => a -> String Source #

Stringifies a showable value

>>> stringifyModel "Test"
"Test"

>>> stringifyModel 123
"123"

class Show a => StringifyModel a Source #

This type class makes the code generation for URL parameters easier as it allows to stringify a value

The Show class is not sufficient as strings should not be stringified with quotes.

Minimal complete definition

stringifyModel

Instances

Show a => StringifyModel a Source #
Instance details Defined in OpenAPI.Common Methods stringifyModel :: a -> String Source #
StringifyModel Text Source #
Instance details Defined in OpenAPI.Common Methods stringifyModel :: Text -> String Source #
StringifyModel String Source #
Instance details Defined in OpenAPI.Common Methods stringifyModel :: String -> String Source #

class SecurityScheme s where Source #

Allows to specify an authentication scheme for requests done with doCallWithConfiguration

This can be used to define custom schemes as well

Methods

authenticateRequest :: s -> Request -> Request Source #

Instances

SecurityScheme AnonymousSecurityScheme Source #	Instance for the anonymous scheme which does not alter the request in any way
Instance details Defined in OpenAPI.Common Methods authenticateRequest :: AnonymousSecurityScheme -> Request -> Request Source #

data AnonymousSecurityScheme Source #

The default authentication scheme which does not add any authentication information

Constructors

AnonymousSecurityScheme

Instances

SecurityScheme AnonymousSecurityScheme Source #	Instance for the anonymous scheme which does not alter the request in any way
Instance details Defined in OpenAPI.Common Methods authenticateRequest :: AnonymousSecurityScheme -> Request -> Request Source #

textToByte :: Text -> ByteString Source #

Convert Text a to ByteString

newtype JsonByteString Source #

Wraps a ByteString to implement ToJSON and FromJSON

Constructors

JsonByteString ByteString

Instances

Eq JsonByteString Source #
Instance details Defined in OpenAPI.Common Methods (==) :: JsonByteString -> JsonByteString -> Bool # (/=) :: JsonByteString -> JsonByteString -> Bool #
Ord JsonByteString Source #
Instance details Defined in OpenAPI.Common Methods compare :: JsonByteString -> JsonByteString -> Ordering # (<) :: JsonByteString -> JsonByteString -> Bool # (<=) :: JsonByteString -> JsonByteString -> Bool # (>) :: JsonByteString -> JsonByteString -> Bool # (>=) :: JsonByteString -> JsonByteString -> Bool # max :: JsonByteString -> JsonByteString -> JsonByteString # min :: JsonByteString -> JsonByteString -> JsonByteString #
Show JsonByteString Source #
Instance details Defined in OpenAPI.Common Methods showsPrec :: Int -> JsonByteString -> ShowS # show :: JsonByteString -> String # showList :: [JsonByteString] -> ShowS #
ToJSON JsonByteString Source #
Instance details Defined in OpenAPI.Common Methods toJSON :: JsonByteString -> Value # toEncoding :: JsonByteString -> Encoding # toJSONList :: [JsonByteString] -> Value # toEncodingList :: [JsonByteString] -> Encoding #
FromJSON JsonByteString Source #
Instance details Defined in OpenAPI.Common Methods parseJSON :: Value -> Parser JsonByteString # parseJSONList :: Value -> Parser [JsonByteString] #

newtype JsonDateTime Source #

Wraps a ZonedTime to implement ToJSON and FromJSON

Constructors

JsonDateTime ZonedTime

Instances

Eq JsonDateTime Source #
Instance details Defined in OpenAPI.Common Methods (==) :: JsonDateTime -> JsonDateTime -> Bool # (/=) :: JsonDateTime -> JsonDateTime -> Bool #
Ord JsonDateTime Source #
Instance details Defined in OpenAPI.Common Methods compare :: JsonDateTime -> JsonDateTime -> Ordering # (<) :: JsonDateTime -> JsonDateTime -> Bool # (<=) :: JsonDateTime -> JsonDateTime -> Bool # (>) :: JsonDateTime -> JsonDateTime -> Bool # (>=) :: JsonDateTime -> JsonDateTime -> Bool # max :: JsonDateTime -> JsonDateTime -> JsonDateTime # min :: JsonDateTime -> JsonDateTime -> JsonDateTime #
Show JsonDateTime Source #
Instance details Defined in OpenAPI.Common Methods showsPrec :: Int -> JsonDateTime -> ShowS # show :: JsonDateTime -> String # showList :: [JsonDateTime] -> ShowS #
ToJSON JsonDateTime Source #
Instance details Defined in OpenAPI.Common Methods toJSON :: JsonDateTime -> Value # toEncoding :: JsonDateTime -> Encoding # toJSONList :: [JsonDateTime] -> Value # toEncodingList :: [JsonDateTime] -> Encoding #
FromJSON JsonDateTime Source #
Instance details Defined in OpenAPI.Common Methods parseJSON :: Value -> Parser JsonDateTime # parseJSONList :: Value -> Parser [JsonDateTime] #

data RequestBodyEncoding Source #

Defines how a request body is encoded

Constructors

RequestBodyEncodingJSON	Encode the body as JSON
RequestBodyEncodingFormData	Encode the body as form data