cachix-api-0.2.0: Servant HTTP API specification for https://cachix.org

Safe HaskellNone
LanguageHaskell2010

Cachix.Api.Types

Synopsis

Documentation

data NixCacheInfo #

Instances
Show NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

Generic NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep NixCacheInfo :: Type -> Type #

ToJSON NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

FromJSON NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

ToSchema NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

MimeUnrender XNixCacheInfo NixCacheInfo # 
Instance details

Defined in Cachix.Types.ContentTypes

type Rep NixCacheInfo # 
Instance details

Defined in Cachix.Api.Types

type Rep NixCacheInfo = D1 (MetaData "NixCacheInfo" "Cachix.Api.Types" "cachix-api-0.2.0-KOCKGJr3VId9y5geMiqWHG" False) (C1 (MetaCons "NixCacheInfo" PrefixI True) (S1 (MetaSel (Just "storeDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "wantMassQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer) :*: S1 (MetaSel (Just "priority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))))

data NarInfo #

Constructors

NarInfo 

Fields

  • storePath :: Text

    absolute path of the derivation in nix store

  • url :: Text

    relative url (to current domain) to download nar file

  • compression :: Text

    name of the compression algorithm, eg. xz

  • fileHash :: Text

    sha256 hash of the compressed nar file NOTE: to compute use "nix-hash --type sha256 --flat"

  • fileSize :: Integer

    file size of compressed nar file NOTE: du -b

  • narHash :: Text

    sha256 hash of the decompressed nar file NOTE: to compute use "nix-hash --type sha256 --flat --base32"

  • narSize :: Integer

    file size of decompressed nar file NOTE: du -b

  • references :: [Text]

    immediate dependencies of the storePath NOTE: nix-store -q --references

  • deriver :: Text

    relative store path (to nix store root) of the deriver NOTE: nix-store -q --deriver

  • sig :: Text

    signature of fields: storePath, narHash, narSize, refs

Instances
Show NarInfo # 
Instance details

Defined in Cachix.Api.Types

Generic NarInfo # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep NarInfo :: Type -> Type #

Methods

from :: NarInfo -> Rep NarInfo x #

to :: Rep NarInfo x -> NarInfo #

ToJSON NarInfo # 
Instance details

Defined in Cachix.Api.Types

FromJSON NarInfo # 
Instance details

Defined in Cachix.Api.Types

ToSchema NarInfo # 
Instance details

Defined in Cachix.Api.Types

MimeUnrender XNixNarInfo NarInfo # 
Instance details

Defined in Cachix.Types.ContentTypes

type Rep NarInfo # 
Instance details

Defined in Cachix.Api.Types

data BinaryCache #

Constructors

BinaryCache 
Instances
Show BinaryCache # 
Instance details

Defined in Cachix.Api.Types

Generic BinaryCache # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep BinaryCache :: Type -> Type #

ToJSON BinaryCache # 
Instance details

Defined in Cachix.Api.Types

FromJSON BinaryCache # 
Instance details

Defined in Cachix.Api.Types

NFData BinaryCache # 
Instance details

Defined in Cachix.Api.Types

Methods

rnf :: BinaryCache -> () #

ToSchema BinaryCache # 
Instance details

Defined in Cachix.Api.Types

type Rep BinaryCache # 
Instance details

Defined in Cachix.Api.Types

newtype BinaryCacheError #

Constructors

BinaryCacheError 

Fields

Instances
Generic BinaryCacheError # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep BinaryCacheError :: Type -> Type #

ToJSON BinaryCacheError # 
Instance details

Defined in Cachix.Api.Types

FromJSON BinaryCacheError # 
Instance details

Defined in Cachix.Api.Types

type Rep BinaryCacheError # 
Instance details

Defined in Cachix.Api.Types

type Rep BinaryCacheError = D1 (MetaData "BinaryCacheError" "Cachix.Api.Types" "cachix-api-0.2.0-KOCKGJr3VId9y5geMiqWHG" True) (C1 (MetaCons "BinaryCacheError" PrefixI True) (S1 (MetaSel (Just "error") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype NarC #

Hash of nar.xz file

Constructors

NarC Text 
Instances
Generic NarC # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep NarC :: Type -> Type #

Methods

from :: NarC -> Rep NarC x #

to :: Rep NarC x -> NarC #

ToHttpApiData NarC # 
Instance details

Defined in Cachix.Api.Types

FromHttpApiData NarC # 
Instance details

Defined in Cachix.Api.Types

ToSchema NarC # 
Instance details

Defined in Cachix.Api.Types

ToParamSchema NarC # 
Instance details

Defined in Cachix.Api.Types

Methods

toParamSchema :: proxy NarC -> ParamSchema t #

type Rep NarC # 
Instance details

Defined in Cachix.Api.Types

type Rep NarC = D1 (MetaData "NarC" "Cachix.Api.Types" "cachix-api-0.2.0-KOCKGJr3VId9y5geMiqWHG" True) (C1 (MetaCons "NarC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype NarInfoC #

Store path hash

Constructors

NarInfoC Text 
Instances
Generic NarInfoC # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep NarInfoC :: Type -> Type #

Methods

from :: NarInfoC -> Rep NarInfoC x #

to :: Rep NarInfoC x -> NarInfoC #

ToHttpApiData NarInfoC # 
Instance details

Defined in Cachix.Api.Types

FromHttpApiData NarInfoC # 
Instance details

Defined in Cachix.Api.Types

ToSchema NarInfoC # 
Instance details

Defined in Cachix.Api.Types

ToParamSchema NarInfoC # 
Instance details

Defined in Cachix.Api.Types

Methods

toParamSchema :: proxy NarInfoC -> ParamSchema t #

type Rep NarInfoC # 
Instance details

Defined in Cachix.Api.Types

type Rep NarInfoC = D1 (MetaData "NarInfoC" "Cachix.Api.Types" "cachix-api-0.2.0-KOCKGJr3VId9y5geMiqWHG" True) (C1 (MetaCons "NarInfoC" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data User #

Instances
Generic User # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep User :: Type -> Type #

Methods

from :: User -> Rep User x #

to :: Rep User x -> User #

ToJSON User # 
Instance details

Defined in Cachix.Api.Types

FromJSON User # 
Instance details

Defined in Cachix.Api.Types

ToSchema User # 
Instance details

Defined in Cachix.Api.Types

type Rep User # 
Instance details

Defined in Cachix.Api.Types

data SubscriptionType #

Constructors

Community 
Starter 
Basic 
Pro 
Instances
Read SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

Show SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

Generic SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

Associated Types

type Rep SubscriptionType :: Type -> Type #

ToJSON SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

FromJSON SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

ToSchema SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

type Rep SubscriptionType # 
Instance details

Defined in Cachix.Api.Types

type Rep SubscriptionType = D1 (MetaData "SubscriptionType" "Cachix.Api.Types" "cachix-api-0.2.0-KOCKGJr3VId9y5geMiqWHG" False) ((C1 (MetaCons "Community" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Starter" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Basic" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Pro" PrefixI False) (U1 :: Type -> Type)))