Cachix.Api

Documentation

api :: Proxy API

servantApi :: Proxy CachixServantAPI

swaggerDoc :: Swagger

data CachixAPI route

Constructors

CachixAPI

Fields

• logout :: route :- ("logout" :> (CachixAuth :> Post302 '[JSON] '[Header "Set-Cookie" SetCookie, Header "Set-Cookie" SetCookie]))
• login :: route :- ("login" :> Get302 '[JSON] '[])
• loginCallback :: route :- ("login" :> ("callback" :> (QueryParam "code" Text :> (QueryParam "state" Text :> Get302 '[JSON] '[Header "Set-Cookie" SetCookie, Header "Set-Cookie" SetCookie]))))
• user :: route :- (CachixAuth :> ("user" :> Get '[JSON] User))
• createToken :: route :- (CachixAuth :> ("token" :> Post '[JSON] Text))
• caches :: route :- (CachixAuth :> ("cache" :> Get '[JSON] [BinaryCache]))
• cache :: route :- ("cache" :> (Capture "name" Text :> ToServantApi BinaryCacheAPI))

Instances

Generic (CachixAPI route)

Defined in Cachix.Api

Associated Types

type Rep (CachixAPI route) :: * -> *

Methods

from :: CachixAPI route -> Rep (CachixAPI route) x

to :: Rep (CachixAPI route) x -> CachixAPI route

type Rep (CachixAPI route)

Defined in Cachix.Api

type Rep (CachixAPI route)

data BinaryCacheAPI route

Constructors

BinaryCacheAPI

Fields

• get :: route :- Get '[JSON] BinaryCache
• create :: route :- (CachixAuth :> (ReqBody '[JSON] BinaryCacheCreate :> Post '[JSON] NoContent))
• nixCacheInfo :: route :- ("nix-cache-info" :> Get '[XNixCacheInfo, JSON] NixCacheInfo)
• nar :: route :- ("nar" :> (Capture "nar" NarC :> StreamResponseGet '[XNixNar, JSON]))
• createNar :: route :- ("nar" :> (StreamBodyMonad '[XNixNar, JSON] AWS :> Post '[JSON] NoContent))
• narinfo :: route :- (Capture "narinfo" NarInfoC :> Get '[XNixNarInfo, JSON] NarInfo)
• narinfoHead :: route :- (Capture "narinfo" NarInfoC :> Head)
• createNarinfo :: route :- (Capture "narinfo" NarInfoC :> (ReqBody '[JSON] NarInfoCreate :> Post '[JSON] NoContent))

Instances

Generic (BinaryCacheAPI route)

Defined in Cachix.Api

Associated Types

type Rep (BinaryCacheAPI route) :: * -> *

Methods

from :: BinaryCacheAPI route -> Rep (BinaryCacheAPI route) x

to :: Rep (BinaryCacheAPI route) x -> BinaryCacheAPI route

type Rep (BinaryCacheAPI route)

Defined in Cachix.Api

type Rep (BinaryCacheAPI route)

type CachixServantAPI = "api" :> ("v1" :> ToServantApi CachixAPI)

module Cachix.Api.Types

module Cachix.Types.ContentTypes