| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cachix.Api
Synopsis
- servantApi :: Proxy CachixServantAPI
- swaggerDoc :: Swagger
- data CachixAPI route = CachixAPI {
- 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" :> (ReqBody '[JSON] CreateToken :> Post '[JSON] Text)))
- caches :: route :- (CachixAuth :> ("cache" :> Get '[JSON] [BinaryCacheAuthenticated]))
- cache :: route :- ("cache" :> (Capture "name" Text :> ToServantApi BinaryCacheAPI))
- install :: route :- ("install" :> ToServantApi InstallAPI)
- github :: route :- ("github" :> ToServantApi GitHubAPI)
- type CachixServantAPI = "api" :> ("v1" :> ToServantApi CachixAPI)
- type CachixAuth = Auth '[Cookie, JWT, BasicAuth] Session
- data InstallAPI route = InstallAPI {
- installGetLatest :: route :- (Summary "Redirects to a tarball containing nix expression to build the latest version of cachix cli" :> Get302 '[JSON] '[])
- installGetVersion :: route :- (Summary "Redirects to a tarball containing nix expression to build given version of cachix cli" :> (Capture "version" Text :> Get302 '[JSON] '[]))
- data GitHubAPI route = GitHubAPI {
- githubOrganizations :: route :- (CachixAuth :> ("orgs" :> Get '[JSON] [Text]))
- githubTeams :: route :- (CachixAuth :> ("orgs" :> (Capture "org" Text :> ("teams" :> Get '[JSON] [GitHubTeam]))))
- data BinaryCacheAPI route = BinaryCacheAPI {
- get :: route :- (CachixAuth :> Get '[JSON] BinaryCache)
- create :: route :- (CachixAuth :> (ReqBody '[JSON] BinaryCacheCreate :> Post '[JSON] NoContent))
- delete :: route :- (CachixAuth :> Delete '[JSON] NoContent)
- nixCacheInfo :: route :- (CachixAuth :> ("nix-cache-info" :> Get '[XNixCacheInfo, JSON] NixCacheInfo))
- narinfo :: route :- (CachixAuth :> (Capture "narinfo" NarInfoC :> Get '[XNixNarInfo, JSON] NarInfo))
- narinfoHead :: route :- (CachixAuth :> (Capture "narinfo" NarInfoC :> Head))
- narinfoBulk :: route :- (CachixAuth :> ("narinfo" :> (Summary "Given a list of store hashes, return a list of those that are missing" :> (ReqBody '[JSON] [Text] :> Post '[JSON] [Text]))))
- createNarinfo :: route :- (Capture "narinfo" NarInfoC :> (ReqBody '[JSON] NarInfoCreate :> Post '[JSON] NoContent))
- createKey :: route :- (CachixAuth :> ("key" :> (ReqBody '[JSON] SigningKeyCreate :> Post '[JSON] NoContent)))
- data BinaryCacheStreamingAPI route = BinaryCacheStreamingAPI {
- nar :: route :- (CachixAuth :> ("nar" :> (Capture "nar" NarFileName :> StreamGet NoFraming OctetStream (ConduitT () ByteString (ResourceT IO) ()))))
- createNar :: route :- ("nar" :> (StreamBody NoFraming XNixNar (ConduitT () ByteString (ResourceT IO) ()) :> Post '[JSON] NoContent))
- serveNarContent :: route :- (CachixAuth :> ("serve" :> (Capture "storehash" Text :> (CaptureAll "filepath" Text :> (Summary "Serve a file from a given store path" :> Get '[OctetStream] (Headers '[Header "X-Content-Type-Options" Text] ByteString))))))
- type BinaryCachStreamingServantAPI = "api" :> ("v1" :> ("cache" :> (Capture "name" Text :> ToServantApi BinaryCacheStreamingAPI)))
- module Cachix.Api.Types
- module Cachix.Types.ContentTypes
- data NarFileName = NarFileName {
- contentHash :: Text
- extension :: Text
Documentation
swaggerDoc :: Swagger Source #
Constructors
| CachixAPI | |
Fields
| |
Instances
type CachixServantAPI = "api" :> ("v1" :> ToServantApi CachixAPI) Source #
data InstallAPI route Source #
Constructors
| InstallAPI | |
Fields
| |
Instances
| Generic (InstallAPI route) Source # | |
Defined in Cachix.Api Associated Types type Rep (InstallAPI route) :: Type -> Type # Methods from :: InstallAPI route -> Rep (InstallAPI route) x # to :: Rep (InstallAPI route) x -> InstallAPI route # | |
| type Rep (InstallAPI route) Source # | |
Defined in Cachix.Api type Rep (InstallAPI route) = D1 (MetaData "InstallAPI" "Cachix.Api" "cachix-api-0.4.0-Gej4ySw6FTjlxKKMYcegu" False) (C1 (MetaCons "InstallAPI" PrefixI True) (S1 (MetaSel (Just "installGetLatest") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- (Summary "Redirects to a tarball containing nix expression to build the latest version of cachix cli" :> Get302 (JSON ': ([] :: [Type])) ([] :: [Type])))) :*: S1 (MetaSel (Just "installGetVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- (Summary "Redirects to a tarball containing nix expression to build given version of cachix cli" :> (Capture "version" Text :> Get302 (JSON ': ([] :: [Type])) ([] :: [Type]))))))) | |
Constructors
| GitHubAPI | |
Fields
| |
Instances
| Generic (GitHubAPI route) Source # | |
| type Rep (GitHubAPI route) Source # | |
Defined in Cachix.Api type Rep (GitHubAPI route) = D1 (MetaData "GitHubAPI" "Cachix.Api" "cachix-api-0.4.0-Gej4ySw6FTjlxKKMYcegu" False) (C1 (MetaCons "GitHubAPI" PrefixI True) (S1 (MetaSel (Just "githubOrganizations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- (CachixAuth :> ("orgs" :> Get (JSON ': ([] :: [Type])) [Text])))) :*: S1 (MetaSel (Just "githubTeams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (route :- (CachixAuth :> ("orgs" :> (Capture "org" Text :> ("teams" :> Get (JSON ': ([] :: [Type])) [GitHubTeam])))))))) | |
data BinaryCacheAPI route Source #
Constructors
| BinaryCacheAPI | |
Fields
| |
Instances
data BinaryCacheStreamingAPI route Source #
Streaming endpoints
Constructors
| BinaryCacheStreamingAPI | |
Fields
| |
Instances
type BinaryCachStreamingServantAPI = "api" :> ("v1" :> ("cache" :> (Capture "name" Text :> ToServantApi BinaryCacheStreamingAPI))) Source #
module Cachix.Api.Types
module Cachix.Types.ContentTypes
data NarFileName Source #
hash.nar.xz file
Constructors
| NarFileName | |
Fields
| |