Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Routes.API

Synopsis

class ServiceAPI service (v :: Version) where
- type ServiceAPIRoutes service
- type SpecialisedAPIRoutes v service :: Type
- serviceSwagger :: HasOpenApi (SpecialisedAPIRoutes v service) => OpenApi
data API api r
hoistAPIHandler :: forall api r n. HasServer api '[Domain] => (forall x. Sem r x -> n x) -> API api r -> ServerT api n
hoistAPI :: forall api1 api2 r1 r2. (ServerT api1 (Sem r1) -> ServerT api2 (Sem r2)) -> API api1 r1 -> API api2 r2
mkAPI :: forall r0 api. (HasServer api '[Domain], ServerEffects (DeclaredErrorEffects api) r0) => ServerT api (Sem (Append (DeclaredErrorEffects api) r0)) -> API api r0
mkNamedAPI :: forall name r0 api. (HasServer api '[Domain], ServerEffects (DeclaredErrorEffects api) r0) => ServerT api (Sem (Append (DeclaredErrorEffects api) r0)) -> API (Named name api) r0
(<@>) :: API api1 r -> API api2 r -> API (api1 :<|> api2) r
class ServerEffect eff r where
- interpretServerEffect :: Sem (eff ': r) a -> Sem r a
class ServerEffects r r1 where
- interpretServerEffects :: Sem (Append r r1) a -> Sem r1 a
hoistServerWithDomain :: forall api m n. HasServer api '[Domain] => (forall x. m x -> n x) -> ServerT api m -> ServerT api n

Documentation

class ServiceAPI service (v :: Version) where Source #

Minimal complete definition

Nothing

Associated Types

type ServiceAPIRoutes service Source #

type SpecialisedAPIRoutes v service :: Type Source #

type SpecialisedAPIRoutes v service = SpecialiseToVersion v (ServiceAPIRoutes service)

Methods

serviceSwagger :: HasOpenApi (SpecialisedAPIRoutes v service) => OpenApi Source #

Instances

Instances details

ServiceAPI BrigAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Brig Associated Types type ServiceAPIRoutes BrigAPITag Source # type SpecialisedAPIRoutes v BrigAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI OAuthAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Brig.OAuth Associated Types type ServiceAPIRoutes OAuthAPITag Source # type SpecialisedAPIRoutes v OAuthAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI CannonAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Cannon Associated Types type ServiceAPIRoutes CannonAPITag Source # type SpecialisedAPIRoutes v CannonAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI CargoholdAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Cargohold Associated Types type ServiceAPIRoutes CargoholdAPITag Source # type SpecialisedAPIRoutes v CargoholdAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI GalleyAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Galley Associated Types type ServiceAPIRoutes GalleyAPITag Source # type SpecialisedAPIRoutes v GalleyAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI GundeckAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Gundeck Associated Types type ServiceAPIRoutes GundeckAPITag Source # type SpecialisedAPIRoutes v GundeckAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI ProxyAPITag v Source #	FUTUREWORK(fisx): (1) the verb could be added to the swagger docs in the appropriate place here; it's always defined in the `Summary`, but the `RawM` doesn't allow to constrain it. (2) there should be a way to make this more type-safe: `assertMethod` in Proxy.API.Public could take a type-level string literal argument containing the method, and that argument could be funnelled there from the routing table somehow: `"spotify" :> "api" :> "token" :> OnlyMethod POST :> RawM`, and then the `ServerT` instance for `OnlyMethod` requires a proxy argument in the handler of the same type. Or something. (am i massifly over-engineering things here?)
Instance details Defined in Wire.API.Routes.Public.Proxy Associated Types type ServiceAPIRoutes ProxyAPITag Source # type SpecialisedAPIRoutes v ProxyAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI SparAPITag v Source #
Instance details Defined in Wire.API.Routes.Public.Spar Associated Types type ServiceAPIRoutes SparAPITag Source # type SpecialisedAPIRoutes v SparAPITag Source # Methods serviceSwagger :: OpenApi Source #
ServiceAPI VersionAPITag v Source #
Instance details Defined in Wire.API.Routes.API Associated Types type ServiceAPIRoutes VersionAPITag Source # type SpecialisedAPIRoutes v VersionAPITag Source # Methods serviceSwagger :: OpenApi Source #

data API api r Source #

A Servant handler on a polysemy stack. This is used to help with type inference.

hoistAPIHandler :: forall api r n. HasServer api '[Domain] => (forall x. Sem r x -> n x) -> API api r -> ServerT api n Source #

hoistAPI :: forall api1 api2 r1 r2. (ServerT api1 (Sem r1) -> ServerT api2 (Sem r2)) -> API api1 r1 -> API api2 r2 Source #

mkAPI :: forall r0 api. (HasServer api '[Domain], ServerEffects (DeclaredErrorEffects api) r0) => ServerT api (Sem (Append (DeclaredErrorEffects api) r0)) -> API api r0 Source #

Convert a polysemy handler to an API value.

mkNamedAPI :: forall name r0 api. (HasServer api '[Domain], ServerEffects (DeclaredErrorEffects api) r0) => ServerT api (Sem (Append (DeclaredErrorEffects api) r0)) -> API (Named name api) r0 Source #

Convert a polysemy handler to a named API value.

(<@>) :: API api1 r -> API api2 r -> API (api1 :<|> api2) r infixr 3 Source #

Combine APIs.

class ServerEffect eff r where Source #

Methods

interpretServerEffect :: Sem (eff ': r) a -> Sem r a Source #

Instances

Instances details

(KnownError (MapError e), Member (Error DynError :: (Type -> Type) -> Type -> Type) r) => ServerEffect (Error (Tagged e Text) :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Routes.API Methods interpretServerEffect :: Sem (Error (Tagged e Text) ': r) a -> Sem r a Source #
Member (Error DynError :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error AuthenticationError :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error AuthenticationError ': r) a -> Sem r a Source #
Member (Error JSONResponse :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error MLSProposalFailure :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error MLSProposalFailure ': r) a -> Sem r a Source #
Member (Error JSONResponse :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error NonFederatingBackends :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error NonFederatingBackends ': r) a -> Sem r a Source #
Member (Error DynError :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error TeamFeatureError :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error TeamFeatureError ': r) a -> Sem r a Source #
Member (Error JSONResponse :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error UnreachableBackends :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error UnreachableBackends ': r) a -> Sem r a Source #
Member (Error JSONResponse :: (Type -> Type) -> Type -> Type) r => ServerEffect (Error UnreachableBackendsLegacy :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Error.Galley Methods interpretServerEffect :: Sem (Error UnreachableBackendsLegacy ': r) a -> Sem r a Source #
(KnownError (MapError e), Member (Error DynError :: (Type -> Type) -> Type -> Type) r) => ServerEffect (ErrorS e :: (Type -> Type) -> Type -> Type) r Source #
Instance details Defined in Wire.API.Routes.API Methods interpretServerEffect :: Sem (ErrorS e ': r) a -> Sem r a Source #

class ServerEffects r r1 where Source #

Methods

interpretServerEffects :: Sem (Append r r1) a -> Sem r1 a Source #

Instances

Instances details

ServerEffects ('[] :: [Effect]) r Source #
Instance details Defined in Wire.API.Routes.API Methods interpretServerEffects :: Sem (Append '[] r) a -> Sem r a Source #
(ServerEffects r r1, ServerEffect eff (Append r r1)) => ServerEffects (eff ': r) r1 Source #
Instance details Defined in Wire.API.Routes.API Methods interpretServerEffects :: Sem (Append (eff ': r) r1) a -> Sem r1 a Source #

hoistServerWithDomain :: forall api m n. HasServer api '[Domain] => (forall x. m x -> n x) -> ServerT api m -> ServerT api n Source #