Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Minion.OpenApi3

Synopsis

data OpenApi3Config = OpenApi3Config {
- openapi3File :: !FilePath
- staticDir :: !FilePath
}
data OpenApi3
class AttachRequestSchema a where
- attachRequestSchema :: OpenApi -> OpenApi
class IsOpenApi3Description a where
- toOpenApi3Description :: a -> OpenApi3Description
data OpenApi3Description
- = DescriptionText Text
- | SummaryText Text
class ToResponses a where
- toResponses :: (Responses, Definitions Schema)
openapi3 :: forall m ts st. (HandleArgs ts st m, MonadIO m) => OpenApi3Config -> Router' OpenApi3 ts m -> Router' Void Void m
newtype AsCookieJwt a = AsCookieJwt a
newtype AsJwt a = AsJwt a
newtype AsHtml a = AsHtml a
newtype AsSSE a = AsSSE a
newtype AsBinary a = AsBinary a
newtype AsMultipart a = AsMultipart a
class AttachSecuritySchema a where
- attachSecuritySchema :: OpenApi -> OpenApi
class AttachSecuritySchemas as where
- attachSecuritySchemas :: OpenApi -> OpenApi

Documentation

data OpenApi3Config Source #

Constructors

OpenApi3Config
Fields openapi3File :: !FilePath staticDir :: !FilePath

data OpenApi3 Source #

Instances

Instances details

type Introspection OpenApi3 'Capture Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Capture = ToParamSchema
type Introspection OpenApi3 'Captures Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Captures = ToParamSchema
type Introspection OpenApi3 'Description Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Description = IsOpenApi3Description
type Introspection OpenApi3 'Header Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Header = ToParamSchema
type Introspection OpenApi3 'QueryParam Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'QueryParam = ToParamSchema
type Introspection OpenApi3 'Request Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Request = AttachRequestSchema :: Type -> Constraint
type Introspection OpenApi3 'Response Source #
Instance details Defined in Web.Minion.OpenApi3 type Introspection OpenApi3 'Response = ToResponses :: Type -> Constraint

class AttachRequestSchema a where Source #

Methods

attachRequestSchema :: OpenApi -> OpenApi Source #

Instances

Instances details

AttachRequestSchema (AsMultipart a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachRequestSchema :: OpenApi -> OpenApi Source #
AttachSecuritySchemas as => AttachRequestSchema (Auth as a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachRequestSchema :: OpenApi -> OpenApi Source #
(ToSchema a, AllContentTypes cts) => AttachRequestSchema (ReqBody cts a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachRequestSchema :: OpenApi -> OpenApi Source #

class IsOpenApi3Description a where Source #

Methods

toOpenApi3Description :: a -> OpenApi3Description Source #

Instances

Instances details

IsOpenApi3Description OpenApi3Description Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toOpenApi3Description :: OpenApi3Description -> OpenApi3Description Source #

data OpenApi3Description Source #

Constructors

DescriptionText Text
SummaryText Text

Instances

Instances details

IsOpenApi3Description OpenApi3Description Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toOpenApi3Description :: OpenApi3Description -> OpenApi3Description Source #

class ToResponses a where Source #

Methods

toResponses :: (Responses, Definitions Schema) Source #

Instances

Instances details

ToResponses Chunks Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
ToResponses LazyBytes Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
ToResponses NoBody Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
(ToResponses a, ToResponses (Union as)) => ToResponses (Union (a ': as) :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
ToResponses (AsBinary a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
ToResponses (AsHtml a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
ToResponses (AsSSE a :: Type) Source #	It's just a stub for now
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
(ToSchema a, AllContentTypes cts) => ToResponses (RespBody cts a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #
(ToResponses a, IsStatus status) => ToResponses (WithStatus status a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #

openapi3 :: forall m ts st. (HandleArgs ts st m, MonadIO m) => OpenApi3Config -> Router' OpenApi3 ts m -> Router' Void Void m Source #

Use these newtypes to implement instances for according authsresponse bodiesrequest bodies We do not implement it for concrete types to avoid extra dependencies

newtype AsCookieJwt a Source #

Constructors

AsCookieJwt a

Instances

Instances details

AttachSecuritySchema (AsCookieJwt a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchema :: OpenApi -> OpenApi Source #

newtype AsJwt a Source #

Constructors

AsJwt a

Instances

Instances details

AttachSecuritySchema (AsJwt a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchema :: OpenApi -> OpenApi Source #

newtype AsHtml a Source #

Constructors

AsHtml a

Instances

Instances details

ToResponses (AsHtml a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #

newtype AsSSE a Source #

Constructors

AsSSE a

Instances

Instances details

ToResponses (AsSSE a :: Type) Source #	It's just a stub for now
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #

newtype AsBinary a Source #

Constructors

AsBinary a

Instances

Instances details

ToResponses (AsBinary a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods toResponses :: (Responses, Definitions Schema) Source #

newtype AsMultipart a Source #

Constructors

AsMultipart a

Instances

Instances details

AttachRequestSchema (AsMultipart a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachRequestSchema :: OpenApi -> OpenApi Source #

class AttachSecuritySchema a where Source #

Methods

attachSecuritySchema :: OpenApi -> OpenApi Source #

Instances

Instances details

AttachSecuritySchema Basic Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchema :: OpenApi -> OpenApi Source #
AttachSecuritySchema (AsCookieJwt a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchema :: OpenApi -> OpenApi Source #
AttachSecuritySchema (AsJwt a :: Type) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchema :: OpenApi -> OpenApi Source #

class AttachSecuritySchemas as where Source #

Methods

attachSecuritySchemas :: OpenApi -> OpenApi Source #

Instances

Instances details

AttachSecuritySchemas ('[] :: [k]) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchemas :: OpenApi -> OpenApi Source #
(AttachSecuritySchema a2, AttachSecuritySchemas as) => AttachSecuritySchemas (a2 ': as :: [a1]) Source #
Instance details Defined in Web.Minion.OpenApi3 Methods attachSecuritySchemas :: OpenApi -> OpenApi Source #